Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rygent/eslint-config-terrax
The ESLint shareable config
https://github.com/rygent/eslint-config-terrax
eslint eslint-config lint linter
Last synced: 15 days ago
JSON representation
The ESLint shareable config
- Host: GitHub
- URL: https://github.com/rygent/eslint-config-terrax
- Owner: rygent
- License: mit
- Created: 2024-06-04T05:54:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T19:33:07.000Z (18 days ago)
- Last Synced: 2024-12-09T20:34:31.607Z (18 days ago)
- Topics: eslint, eslint-config, lint, linter
- Language: TypeScript
- Homepage:
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Terrax ESLint Config
[](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
[](https://www.npmjs.com/package/eslint-config-terrax)
[](https://www.npmjs.com/package/eslint-config-terrax)
_This config was inspired by [eslint-config-neon](https://github.com/iCrawl/eslint-config-neon) and [eslint-config-tesseract](https://github.com/MenuDocs/eslint-config-tesseract)._
## Installation
```sh
# NPM
npm install -D eslint eslint-config-terrax
# Yarn
yarn add -D eslint eslint-config-terrax
# PNPM
pnpm add -D eslint eslint-config-terrax
```
## Configurations
Package includes the following configurations:
| Configuration | Description |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`eslint-config-terrax/common`](./src/common.ts) | The terrax code style guide. |
| [`eslint-config-terrax/browser`](./src/browser.ts) | For usage with DOM and other browser APIs. |
| [`eslint-config-terrax/edge`](./src/edge.ts) | For usage with an edge runtime [Vercel](https://vercel.com/blog/introducing-the-edge-runtime), [Cloudflare Workers](https://workers.cloudflare.com/), or others. |
| [`eslint-config-terrax/jsx`](./src/jsx.ts) | For usage with [JSX](https://reactjs.org/docs/introducing-jsx.html) (with or without [React](https://reactjs.org/)). |
| [`eslint-config-terrax/jsx-a11y`](./src/jsx-a11y.ts) | For usage with [JSX](https://facebook.github.io/react/) (with or without [React](https://reactjs.org/)) and want to include [accessibility checks](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y). |
| [`eslint-config-terrax/next`](./src/next.ts) | For usage with [Next.js](https://nextjs.org/). |
| [`eslint-config-terrax/node`](./src/node.ts) | For usage with Node.js. |
| [`eslint-config-terrax/react`](./src/react.ts) | For usage with [React](https://reactjs.org/). |
| [`eslint-config-terrax/typescript`](./src/typescript.ts) | For usage with [TypeScript](http://typescriptlang.org/). |
## Notes
### Flat Config only
It is important to note that this package only exports [ESLint Flat Config][]! This means that you _have_ to use at least ESLint 9 and `eslint.config.js`, `eslint.config.mjs`, or `eslint.config.cjs` to use this package. See the ESLint documentation on flat config for more information.
### Importing
There are two ways to import the configs:
```ts
import common from 'eslint-config-terrax/common';
```
or
```ts
import { common } from 'eslint-config-terrax';
```
### Merging Configs
In the examples below you will see `lodash.merge` being used. This is of vital importance as objects often have to be deeply merged when using ESLint Flat Config. If you don't merge the objects, you will overwrite the previous object with the new one, and your config will be invalid.
## Usage
### NodeJS
```js
import { common, node, typescript } from 'eslint-config-terrax';
import merge from 'lodash.merge';
/**
* @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
*/
const config = [
...[...common, ...node, ...typescript].map((config) =>
merge(config, {
files: ['src/**/*.ts'],
languageOptions: {
parserOptions: {
project: 'tsconfig.eslint.json'
}
}
})
)
];
export default config;
```
### NextJS
```js
import { browser, common, edge, next, node, react, typescript } from 'eslint-config-terrax';
import merge from 'lodash.merge';
/**
* @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
*/
const config = [
...[...common, ...browser, ...node, ...typescript, ...react, ...next, ...edge].map((config) =>
merge(config, {
files: ['src/**/*.ts'],
settings: {
react: {
version: 'detect'
}
},
languageOptions: {
parserOptions: {
project: 'tsconfig.json'
}
}
})
)
];
export default config;
```
[ESLint Flat Config]: https://eslint.org/blog/2022/08/new-config-system-part-2/