sider.yml

# This is a configuration file to customize code analysis by Sider.
#
# For more information, see the documentation:
# https://help.sider.review/getting-started/custom-configuration

# Customize each tool. If analyses fail, try adjusting each option referencing the following example.
linter:

#   # Flake8 example. See https://help.sider.review/tools/python/flake8
#   flake8:
#     root_dir: project/
#     dependencies:
#       - flake8-bugbear
#       - flake8-builtins==1.4.1
#       - git+https://github.com/PyCQA/flake8-import-order.git@51e16f33065512afa1a85a20b2c2d3be768f78ea
#       - { name: "flake8-docstrings", version: "==1.6.0" }
#     target: src/
#     config: config/.flake8
#     parallel: false

#   # hadolint example. See https://help.sider.review/tools/dockerfile/hadolint
#   hadolint:
#     root_dir: project/
#     target:
#       - images/**/Dockerfile
#     ignore:
#       - DL3003
#       - SC1010
#     trusted-registry:
#       - docker.io
#       - my-company.com:5000
#     config: config/hadolint.yaml

#   # Misspell example. See https://help.sider.review/tools/others/misspell
#   misspell:
#     root_dir: project/
#     target: [src/, test/]
#     exclude: ["**/*.min.*"]
#     locale: UK
#     ignore: [center, behavior]

#   # remark-lint example. See https://help.sider.review/tools/markdown/remark-lint
#   remark_lint:
#     root_dir: project/
#     dependencies:
#       - my-remark-plugin@2
#     npm_install: false
#     target: [docs/]
#     ext: "md,markdown"
#     rc-path: config/.remarkrc
#     ignore-path: config/.remarkignore
#     use:
#       - remark-lint-file-extension
#       - remark-lint-no-heading-punctuation

#   # ShellCheck example. See https://help.sider.review/tools/shellscript/shellcheck
#   shellcheck:
#     root_dir: project/
#     target:
#       - "**/*.{sh,bash}"
#       - shebang: true
#     include: [SC2104, SC2105]
#     exclude: [SC1000, SC1118]
#     enable: all
#     shell: bash
#     severity: error
#     norc: true

#   # stylelint example. See https://help.sider.review/tools/css/stylelint
#   stylelint:
#     root_dir: project/
#     dependencies:
#       - my-stylelint-plugin@2
#     npm_install: false
#     config: config/.stylelintrc.yml
#     syntax: scss
#     ignore-path: config/.stylelintignore
#     ignore-disables: true
#     report-needless-disables: true
#     quiet: true
#     target: ["app/**/*.scss"]

# Ignore specific files. Example:
# ignore:
#   - "*.pdf"
#   - "*.mp4"
#   - "*.min.*"
#   - "images/**"

# Exclude specific branches. Example:
# branches:
#   exclude:
#     - master
#     - development
#     - /^release-.*$/