Add CI infrastructure for pre-commit checks

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+ # Maintain dependencies for GitHub Actions
+ - package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "daily"
+ groups:
+ actions:
+ patterns:
+ - "*"
+ commit-message:
+ # Prefix all commit messages with "COMP: "
+ prefix: "COMP"

.github/workflows/commit-message.yml

@@ -0,0 +1,39 @@
+name: "Commit Message Check"
+on:
+ pull_request:
+ types:
+ - opened
+ - edited
+ - reopened
+ - synchronize
+ push:
+ branches:
+ - main
+
+permissions:
+ contents: read
+
+jobs:
+ check-commit-message:
+ name: Check Commit Message
+ runs-on: ubuntu-latest
+ steps:
+ - name: Check Commit Prefix
+ uses: gsactions/commit-message-checker@16fa2d5de096ae0d35626443bcd24f1e756cafee # v2.0.0
+ with:
+ pattern: "^(ENH|PERF|BUG|STYLE|DOC|COMP): ([A-Z])+"
+ flags: "gm"
+ excludeDescription: "true" # optional: this excludes the description body of a pull request
+ excludeTitle: "true" # optional: this excludes the title of a pull request
+ error: 'The first line has to start with a commit prefix, followed by a colon and space, and then followed by a message with a capital letter (e.g "ENH: Add support for awesome feature"). For more details on other requirements, see https://slicer.readthedocs.io/en/latest/developer_guide/style_guide.html#commits'
+ checkAllCommitMessages: "true" # optional: this checks all commits associated with a pull request
+ accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages is true
+ - name: Check Line Length
+ uses: gsactions/commit-message-checker@16fa2d5de096ae0d35626443bcd24f1e756cafee # v2.0.0
+ with:
+ pattern: "^[^#].{1,78}$"
+ error: "The maximum line length of 78 characters is exceeded. For more details, see https://slicer.readthedocs.io/en/latest/developer_guide/style_guide.html#commits"
+ excludeDescription: "true" # optional: this excludes the description body of a pull request
+ excludeTitle: "true" # optional: this excludes the title of a pull request
+ checkAllCommitMessages: "true" # optional: this checks all commits associated with a pull request
+ accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages is true

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: CI (Lint)
+
+on:
+ workflow_dispatch:
+ pull_request:
+ push:
+ branches:
+ - main
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ pre-commit:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+ - uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
+
+ - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+
+ pre-commit-cookie:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+ - run: pipx run nox -s 'pre-commit-cookie'

.gitignore

@@ -0,0 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json

.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+exclude: "^{{cookiecutter\\.project_name}}/"
+
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: "v4.6.0"
+ hooks:
+ - id: check-added-large-files
+ - id: check-case-conflict
+ - id: check-merge-conflict
+ - id: check-symlinks
+ - id: check-toml
+ - id: check-yaml
+ - id: debug-statements
+ - id: end-of-file-fixer
+ - id: mixed-line-ending
+ - id: trailing-whitespace
+ - id: requirements-txt-fixer
+
+ - repo: https://github.com/adamchainz/blacken-docs
+ rev: "1.18.0"
+ hooks:
+ - id: blacken-docs
+ additional_dependencies: [black==24.*]
+
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: "v0.5.7"
+ hooks:
+ # Run the linter.
+ - id: ruff
+ args: ["--fix", "--show-fixes"]
+ # Run the formatter.
+ - id: ruff-format
+
+ - repo: https://github.com/rbubley/mirrors-prettier
+ rev: "v3.3.3"
+ hooks:
+ - id: prettier
+ types_or: [yaml, markdown, html, css, scss, javascript, json]
+
+ - repo: https://github.com/codespell-project/codespell
+ rev: "v2.3.0"
+ hooks:
+ - id: codespell
+ args: ["-Lnd", "-w"]
+
+ - repo: https://github.com/python-jsonschema/check-jsonschema
+ rev: "0.29.1"
+ hooks:
+ - id: check-dependabot
+ - id: check-github-workflows

.ruff.toml

@@ -0,0 +1,53 @@
+[lint]
+select = [
+ "ARG", # flake8-unused-arguments
+ "ANN", # flake8-annotations
+ "B", # flake8-bugbear
+ "C4", # flake8-comprehensions
+ "D", # pydocstyle
+ "E", "F", "W", # flake8
+ "EXE", # flake8-executable
+ "G", # flake8-logging-format
+ "I", # isort
+ "ICN", # flake8-import-conventions
+ "ISC", # flake8-implicit-str-concat
+ "NPY", # NumPy specific rules
+ "PGH", # pygrep-hooks
+ "PIE", # flake8-pie
+ "PL", # pylint
+ "PT", # flake8-pytest-style
+ "RET", # flake8-return
+ "RUF", # Ruff-specific
+ "S", # flake8-bandit
+ "SIM", # flake8-simplify
+ "UP", # pyupgrade
+ "YTT", # flake8-2020
+ "W", # Warning
+]
+extend-ignore = [
+ "ANN101", # missing-type-self
+ "G004", # logging-f-string
+ "PIE790", # unnecessary-pass
+
+ "D10", # undocumented-public-*
+ "D200", # One-line docstring should fit on one line
+
+ # Disable linting rules conflicting with "ruff formatter"
+ # See https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+ "COM812",
+ "COM819",
+ "D206",
+ "D300",
+ "E111",
+ "E114",
+ "E117",
+ "ISC001",
+ "ISC002",
+ "Q000",
+ "Q002",
+ "Q003",
+ "W191",
+]
+flake8-annotations.suppress-dummy-args = true
+flake8-annotations.suppress-none-returning = true
+pydocstyle.convention = "pep257"

LICENSE

@@ -200,4 +200,3 @@
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-

README.md

@@ -35,22 +35,19 @@ This will mark the version of the template file used and the Slicer version in t
 
 ### Which version of Slicer do the generated application build against ?
 
-Leveraging the ``jinja2-github`` plugin, the ``cookiecutter`` template generator will retrieve the latest commit associated with the Slicer repository default branch and it will set it as ``GIT_TAG`` value in the generated ``CMakeLists.txt``.
-
-
+Leveraging the `jinja2-github` plugin, the `cookiecutter` template generator will retrieve the latest commit associated with the Slicer repository default branch and it will set it as `GIT_TAG` value in the generated `CMakeLists.txt`.
 
 ## License
 
 This project template is distributed under the Apache 2.0 license. Please see
-the *LICENSE* file for details.
+the _LICENSE_ file for details.
 
 ## Authors
 
-* Julien Finet
-* Jean-Christophe Fillion-Robin
-* Dženan Zukić
-* Johan Andruejol
-* Alexis Girault
-* Cory Quammen
-* Jamie Snape
-
+- Julien Finet
+- Jean-Christophe Fillion-Robin
+- Dženan Zukić
+- Johan Andruejol
+- Alexis Girault
+- Cory Quammen
+- Jamie Snape