README.md

AlexJS pre-commit mirror

Mirror of AlexJS for pre-commit.

Using AlexJS with pre-commit

Example .pre-commit.config.yml:

repos:
  - repo: "https://github.com/mfisher87/alexjs-pre-commit-mirror"
    rev: "v11.0.1"  # Use the sha / tag you prefer
    hooks:
    - id: "alex"

Continuous Integration

Two example ways to run AlexJS inclusive language checks in CI for your repository using your existing pre-commit configuration from the previous step:

• The official pre-commit GitHub action: 🪨 Very stable
• pre-commit.ci: ⚡ Faster, but has more frequent outages.

Troubleshooting

I ignored a file in .alexignore but pre-commit is still failing

See this issue: get-alex/alex#348