@futagoza/eslint-config-core 15.4.0 → 17.0.0

package/README.md

@@ -1,43 +1,68 @@
-[![dependencies](https://img.shields.io/david/futagoza/eslint-config-futagozaryuu.svg?path=packages/@futagoza/eslint-config-core)](https://david-dm.org/futagoza/eslint-config-futagozaryuu?path=packages/@futagoza/eslint-config-core)
-[![History](https://img.shields.io/badge/history-CHANGELOG.md-orange.svg)](https://github.com/futagoza/eslint-config-futagozaryuu/blob/master/CHANGELOG.md)
-[![License](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
-
-> This package contains configuration files for ESLint v7.15+<br>
-
-These are configuration files for ESLint that are mostly extended upon by my other ESLint configurations.
-
-The rules set in these files are the core set of built in rules separated by 4 categories: _possible-errors_, _best-practices_, _stylistic-issues_ and _variables_.
-
-## installation
-
-```console
-$ npm i --save-dev @futagoza/eslint-config-core
-```
-
-## usage
-
-Put the following into your configuration (`.eslintrc.*` file or the _"eslintConfig"_ field in `package.json`):
-
-```json
-{
-    "extends": "@futagoza/core"
-}
-```
-
-## configurations
-
-A list of usable configurations as well the configurations they use:
-
-- __`@futagoza/core`__ (_default_, extends: _possible-errors_, _best-practices_, _stylistic-issues_ and _variables_)
-- __`@futagoza/core/possible-errors`__
-- __`@futagoza/core/best-practices`__
-- __`@futagoza/core/stylistic-issues`__
-- __`@futagoza/core/variables`__
-- __`@futagoza/core/ecmascript-6`__
-
-You can also use `import { config } from "@futagoza/eslint-config-core/internal"` to get the default options for these rules.
-
-## license
-
-Copyright © 2017+ Futago-za Ryuu<br>
-Released under the MIT License, [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
+> This package contains configuration files for ESLint v10+<br>
+
+These are configuration files for ESLint that are mostly extended upon by my other ESLint configurations.
+
+Most of the rules set in these files are from the core set of built-in ESLint rules, with the rest from the `@stylistic` plugin
+
+## installation
+
+```console
+$ npm i --save-dev @futagoza/eslint-config-core
+```
+
+## usage
+
+Put the following into your eslint configuration file:
+
+```js
+import { defineConfig } from "eslint/config"
+import coreConfig from "@futagoza/eslint-config-core"
+
+// Used alongside other configurations:
+export default [
+
+    // ...
+
+    coreConfig,
+
+    // ...
+
+]
+
+// Used as base configuration for other configurations:
+export default defineConfig(
+    {
+
+        // ...
+
+        extends: [ coreConfig ],
+
+        // ...
+
+    },
+)
+
+// direct access to unprocessed config object
+import { config } from "@futagoza/eslint-config-core"
+
+// direct access to core ESLint rules used in this config
+import { EslintRules } from "@futagoza/eslint-config-core"
+
+// or direct access to ALL rules (ESLint + @stylistic) used in this config
+import { ConfigRules } from "@futagoza/eslint-config-core"
+```
+
+## configurations
+
+A list of usable configurations:
+
+- __`@futagoza/eslint-config-core`__ (_default_, extends the below auto-generated configurations)
+- __`@futagoza/eslint-config-core/rules/layout.js`__
+- __`@futagoza/eslint-config-core/rules/problem.js`__
+- __`@futagoza/eslint-config-core/rules/style.js`__
+- __`@futagoza/eslint-config-core/rules/suggestion.js`__
+
+## license
+
+Copyright © 2017+ Futago-za Ryuu<br>
+Released under the MIT License, [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)

package/index.js

@@ -1,16 +1,55 @@
-"use strict";
+import { defineConfig } from "eslint/config"
+import { config as LayoutConfig } from "./rules/layout.js"
+import { config as ProblemConfig } from "./rules/problem.js"
+import { config as SuggestionConfig } from "./rules/suggestion.js"
+import { config as StyleConfig } from "./rules/style.js"
 
-module.exports = {
+/**
+ * ESLint's built-in rules
+ */
+export const EslintRules = {
 
-    "extends": [
+    ...LayoutConfig.rules,
+    ...ProblemConfig.rules,
+    ...SuggestionConfig.rules,
 
-        "./possible-errors.js",
-        "./best-practices.js",
-        "./stylistic-issues.js",
-        "./variables.js",
+}
 
+/**
+ * ESLint's built-in rules + `@stylistic` rules
+ */
+export const ConfigRules = {
+
+    ...EslintRules,
+    ...StyleConfig.rules,
+
+}
+
+/**
+ * Raw config for `@futagoza/eslint-config-core`
+ * 
+ * **NOTE:** Will not work properly with ESLint until passed through `require( "eslint/config" ).defineConfig`
+ */
+export const config = {
+
+    name: "@futagoza/eslint-config-core",
+
+    extends: [
+        LayoutConfig,
+        ProblemConfig,
+        SuggestionConfig,
+        StyleConfig,
     ],
 
-    "reportUnusedDisableDirectives": true,
+    linterOptions: {
+
+        reportUnusedDisableDirectives: "warn",
+
+    },
+
+}
 
-};
+/**
+ * ESLint ready config for `@futagoza/eslint-config-core`
+ */
+export default defineConfig( config )

package/package.json

@@ -1,17 +1,22 @@
 {
     "name": "@futagoza/eslint-config-core",
-    "version": "15.4.0",
+    "version": "17.0.0",
     "description": "Futago-za Ryuu's basic ESLint configurations",
     "keywords": [
         "eslint",
         "configuration",
+        "lint",
         "style"
     ],
     "repository": "https://github.com/futagoza/eslint-config-futagozaryuu/tree/master/packages/@futagoza/eslint-config-core",
     "license": "MIT",
     "author": "Futago-za Ryuu",
     "main": "index.js",
+    "type": "module",
+    "dependencies": {
+        "@stylistic/eslint-plugin": "6.0.0-beta.5"
+    },
     "engines": {
-        "node": ">=10.0.0"
+        "node": ">=20.0.0"
     }
 }

package/rules/layout.js

@@ -0,0 +1,30 @@
+// 
+// WARNING: AUTO-GENERATED USING https://raw.githubusercontent.com/eslint/eslint/main/docs/src/_data/rules.json
+// 
+// These rules care about how the code looks rather than how it executes
+// 
+
+/**
+ * Raw config for `@futagoza/eslint-config-core/rules/layout.js`
+ */
+export const config = {
+
+    name: "@futagoza/eslint-config-core/layout",
+
+    rules: {
+
+        /**
+         * 🔧 Require or disallow Unicode byte order mark (BOM)
+         * 
+         * @see http://eslint.org/docs/rules/unicode-bom
+         */
+        "unicode-bom": "warn",
+
+    },
+
+}
+
+/**
+ * ESLint ready config for `@futagoza/eslint-config-core/rules/layout.js`
+ */
+export default [ config ]