Skip to content

Commit e1e45c0

Browse files
committed
Mirror: 1.0.0
The following PRs have been squashed in to this commit: * #1
0 parents  commit e1e45c0

File tree

5 files changed

+50
-0
lines changed

5 files changed

+50
-0
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*

.pre-commit-hooks.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- id: alex
2+
name: alex
3+
description: "Check files to 'find gender favoring, polarizing, race related, religion inconsiderate, or other unequal phrasing in text.'"
4+
entry: alex
5+
language: node
6+
exclude: ".pre-commit-config.yaml"
7+
'types': [text]
8+
args: []
9+
require_serial: false
10+
additional_dependencies: ["[email protected]"]
11+
minimum_pre_commit_version: '0'

.version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0.0

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AlexJS pre-commit mirror
2+
3+
Mirror of [AlexJS](https://alexjs.com) for [pre-commit](https://pre-commit.com).
4+
5+
## Using AlexJS with `pre-commit`
6+
7+
Example `.pre-commit.config.yml`:
8+
9+
```yaml
10+
repos:
11+
- repo: "https://github.com/mfisher87/alexjs-pre-commit-mirror"
12+
rev: "v11.0.1" # Use the sha / tag you prefer
13+
hooks:
14+
- id: "alex"
15+
```
16+
17+
## Continuous Integration
18+
19+
Two example ways to run AlexJS inclusive language checks in CI for your repository using
20+
your existing `pre-commit` configuration from the previous step:
21+
22+
* [The official pre-commit GitHub action](https://github.com/pre-commit/action): :rock:
23+
Very stable
24+
* [pre-commit.ci](https://pre-commit.ci): :zap: Faster, but has more frequent outages.
25+
26+
27+
## Troubleshooting
28+
29+
30+
### I ignored a file in `.alexignore` but `pre-commit` is still failing
31+
32+
See this issue: <https://github.com/get-alex/alex/issues/348>

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "placeholder_package",
3+
"description": "Note: double curly-braces because python .format",
4+
"version": "0.0.0"
5+
}

0 commit comments

Comments
 (0)