Skip to content

Commit

Permalink
Mirror: 1.0.0
Browse files Browse the repository at this point in the history
The following PRs have been squashed in to this commit:

* #1
  • Loading branch information
mfisher87 committed May 6, 2024
0 parents commit e1e45c0
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*
11 changes: 11 additions & 0 deletions .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
@@ -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: ["[email protected]"]
minimum_pre_commit_version: '0'
1 change: 1 addition & 0 deletions .version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.0.0
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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: <https://github.com/get-alex/alex/issues/348>
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "placeholder_package",
"description": "Note: double curly-braces because python .format",
"version": "0.0.0"
}

0 comments on commit e1e45c0

Please sign in to comment.