Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pa11y/pa11y-lint-config
Linter configurations for Pa11y projects
https://github.com/pa11y/pa11y-lint-config
eslint
Last synced: 7 days ago
JSON representation
Linter configurations for Pa11y projects
- Host: GitHub
- URL: https://github.com/pa11y/pa11y-lint-config
- Owner: pa11y
- License: lgpl-3.0
- Created: 2017-03-20T18:51:08.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T11:29:59.000Z (7 months ago)
- Last Synced: 2024-11-04T18:11:54.132Z (13 days ago)
- Topics: eslint
- Language: JavaScript
- Homepage: https://pa11y.org
- Size: 66.4 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Pa11y Lint Config
Linter configurations for Pa11y projects. We use these configurations to ensure Pa11y's coding style remains consistent across our repositories.
[![Latest version published to npm][shield-npm]][info-npm]
[![Node.js version support][shield-node]][info-node]
[![ESLint version target][shield-eslint]][eslint]
[![Build status][shield-build]][info-build]
[![LGPL-3.0 licensed][shield-license]][info-license]
## Table Of Contents
- [Requirements](#requirements)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Requirements
This library requires [Node.js] 18 or above.
## Usage
To include these config files in your project, install this module as a development dependency. Using npm:
```sh
npm install --save-dev pa11y-lint-config
```
The logging will mention any further peer dependencies required.
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:
```sh
printf "coverage\n" > .eslintignore
printf "'use strict';\n\nmodule.exports = require('pa11y-lint-config');\n" > .eslintrc.js
```
## Contributing
There are many ways to contribute to Pa11y Lint Config, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
If you're ready to contribute some code, clone this repo locally and commit your code on a new branch.
Please check that everything works by running the following before opening a PR:
```sh
npm test
```
### Testing the GitHub Actions workflows
This project's GitHub Actions workflows can be tested locally using [nektos/act](https://github.com/nektos/act), which can be installed with Homebrew:
```sh
brew install act
```
To run the testing workflow locally:
```sh
act
```
To validate the testing workflow, without running it:
```sh
act --dryrun
```
To validate the publishing workflow:
```sh
act --dryrun release
```
Add `--verbose` to any `act` command for more output.
## Support
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.
## Licence
Licensed under the [Lesser General Public License (LGPL-3.0)](LICENSE).
Copyright © 2023, Team Pa11y
[eslint]: http://eslint.org/
[issues]: https://github.com/pa11y/pa11y-lint-config/issues
[node.js]: https://nodejs.org/
[info-build]: https://github.com/pa11y/pa11y-lint-config/actions/workflows/tests.yml
[info-license]: LICENSE
[info-node]: package.json
[info-npm]: https://www.npmjs.com/package/pa11y-lint-config
[shield-build]: https://github.com/pa11y/pa11y-lint-config/actions/workflows/tests.yml/badge.svg
[shield-eslint]: https://img.shields.io/npm/dependency-version/pa11y-lint-config/dev/eslint
[shield-license]: https://img.shields.io/badge/license-LGPL%203.0-blue
[shield-node]: https://img.shields.io/node/v/pa11y-lint-config
[shield-npm]: https://img.shields.io/npm/v/pa11y-lint-config