https://github.com/xn-sakina/eslint-plugin-sakina

eslint config rules
https://github.com/xn-sakina/eslint-plugin-sakina

eslint eslint-plugin sakina

Last synced: about 2 months ago
JSON representation

eslint config rules

• Host: GitHub
• URL: https://github.com/xn-sakina/eslint-plugin-sakina
• Owner: xn-sakina
• License: mit
• Created: 2022-04-16T21:28:29.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T20:15:05.000Z (4 months ago)
• Last Synced: 2024-11-13T11:36:50.518Z (2 months ago)
• Topics: eslint, eslint-plugin, sakina
• Language: TypeScript
• Homepage:
• Size: 349 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-sakina

eslint config rules for quick use.

> *Required: `eslint ^9` and `typescript ^5`*

### Install

```bash

  pnpm add -D eslint-plugin-sakina

```

### Scene

##### normal

```js

// eslint.config.js

module.exports = require('eslint-plugin-sakina/recommended')()

```

##### react

```js

// eslint.config.js

module.exports = require('eslint-plugin-sakina/react')()

```

### Options

```js

// eslint.config.js

module.exports = require('eslint-plugin-sakina/...')({

  // ↓ only one option can be configured:

  // use `projectService`

  projectService: true,

  // or use `project`

  tsconfig: './tsconfig.eslint.json', // or ['./tsconfig.json', './packages/*/tsconfig.json']

  // ↓ config project root dir

  root: __dirname

})

```

### Legacy version

### v5.x

Migration v5 to v6: upgrade eslint to v9.

### v4.x

No breaking change.

### v3.x

Migration v3 to v4 :

```diff

// eslint.config.js

- module.exports = require('eslint-plugin-sakina/recommended')

+ module.exports = require('eslint-plugin-sakina/recommended')()

```

### v2.x

`@fz6m/eslint-plugin-sakina` : Old version in [v2](https://github.com/xn-sakina/eslint-plugin-sakina/tree/v2) branch.

### License

MIT