Current documentation stage

.all-contributorsrc

@@ -0,0 +1,70 @@
+{
+  "projectName": "flowr",
+  "projectOwner": "flowr-analysis",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "EagleoutIce",
+      "name": "Florian Sihler",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9303573?v=4",
+      "profile": "https://github.com/EagleoutIce",
+      "contributions": [
+        "code", "ideas", "maintenance", "projectManagement", "research", "test", "talk"
+      ]
+    },
+    {
+      "login": "Ellpeck",
+      "name": "Ell",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5741138?v=4",
+      "profile": "https://ellpeck.de/",
+      "contributions": [
+        "code", "maintenance", "test", "plugin"
+      ]
+    },
+    {
+      "login": "LukasPietzschmann",
+      "name": "Lukas Pietzschmann",
+      "avatar_url": "https://avatars.githubusercontent.com/u/49213919?v=4",
+      "profile": "https://lukas.pietzschmann.org/",
+      "contributions": [
+        "code", "test"
+      ]
+    },
+    {
+      "login": "bjthehun",
+      "name": "Benedikt Jutz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/38729215?v=4",
+      "profile": "https://github.com/bjthehun",
+      "contributions": [
+        "code", "test"
+      ]
+    },
+    {
+      "login": "Core5563",
+      "name": "Core5563",
+      "avatar_url": "https://avatars.githubusercontent.com/u/140061253?v=4",
+      "profile": "https://github.com/Core5563",
+      "contributions": [
+        "code", "test"
+      ]
+    },
+    {
+      "login": "Ehcsan",
+      "name": "Ehcsan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/68707578?v=4",
+      "profile": "https://github.com/Ehcsan",
+      "contributions": [
+        "code", "test"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "linkToUsage": true
+}

.gitattributes

@@ -0,0 +1,5 @@
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text

.githooks/check-package-update.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# Let's check for updates to the package.json and if so suggest an update.
+# To my knowledge, there is no "post-pull" hook unifying the semantics.
+changedFiles="$(git diff-tree -r --name-only --no-commit-id HEAD@{1} HEAD)"
+
+changed() {
+  line="---------------------------------------------------------"
+  echo "$line"
+  echo "The package.json file has changed, it may be a good idea "
+  echo "to run 'npm ci'"
+  echo "$line"
+}
+
+
+echo "$changedFiles" | (grep --quiet "package.json" && changed)
+exit 0

.githooks/commit-msg

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+. .githooks/load-npm.sh
+
+message_file="${1}"
+$NPX_CMD commitlint --config '.github/.commitlintrc.json' --edit "${message_file}" ||
+  (printf "Run the following to fix the commit message:\n\ngit commit --edit --file=\"%s\"\n" "${message_file}" && exit 1)

.githooks/load-npm.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+find_npm_linux() {
+  export NPM_CMD="npm"
+  export NPX_CMD="npx"
+
+  if ! (type $NPM_CMD >> /dev/null); then
+    echo "npm not found, trying to make it available using nvm..."
+    if type nvm >> /dev/null; then
+      echo "nvm found, using it to install the latest lts node"
+      nvm use --lts
+    else
+      echo "nvm not found, trying to make it available using the nvm.sh"
+      # try to make it available based on https://github.com/typicode/husky/issues/912#issuecomment-817522060
+      export NVM_DIR="$HOME/.nvm/nvm.sh"
+      . "$(dirname $NVM_DIR)/nvm.sh"
+
+      export NVM_DIR="$HOME/.nvm"
+      a=$(nvm ls --no-colors | grep 'node')
+      v=$(echo "$a" | sed -E 's/.*\(-> ([^ ]+).*/\1/')
+
+      export PATH="$NVM_DIR/versions/node/$v/bin:$PATH"
+
+      if ! (type $NPM_CMD >> /dev/null); then
+        echo "no variant of npm or nvm found, trying to use the npm.cmd"
+        export NPM_CMD="npm.cmd"
+        export NPX_CMD="npx.cmd"
+      fi
+    fi
+  fi
+}
+
+if [ -z "${OSTYPE+x}" ]; then
+  find_npm_linux
+else
+  case "$OSTYPE" in
+    msys*) export NPM_CMD="npm.cmd" ;
+           export NPX_CMD="npx.cmd" ;;
+    *)     find_npm_linux ;;
+  esac
+fi

