@eagleoutice/flowr/documentation/wiki-onboarding.js

Static Dataflow Analyzer and Program Slicer for the R Programming Language

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.WikiOnboarding = void 0;
const doc_files_1 = require("./doc-util/doc-files");
const doc_code_1 = require("./doc-util/doc-code");
const doc_maker_1 = require("./wiki-mk/doc-maker");
/**
 * https://github.com/flowr-analysis/flowr/wiki/Onboarding
 */
class WikiOnboarding extends doc_maker_1.DocMaker {
    constructor() {
        super('wiki/Onboarding.md', module.filename, 'developer onboarding process');
    }
    text() {
        return `To get started developing on *flowR*, we recommend carefully reading the following pages:
- 💻 [Setting up the *flowR* development environment](${doc_files_1.FlowrWikiBaseRef}/Setup#%EF%B8%8F-building-from-scratch).\\
  This page explains how to install **R** and **Node.js**.  
- 💖 [Contributing guidelines](${doc_files_1.FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md).\\
  This page also includes information about how to set up **git-lfs** and several **git hooks**.

If you have any questions, please check out the [FAQ](${doc_files_1.FlowrWikiBaseRef}/FAQ) first, but if the question
is not answered there (or in the wiki in general), feel free to ask a question.
The [FAQ](${doc_files_1.FlowrWikiBaseRef}/FAQ) also includes information about how you can configure your editor.

## ⌛ TL;DR

The most important steps to get the *flowR* development environment set up (after installing **R** and **Node.js**) can be seen below. For convenience, they can be executed all at once using the following command:
${(0, doc_code_1.codeBlock)('shell', 'npm run setup:dev')}

If you want to execute the steps manually, please follow the instructions below:

${(0, doc_code_1.codeBlock)('shell', `
# Installing git-lfs for your current user (if you haven't already)
git lfs install
# Cloning the repository
git clone https://github.com/flowr-analysis/flowr.git
# Installing dependencies
npm ci
# Configuring git hooks
git config --local core.hooksPath .githooks/
# Test if the git hooks are working correctly
# Running this command should lint the code
git push --dry-run
`)}
    `.trim();
    }
}
exports.WikiOnboarding = WikiOnboarding;
//# sourceMappingURL=wiki-onboarding.js.map