@lzear/eslint-config 2.0.0 → 3.0.0

package/readme.md

@@ -1,36 +1,44 @@
-# @lzear/eslint-config
+# ESLint Config
 
-<img src="https://github-production-user-asset-6210df.s3.amazonaws.com/5698350/241426629-f7e3a5bf-50fe-49c1-ad76-98bd3914cd3e.svg" alt="ESLint" align="right" width="150" height="150" />
+[![Version](https://img.shields.io/npm/v/@lzear/eslint-config.svg?color=4a32c3&labelColor=26272b)](https://npmjs.com/package/@lzear/eslint-configt)
+[![GitHub License](https://img.shields.io/badge/license-MIT-232428.svg?color=4a32c3&labelColor=26272b)](https://github.com/azat-io/eslint-config/blob/main/license.md)
 
-![Version](https://img.shields.io/npm/v/@lzear/eslint-config.svg?color=brightgreen)
+My preferred ESLint configuration. Forked from [azat-io/eslint-config](https://github.com/azat-io/eslint-config), with some modifications including:
 
-Shareable ESLint config for JavaScript projects.
+- Use recommended presets from the plugins instead of managing the rules manually.
+- Changing rules to my personal preferences.
 
-See [docs](https://github.com/lzear/eslint-config/blob/main/base/docs.md) for a
-list of all rules.
-
-## Installation
+## Usage
 
 1. Install package:
 
-```sh
-yarn add --save-dev eslint @lzear/eslint-config eslint-plugin-import eslint-plugin-n eslint-plugin-node-import eslint-plugin-prefer-arrow eslint-plugin-promise eslint-plugin-sonarjs eslint-plugin-unicorn
-```
+   ```sh
+   yarn add --D eslint @lzear/eslint-config
+   ```
 
 2. Create ESLint configuration file `eslint.config.js`:
 
-```js
-import eslintConfig from '@lzear/eslint-config'
+   ```js
+   import eslintConfig from '@lzear/eslint-config'
+
+   export default eslintConfig({
+     perfectionist: true,
+     typescript: true,
+     react: true,
+     node: true,
+   })
+   ```
+
+3. Add script for `package.json`:
 
-export default eslintConfig
-```
+   ```json
+   {
+     "scripts": {
+       "test:js": "eslint \"**/*.{js,ts,jsx,tsx,json}\""
+     }
+   }
+   ```
 
-3. Add script for package.json:
+## License
 
-```js
-{
-  "scripts": {
-    "lint": "eslint .",
-  }
-}
-```
+MIT &copy; [Azat S.](https://azat.io)

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";const c=require("eslint-plugin-prefer-arrow"),u=require("eslint-plugin-node-import"),r=require("eslint-plugin-import"),o=require("eslint-plugin-prettier"),n=require("eslint-plugin-promise"),s=require("eslint-plugin-unicorn"),i=require("eslint-plugin-sonarjs"),t=require("eslint-plugin-n"),e=require("globals"),l=require("@eslint/js");const d=[{ignores:["**/node_modules/**","**/dist/**",".git/**"]},l.configs.recommended,{languageOptions:{ecmaVersion:2023,sourceType:"module",globals:{...e.browser,...e.es2021,...e.node}},plugins:{"prefer-arrow":c,"node-import":u,import:r,promise:n,sonarjs:i,unicorn:s,n:t},rules:{...r.configs.recommended.rules,...t.configs.recommended.rules,"node-import/prefer-node-protocol":2,"prefer-arrow/prefer-arrow-functions":[2,{disallowPrototype:!0,singleReturnOnly:!1,classPropertiesAllowed:!1}],...n.configs.recommended.rules,...i.configs.recommended.rules,...s.configs.recommended.rules}},{rules:{"n/no-missing-import":0,"prefer-const":2,"unicorn/no-abusive-eslint-disable":0,"unicorn/no-null":0,"unicorn/prevent-abbreviations":[0,{checkProperties:!0}]}},{plugins:{prettier:o},rules:o.configs.recommended.rules}],m=d;module.exports=m;