You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+33-11
Original file line number
Diff line number
Diff line change
@@ -21,26 +21,21 @@ This library requires [Node.js] 18 or above.
21
21
22
22
## Usage
23
23
24
-
To include these config files in your project, first install [ESLint] and this module, saving them to development dependencies. For example, using npm:
24
+
To include these config files in your project, install this module as a development dependency. Using npm:
25
25
26
26
```sh
27
-
npm install --save-dev eslint pa11y-lint-config
27
+
npm install --save-dev pa11y-lint-config
28
28
```
29
29
30
+
The logging will mention any further peer dependencies required.
31
+
30
32
Now create the files `.eslintrc.js` and `.eslintignore` in your project root. The following command will create both files and populate them with sensible settings for a new Pa11y project:
1.`es2015`, for an ES2015/ES6 project, forgoing the use of more recent syntax additions such as `async`
40
-
1.`es2009`, for an ES2009/ES5 project, such as an older client-side codebase
41
-
42
-
A project which contains more than one standard, for example ES2017 for the server and ES2015 for the browser, can support each required standard by including a different config file in each relevant subdirectory.
43
-
44
39
## Contributing
45
40
46
41
There are many ways to contribute to Pa11y Lint Config, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
@@ -53,6 +48,34 @@ Please check that everything works by running the following before opening a <ab
53
48
npm test
54
49
```
55
50
51
+
### Testing the GitHub Actions workflows
52
+
53
+
This project's GitHub Actions workflows can be tested locally using [nektos/act](https://github.com/nektos/act), which can be installed with Homebrew:
54
+
55
+
```sh
56
+
brew install act
57
+
```
58
+
59
+
To run the testing workflow locally:
60
+
61
+
```sh
62
+
act
63
+
```
64
+
65
+
To validate the testing workflow, without running it:
66
+
67
+
```sh
68
+
act --dryrun
69
+
```
70
+
71
+
To validate the publishing workflow:
72
+
73
+
```sh
74
+
act --dryrun release
75
+
```
76
+
77
+
Add `--verbose` to any `act` command for more output.
78
+
56
79
## Support
57
80
58
81
When we release a new major version we will continue to support the previous major version for 6 months. This support will be limited to fixes for critical bugs and security issues.
@@ -63,7 +86,6 @@ Licensed under the [Lesser General Public License (LGPL-3.0)](LICENSE).<br/>
0 commit comments