Skip to content

Commit

Permalink
Current documentation stage
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 28, 2024
0 parents commit 6bfb0e5
Show file tree
Hide file tree
Showing 2,044 changed files with 98,062 additions and 0 deletions.
94 changes: 94 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
{
"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": "gigalasr",
"name": "Lars",
"avatar_url": "https://avatars.githubusercontent.com/u/25102989?v=4",
"profile": "https://github.com/gigalasr",
"contributions": [
"code",
"test"
]
},
{
"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,
"commitType": "docs"
}
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions .githooks/check-package-update.sh
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .githooks/commit-msg
Original file line number Diff line number Diff line change
@@ -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)
41 changes: 41 additions & 0 deletions .githooks/load-npm.sh
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .githooks/post-checkout
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .githooks/post-commit
Original file line number Diff line number Diff line change
@@ -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 "$@"
6 changes: 6 additions & 0 deletions .githooks/post-merge
Original file line number Diff line number Diff line change
@@ -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
54 changes: 54 additions & 0 deletions .githooks/pre-push
Original file line number Diff line number Diff line change
@@ -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
36 changes: 36 additions & 0 deletions .github/.commitlintrc.json
Original file line number Diff line number Diff line change
@@ -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", "builds", "builds-fix",
"ci", "ci-fix",
"doc", "doc-fix", "docs", "docs-fix",
"feat", "feat-fix",
"perf", "perf-fix",
"refactor",
"test", "tests", "test-fix", "tests-fix",
"dep", "dep-fix", "deps", "deps-fix",
"lint", "lint-fix",
"wip",
"meta", "meta-fix"
]],
"type-empty": [2, "never"],
"signed-off-by": [2, "never", "Signed-off-by:"]
}
}
Loading

0 comments on commit 6bfb0e5

Please sign in to comment.