https://github.com/runtimeverification/eslint-config-rv-web-nestjs
RV web nest.js eslint config
https://github.com/runtimeverification/eslint-config-rv-web-nestjs
Last synced: 5 months ago
JSON representation
RV web nest.js eslint config
- Host: GitHub
- URL: https://github.com/runtimeverification/eslint-config-rv-web-nestjs
- Owner: runtimeverification
- Created: 2023-04-10T11:13:40.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-08-20T14:45:40.000Z (10 months ago)
- Last Synced: 2025-08-20T16:36:18.004Z (10 months ago)
- Language: JavaScript
- Size: 55.7 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-config-rv-web-nestjs
## Installation
### Yarn
```sh
yarn add -D @eslint-community/eslint-plugin-eslint-comments eslint
yarn add -D git+https://github.com/runtimeverification/eslint-config-rv-web-nestjs.git#master
```
### NPM
```sh
npm install --save-dev @eslint-community/eslint-plugin-eslint-comments eslint prettier
npm install --save-dev git+https://github.com/runtimeverification/eslint-config-rv-web-nestjs.git#master
```
## Usage
Create `eslint.config.js` in the root of your project and add the following configuration and adjust the settings to your needs
```javascript
// eslint.config.js
import { defineConfig } from 'eslint/config';
import globals from 'globals';
import tsParser from '@typescript-eslint/parser';
import tsPlugin from '@typescript-eslint/eslint-plugin';
import { fileURLToPath } from 'node:url';
import eslintComments from '@eslint-community/eslint-plugin-eslint-comments';
import rv from 'eslint-config-rv-web-nestjs';
import path from 'node:path';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
export default defineConfig([
{
ignores: [
// files that should be ignored
'**/.eslintrc.js',
'src/@generated/**',
'build/**',
'build-web/**',
],
},
{ plugins: { '@eslint-community/eslint-comments': eslintComments } },
// ⬇️ flatten the shared config (no nested `extends`)
...rv,
// Custom rules
{
rules: {
'unicorn/prevent-abbreviations': 'off',
'@typescript-eslint/no-unused-vars': [
'error',
{
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^_',
},
],
'unicorn/filename-case': [
'error',
{
cases: {
kebabCase: false,
pascalCase: false,
camelCase: true,
},
},
],
},
},
{
files: ['src/**/*.ts'],
languageOptions: {
parser: tsParser,
parserOptions: {
// path to your tsconfig
project: 'tsconfig.json',
tsconfigRootDir: __dirname,
sourceType: 'module',
},
globals: { ...globals.node, ...globals.jest },
},
plugins: { '@typescript-eslint': tsPlugin },
},
]);
```
Create `.prettierrc` in the root of your project and add the following configuration
```json
{
"singleQuote": true,
"trailingComma": "all",
"tabWidth": 2
}
```
## Add script to `package.json`
```json
{
"scripts": {
"format": "prettier --config .prettierrc --write .",
"lint": "eslint",
"fix": "eslint --fix"
}
}
```
## Reference
- [Share Configurations](https://eslint.org/docs/latest/extend/shareable-configs)