goodcheck.yml

rules:
  - id: sider.sider-docs.sideci_yml
    pattern: sideci.yml
    glob: "**/*.md"
    message: |
      Prefer `sider.yml` over `sideci.yml`

      `sideci.yml` is supported for the backward compatibility, but Sider recognizes `sider.yml` more preferentially.
      Please use `sider.yml` in the documentation.
    fail:
      - sideci.yml
    pass:
      - sider.yml

  - id: sider.sider-docs.master_branch
    pattern: master
    glob: "**/*.md"
    message: |
      Be careful when using the word `master` as a branch name.

      GitHub and some projects renamed their default branch from `master` to `main`.
      If `master` is included in a URL, the URL may return 404 in the future.
    fail:
      - https://github.com/rubocop-hq/rubocop/blob/master/CHANGELOG.md
    pass:
      - https://github.com/rubocop-hq/rubocop/blob/v0.83.0/CHANGELOG.md
    justification:
      - When the word `master` is not used as a branch name.
      - When there is no other suitable word.

  - id: sider.sider-docs.internal_link
    pattern: help.sider.review
    glob: "**/*.md"
    message: |
      Use a relative path for an internal link
    fail:
      - "[a link](https://help.sider.review/getting-started/setup)"
    pass:
      - "[a link](../getting-started/setup.md)"

  - id: sider.sider-docs.https_url
    pattern:
      regexp: "http://"
    glob: "**/*.md"
    message: |
      Use `https://` instead of `http://` if available
    justification:
      - When the URL does not support `https:`
      - When the URL is used only internally
    fail:
      - "http://foo/bar"
    pass:
      - "https://foo/bar"

  - id: sider.sider-docs.shell-code-block
    pattern:
      regexp: |
        ```(sh|shell)
    glob: "**/*.md"
    message: |
      Use `bash` for a shell-script code block. Both GitHub and Docusaurus supports it.
    fail:
      - |
        ```sh
      - |
        ```shell
    pass:
      - |
        ```bash

import:
  - https://github.com/sider/goodcheck-rules/archive/refs/tags/v0.0.4.tar.gz

exclude:
  - "**/node_modules/**"
  - "**/yarn.lock"
  - "**/*.{png,jpg,ico}"