@citrus-linting/eslint-config 0.21.1 → 1.0.0

package/README.md

@@ -8,10 +8,6 @@ ESLint config used by [CitRUS](https://github.com/CitRUSprod).
 2. [TypeScript](#typescript)
 3. [Svelte](#svelte)
 4. [Svelte TypeScript](#svelte-typescript)
-5. [JSON](#json)
-6. [YAML](#yaml)
-7. [Jest](#jest)
-8. [JSDoc](#jsdoc)
 
 ## Usage
 
@@ -20,205 +16,153 @@ ESLint config used by [CitRUS](https://github.com/CitRUSprod).
 Install dependencies:
 
 ```sh
-npm add -D @citrus-linting/eslint-config
+npm add -D globals @citrus-linting/eslint-config
 ```
 
-Add `extends` field to your ESLint config:
+Add `extends` field to your ESLint config (eslint.config.js):
 
-```jsonc
-{
-    "extends": ["@citrus-linting"]
-    // your options
-}
+```javascript
+import baseConfig from "@citrus-linting/eslint-config"
 
-// or only rules
-{
-    "extends": ["@citrus-linting/eslint-config/rules/base"]
-    // your options
-}
+export default [
+    ...baseConfig
+    // your configs
+]
 ```
 
-### TypeScript
+or only rules:
 
-Install dependencies:
+```javascript
+import baseRules from "@citrus-linting/eslint-config/rules/base"
 
-```sh
-npm add -D @typescript-eslint/parser @typescript-eslint/eslint-plugin @citrus-linting/eslint-config
+export default [
+    {
+        files: ["**/*.js"],
+        rules: {
+            ...baseRules
+            // your rules
+        }
+    }
+]
 ```
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/typescript"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/typescript"
-    ]
-    // your options
-}
-```
-
-### Svelte
+### TypeScript
 
 Install dependencies:
 
 ```sh
-npm add -D svelte-eslint-parser eslint-plugin-svelte @citrus-linting/eslint-config
+npm add -D globals typescript-eslint @citrus-linting/eslint-config
 ```
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/svelte"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/svelte"
-    ]
-    // your options
-}
-```
-
-### Svelte TypeScript
+Add `extends` field to your ESLint config (eslint.config.js):
 
-Install dependencies:
+```javascript
+import baseConfig from "@citrus-linting/eslint-config"
+import typescriptConfig from "@citrus-linting/eslint-config/typescript"
 
-```sh
-npm add -D svelte-eslint-parser eslint-plugin-svelte @typescript-eslint/parser @typescript-eslint/eslint-plugin @citrus-linting/eslint-config
+export default [
+    ...baseConfig,
+    ...typescriptConfig
+    // your configs
+]
 ```
 
-Add `extends` field to your ESLint config:
+or only rules:
 
-> **NOTE:** Need tsconfig.eslint.json file.
+```javascript
+import baseRules from "@citrus-linting/eslint-config/rules/base"
+import typescriptRules from "@citrus-linting/eslint-config/rules/typescript"
 
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/svelte-typescript"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/typescript",
-        "@citrus-linting/eslint-config/rules/svelte"
-    ]
-    // your options
-}
+export default [
+    {
+        files: ["**/*.ts"],
+        rules: {
+            ...baseRules,
+            ...typescriptRules
+            // your rules
+        }
+    }
+]
 ```
 
-### JSON
+### Svelte
 
 Install dependencies:
 
 ```sh
-npm add -D jsonc-eslint-parser eslint-plugin-jsonc @citrus-linting/eslint-config
+npm add -D globals svelte-eslint-parser eslint-plugin-svelte @citrus-linting/eslint-config
 ```
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/json"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/json"
-    ]
-    // your options
-}
-```
-
-### YAML
+Add `extends` field to your ESLint config (eslint.config.js):
 
-Install dependencies:
+```javascript
+import baseConfig from "@citrus-linting/eslint-config"
+import svelteConfig from "@citrus-linting/eslint-config/svelte"
 
-```sh
-npm add -D yaml-eslint-parser eslint-plugin-yml @citrus-linting/eslint-config
+export default [
+    ...baseConfig,
+    ...svelteConfig
+    // your configs
+]
 ```
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/yaml"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/yaml"
-    ]
-    // your options
-}
-```
-
-### Jest
-
-Install dependencies:
+or only rules:
 
-```sh
-npm add -D eslint-plugin-jest @citrus-linting/eslint-config
-```
+```javascript
+import baseRules from "@citrus-linting/eslint-config/rules/base"
+import svelteRules from "@citrus-linting/eslint-config/rules/svelte"
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/jest"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/jest"
-    ]
-    // your options
-}
+export default [
+    {
+        files: ["**/*.svelte"],
+        rules: {
+            ...baseRules,
+            ...svelteRules
+            // your rules
+        }
+    }
+]
 ```
 
-### JSDoc
+### Svelte TypeScript
 
 Install dependencies:
 
 ```sh
-npm add -D eslint-plugin-jsdoc @citrus-linting/eslint-config
+npm add -D globals svelte-eslint-parser eslint-plugin-svelte typescript-eslint @citrus-linting/eslint-config
 ```
 
-Add `extends` field to your ESLint config:
-
-```jsonc
-{
-    "extends": ["@citrus-linting", "@citrus-linting/eslint-config/jsdoc"]
-    // your options
-}
-
-// or only rules
-{
-    "extends": [
-        "@citrus-linting/eslint-config/rules/base",
-        "@citrus-linting/eslint-config/rules/jsdoc"
-    ]
-    // your options
-}
+Add `extends` field to your ESLint config (eslint.config.js):
+
+> **NOTE:** Need tsconfig.eslint.json file.
+
+```javascript
+import baseConfig from "@citrus-linting/eslint-config"
+import svelteTypescriptConfig from "@citrus-linting/eslint-config/svelte-typescript"
+
+export default [
+    ...baseConfig,
+    ...svelteTypescriptConfig
+    // your configs
+]
+```
+
+or only rules:
+
+```javascript
+import baseRules from "@citrus-linting/eslint-config/rules/base"
+import typescriptRules from "@citrus-linting/eslint-config/rules/typescript"
+import svelteRules from "@citrus-linting/eslint-config/rules/svelte"
+
+export default [
+    {
+        files: ["**/*.svelte"],
+        rules: {
+            ...baseRules,
+            ...typescriptRules,
+            ...svelteRules
+            // your rules
+        }
+    }
+]
 ```

package/index.js

@@ -1,13 +1,23 @@
-module.exports = {
-    extends: ["./rules/base"],
-    root: true,
-    parserOptions: {
-        sourceType: "module",
-        ecmaVersion: 2020
+const globals = require("globals")
+
+const baseRules = require("./rules/base")
+
+module.exports = [
+    {
+        languageOptions: {
+            ecmaVersion: 2024,
+            sourceType: "module",
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+                ...globals.es6
+            }
+        }
     },
-    env: {
-        browser: true,
-        node: true,
-        es6: true
+    {
+        files: ["**/*.?([cm])js"],
+        rules: {
+            ...baseRules
+        }
     }
-}
+]

package/package.json

@@ -1,17 +1,13 @@
 {
   "name": "@citrus-linting/eslint-config",
-  "version": "0.21.1",
+  "version": "1.0.0",
   "description": "ESLint config used by CitRUS.",
   "keywords": [
     "config",
     "eslint",
     "javascript",
     "typescript",
-    "svelte",
-    "json",
-    "yaml",
-    "jest",
-    "jsdoc"
+    "svelte"
   ],
   "homepage": "https://github.com/CitRUSprod/citrus-linting#readme",
   "repository": {
@@ -21,7 +17,15 @@
   },
   "license": "MIT",
   "author": "CitRUS",
-  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./typescript": "./typescript.js",
+    "./svelte": "./svelte.js",
+    "./svelte-typescript": "./svelte-typescript.js",
+    "./rules/base": "./rules/base.js",
+    "./rules/typescript": "./rules/typescript.js",
+    "./rules/svelte": "./rules/svelte.js"
+  },
   "publishConfig": {
     "access": "public"
   }