From e93ee17c20358223059de84a93471095124358f3 Mon Sep 17 00:00:00 2001 From: "sider[bot]" <41898208+sider[bot]@users.noreply.github.com> Date: Thu, 26 Aug 2021 11:22:39 +0000 Subject: [PATCH] Configure Sider MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Welcome to [Sider](https://sider.review/)! 🎉 This is an onboarding PR to help you understand and configure Sider. You can edit the `sider.yml` file in this PR to fix analysis failures. Of course, you can close this PR when Sider works well without this `sider.yml`. If you have any questions, our [documentation](https://help.sider.review/getting-started/custom-configuration) could help you. 📃 --- sider.yml | 139 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 sider.yml diff --git a/sider.yml b/sider.yml new file mode 100644 index 0000000..566c4a9 --- /dev/null +++ b/sider.yml @@ -0,0 +1,139 @@ +# 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: + +# # Checkstyle example. See https://help.sider.review/tools/java/checkstyle +# checkstyle: +# root_dir: project/ +# dependencies: +# - "my.company.com:checkstyle-rules:1.0.0" +# config: custom-checkstyle.xml +# target: src/ +# exclude: vendor/ +# ignore: [warning, info] +# properties: custom-checkstyle.properties + +# # PHP_CodeSniffer example. See https://help.sider.review/tools/php/code-sniffer +# code_sniffer: +# root_dir: project/ +# target: [app/, test/] +# standard: [CakePHP, custom-ruleset.xml] +# extensions: [php, inc] +# encoding: utf-8 +# ignore: +# - app/vendor/ +# parallel: true + +# # ESLint example. See https://help.sider.review/tools/javascript/eslint +# eslint: +# root_dir: project/ +# dependencies: +# - my-eslint-plugin@2 +# npm_install: false +# target: +# - src/ +# - lib/ +# ext: [.js, .jsx] +# config: config/.eslintrc.js +# ignore-path: config/.eslintignore +# ignore-pattern: "vendor/**" +# no-ignore: true +# global: ["require", "exports:true"] +# quiet: true + +# # 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 + +# # Misspell example. See https://help.sider.review/tools/others/misspell +# misspell: +# root_dir: project/ +# target: [src/, test/] +# exclude: ["**/*.min.*"] +# locale: UK +# ignore: [center, behavior] + +# # PHPMD example. See https://help.sider.review/tools/php/phpmd +# phpmd: +# root_dir: project/ +# target: [src/, test/] +# rule: [cleancode, codesize] +# minimumpriority: 3 +# suffixes: [php, phtml] +# exclude: [vendor/, "test/*.php"] +# strict: true +# custom_rule_path: +# - Custom_PHPMD_Rule.php +# - "custom/phpmd/rules/**/*.php" + +# # PMD Java example. See https://help.sider.review/tools/java/pmd +# pmd_java: +# root_dir: project/ +# dependencies: +# - "my.company.com:pmd-ruleset:1.2.3" +# target: src/ +# rulesets: +# - category/java/errorprone.xml +# - your_pmd_custom_rules.xml +# encoding: ISO-8859-1 +# min_priority: 3 + +# # Querly example. See https://help.sider.review/tools/ruby/querly +# querly: +# root_dir: project/ +# dependencies: +# - { name: "querly", version: "1.2.0" } +# config: config/querly.yml + +# # 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-.*$/