Everything for project infrastructure - scripts, configs, etc. for fast start.
- git syntax checks (branches, commits msgs, etc.)
- linting
- build
Script is in file GitSyntax/Commit.sh
Bash function checkCommitStyle
# Checks git commit naming style:
# `[Commmit msg starting from capital letter] (issue #[issue id]).`
# {String} $1 - commit message to check
# {String} --style - preset name for checking commit styleExample of usage:
. ./GitSyntax/Commits.sh
checkCommitStyle $COMMITMSGFor more examples see Examples/Commit-*.sh scripts.
Script is in file GitSyntax/Branch.sh
Bash function checkBranchStyle
# Checks current git branch naming style:
# `[developer's nickname].[2words-issue-description-with-dash-separator].[issue id]`
# {Boolean} $1 - loaded in CI or notExample of usage:
. ./GitSyntax/Branch.sh
checkBranchStyle $IS_IN_CIFor more examples see Examples/Branch-*.sh scripts.
Script is in file Linters/Linting.sh
Bash function linting
# Run linters with configs in folder where script locates
# Now available ESLint
# {String} $1 - file list to lintExample of usage:
. ./Linting/Linting.sh
linting $LIST_OF_CHANGED_FILESFor more examples see Examples/Linting-*.sh scripts.
Compiles incrementally every *.cpp file into *.o into Objects directory. After that builds binary file into Build folder. To build test project enter Build/Cpp and type make.