.githooks/post-checkout

@@ -0,0 +1,5 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting '.git/hooks/post-checkout'.\n"; exit 2; }
+git lfs post-checkout "$@"
+
+sh .githooks/check-package-update.sh

.githooks/post-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs post-commit "$@"

.githooks/post-merge

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting '.git/hooks/post-merge'.\n"; exit 2; }
+git lfs post-merge "$@"
+
+sh .githooks/check-package-update.sh

.githooks/pre-push

@@ -0,0 +1,54 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+git lfs pre-push "$@"
+
+set -eu
+
+. .githooks/load-npm.sh
+
+reset() {
+  echo "Cleaning up and return control"
+  rm -r "$flowrtmpdir"
+  cd "$curdir"
+}
+
+unclean=false
+if [ -n "$(git status --porcelain)" ]; then
+  # if we directly assign the test set -eu will not approve
+  unclean=true
+  trap reset EXIT
+  echo "Working tree is not clean, so we reset in temporary folder"
+  # backwards compatible platform independence
+  flowrtmpdir=$(mktemp -d 2>/dev/null || mktemp -d -t 'flowrtmpdir')
+  echo "Using temporary folder $flowrtmpdir"
+
+  curdir=$(pwd)
+
+  echo "Cloning copy..." # cloning obeys gitignore
+  git clone . "$flowrtmpdir"
+  echo "Keep installed packages..."
+  cp -r node_modules/ "$flowrtmpdir/node_modules"
+  cd "$flowrtmpdir"
+
+  git reset --hard
+  echo "Setup completed."
+fi
+
+echo "Linting project (local mode)..."
+$NPM_CMD run lint-local
+
+
+# shellcheck disable=SC2124 # we want the argument splitting
+args="$@"
+lfspre() {
+  if $unclean; then
+    reset
+  fi
+  command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting '.git/hooks/pre-push'.\n"; exit 2; }
+  # we want the argument splitting
+  git lfs pre-push $args
+}
+
+# we register it as a trap after lint so that it 1) triggers only if lint-local succeeded
+# but 2) only triggers *after* the directory recovery completed
+trap lfspre EXIT

.github/.commitlintrc.json

@@ -0,0 +1,36 @@
+{
+	"extends": [
+		"@commitlint/config-angular"
+	],
+	"defaultIgnores": true,
+	"helpUrl": "https://github.com/flowr-analysis/flowr/blob/main/.github/CONTRIBUTING.md",
+	"parserPreset": {
+		"parserOpts": {
+			"headerPattern": "^([^\\(\\):]*)(?:\\((.*)\\))?!?: (.*)$"
+		}
+	},
+	"rules": {
+		"subject-min-length": [1, "always", 6],
+		"subject-max-length": [1, "always", 42],
+		"subject-exclamation-mark": [2, "never", "!"],
+		"scope-case": [2, "always", "kebab-case"],
+		"scope-min-length": [1, "always", 3],
+		"scope-empty": [1, "never"],
+		"type-case": [2, "always", "kebab-case"],
+		"type-enum": [2, "always", [
+			"build", "build-fix",
+			"ci", "ci-fix",
+			"doc", "docs", "doc-fix", "docs-fix",
+			"feat", "feat-fix",
+			"perf",
+			"refactor",
+			"test", "tests", "test-fix", "tests-fix",
+			"dep",
+			"lint", "lint-fix",
+			"wip",
+			"meta"
+		]],
+		"type-empty": [2, "never"],
+		"signed-off-by": [2, "never", "Signed-off-by:"]
+	}
+}

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.