diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..72e8ffc --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +* diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml new file mode 100644 index 0000000..e80757e --- /dev/null +++ b/.pre-commit-hooks.yaml @@ -0,0 +1,11 @@ +- id: alex + name: alex + description: "Check files to 'find gender favoring, polarizing, race related, religion inconsiderate, or other unequal phrasing in text.'" + entry: alex + language: node + exclude: ".pre-commit-config.yaml" + 'types': [text] + args: [] + require_serial: false + additional_dependencies: ["alex@1.0.0"] + minimum_pre_commit_version: '0' diff --git a/.version b/.version new file mode 100644 index 0000000..3eefcb9 --- /dev/null +++ b/.version @@ -0,0 +1 @@ +1.0.0 diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd327b3 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# AlexJS pre-commit mirror + +Mirror of [AlexJS](https://alexjs.com) for [pre-commit](https://pre-commit.com). + +## Using AlexJS with `pre-commit` + +Example `.pre-commit.config.yml`: + +```yaml +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](https://github.com/pre-commit/action): :rock: + Very stable +* [pre-commit.ci](https://pre-commit.ci): :zap: Faster, but has more frequent outages. + + +## Troubleshooting + + +### I ignored a file in `.alexignore` but `pre-commit` is still failing + +See this issue: diff --git a/package.json b/package.json new file mode 100644 index 0000000..d4083c5 --- /dev/null +++ b/package.json @@ -0,0 +1,5 @@ +{ + "name": "placeholder_package", + "description": "Note: double curly-braces because python .format", + "version": "0.0.0" +}