Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add end-to-end sample for dts-generator usage as CLI #456

Merged
merged 1 commit into from
May 7, 2024

docs: add end-to-end sample for dts-generator usage as CLI

7bbdbdb
Select commit
Loading
Failed to load commit list.
Merged

docs: add end-to-end sample for dts-generator usage as CLI #456

docs: add end-to-end sample for dts-generator usage as CLI
7bbdbdb
Select commit
Loading
Failed to load commit list.
In Solidarity / Inclusive Language completed May 7, 2024 in 1s

Check completed with warnings

Configuration

Below is the configuration used for this check run:

rules:
  master:
    regex:
      - /master/gi
    level: 'off'
    alternatives:
      - primary
      - main
      - leader
      - active
      - writer
  slave:
    regex:
      - /slave/gi
    level: warning
    alternatives:
      - secondary
      - node
      - worker
      - replica
      - passive
  whitelist:
    regex:
      - /white[_-]*list/gi
    level: warning
    alternatives:
      - include list
      - allow list
  blacklist:
    regex:
      - /black[_-]*list/gi
    level: warning
    alternatives:
      - exclude list
      - deny list
  grandfathered:
    regex:
      - /grandfathered/gi
    level: 'off'
    alternatives:
      - legacied
      - exempted
  sanity_check:
    regex:
      - /sanity[_-]*check/gi
    level: 'off'
    alternatives:
      - smoke test
      - confidence check
  man_hours:
    regex:
      - /man[_-]*hours/gi
    level: 'off'
    alternatives:
      - person-hours
      - human-hours
  masterdata:
    level: warning
    regex:
      - /\b(?!masterdata|masterdata\w+\b)master/gi
    alternatives:
      - primary
      - main
      - leader
      - active
      - writer
ignore:
  - .github/in-solidarity.yml
defaultMessage: >

  Please consider an alternative to `{{match}}`. 

  {{#if alternatives~}}


  Possibilities include: {{#each alternatives}}{{#if @index}},
  {{/if}}`{{this}}`{{/each}}

  {{~/if}}

For more information on configuration and rules, check the documentation.

App version

Annotations

Check warning on line 67 in packages/dts-generator/end-to-end-sample.md

See this annotation in the file changed.

@in-solidarity in-solidarity / Inclusive Language

Match Found

Please consider an alternative to `master`. 
Possibilities include: `primary`, `main`, `leader`, `active`, `writer`
Raw output
/\b(?!masterdata|masterdata\w+\b)master/gi