https://github.com/altnext/eslint-config-altnext
Shard Altnext styleguide ESLint configuration
https://github.com/altnext/eslint-config-altnext
eslint prettier typescript
Last synced: 4 months ago
JSON representation
Shard Altnext styleguide ESLint configuration
- Host: GitHub
- URL: https://github.com/altnext/eslint-config-altnext
- Owner: AltNext
- License: mit
- Created: 2021-06-22T11:45:41.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T17:24:00.000Z (about 1 year ago)
- Last Synced: 2025-05-12T18:34:02.391Z (about 1 year ago)
- Topics: eslint, prettier, typescript
- Language: TypeScript
- Size: 791 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# eslint-config-altnext
[](https://github.com/AltNext/eslint-config-altnext/actions/workflows/test.yml?query=branch%3Amain)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://sonarcloud.io/dashboard?id=AltNext_eslint-config-altnext)
[](https://app.snyk.io/org/altnext/project/46fd7677-38c9-4e4a-a374-664f722e4427)
[](https://www.npmjs.com/package/eslint-config-altnext)
[](https://www.npmjs.com/package/eslint-config-altnext)
[](https://www.npmjs.com/package/eslint-config-altnext)
[](https://www.npmjs.com/package/eslint-config-altnext)
[](https://www.github.com/altnext/eslint-config-altnext)
[](https://www.github.com/altnext/eslint-config-altnext)
[](https://www.github.com/altnext/eslint-config-altnext)
[](https://www.github.com/altnext/eslint-config-altnext)
[](https://www.github.com/altnext/eslint-config-altnext)
A highly opinionated configuration for ESLint and Prettier,
following Altnext's styleguide.
### Installation
Run `npm i -D eslint-config-altnext` (or `yarn add -D eslint-config-altnext`) to add this package to your project's `devDependencies`.
We bundle everything necessary to run [`eslint`](https://github.com/eslint/eslint),
including `eslint` itself.
### Usage
In your `.eslintrc.js` (or any other file you use to configure eslint),
add the config you want from this package to the `extends` field.
For example:
```javascript
module.exports = {
extends: ['altnext'],
};
```
We provide 2 configs, `altnext` (or `altnext/type-checking`, which point to the same config),
and `altnext/base`, which includes the base config, excluding rules that require type information to run.
If you use `altnext` (or `altnext/type-checking`),
you'll need to add a reference to your project's `tsconfig.json`,
for example:
```javascript
module.exports = {
extends: ['altnext'],
parserOptions: { tsconfigRootDir: __dirname, project: ['./tsconfig.json'] },
};
```
### Prettier
We also bundle Altnext's [`prettier`](https://github.com/prettier/prettier) configuration in this package.
To use it, simply set your project's `.prettierrc.js` file to the following:
```javascript
module.exports = require('eslint-config-altnext/.prettierrc');
```
### Plugins
We use a wide variety of plugins and other packages,
all of whom are bundled as dependencies of this package.
Special thanks to the maintainers and contributors of these packages.
The following are the various packages and plugins included when adding this package:
* [`@typescript-eslint/{eslint-plugin,parser}`](https://github.com/typescript-eslint/typescript-eslint)
* [`eslint`](https://github.com/eslint/eslint)
* [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier)
* [`eslint-import-resolver-alias`](https://github.com/johvin/eslint-import-resolver-alias)
* [`eslint-import-resolver-typescript`](https://github.com/alexgorbatchev/eslint-import-resolver-typescript)
* [`eslint-plugin-import`](https://github.com/benmosher/eslint-plugin-import)
* [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest)
* [`eslint-plugin-jest-formatting`](https://github.com/dangreenisrael/eslint-plugin-jest-formatting)
* [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
* [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node)
* [`eslint-plugin-playwright`](https://github.com/playwright-community/eslint-plugin-playwright)
* [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier)
* [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react)
* [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks)
* [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn)
* [`prettier`](https://github.com/prettier/prettier)