eslint-plugin-gb 9.1.0 → 9.2.0-beta.2

package/README.md

@@ -17,18 +17,18 @@ npm add --save-dev eslint-plugin-gb
 
 ## Usage
 
-see [Configuration Files - ESLint - Pluggable JavaScript Linter](https://eslint.org/docs/latest/use/configure/configuration-files) for detailed information. For the basics add the `eslint.config.js` to the root of your project.
+see [Configuration Files - ESLint - Pluggable JavaScript Linter](https://eslint.org/docs/latest/use/configure/configuration-files) for detailed information. For the basics add the `eslint.config.*js` to the root of your project.
 
 ```cjs
 // eslint.config.cjs
-const js = require('@eslint/js');
-const gb = require('eslint-plugin-gb');
+const js = require("@eslint/js");
+const gb = require("eslint-plugin-gb");
 
 module.exports = [
   ...js.configs.recommended,
-  ...gb.configs['flat/recommended'],
+  ...gb.configs["recommended"],
   {
-    files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
     // Override or add rules here
     rules: {},
   },
@@ -38,16 +38,20 @@ module.exports = [
 ```mjs
 // eslint.config.mjs
 import js from "@eslint/js";
-import ts from "typescript-eslint";
 import gb from "eslint-plugin-gb";
-import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
 
-/** @type {import('eslint').Linter.Config[]} */
-export default [
-  js.configs.recommended,
-  ...ts.configs.recommended,
-  ...gb.configs["flat/recommended"],
-];
+export default defineConfig([
+  tseslint.configs.recommended,
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js, gb },
+    extends: ["js/recommended", "gb/recommended"],
+    // Override or add rules here
+    rules: {},
+  },
+]);
 ```
 
 ## `recommended` config
@@ -58,19 +62,9 @@ export default [
 | [@typescript-eslint/consistent-type-imports](https://typescript-eslint.io/rules/consistent-type-imports) | warn |
 | [@typescript-eslint/explicit-member-accessibility](https://typescript-eslint.io/rules/explicit-member-accessibility/) | warn |
 | [@typescript-eslint/explicit-module-boundary-types](https://typescript-eslint.io/rules/explicit-module-boundary-types/) | warn |
-| [@typescript-eslint/member-ordering](https://typescript-eslint.io/rules/member-ordering/) | warn (with alphabetical ordering and [strict rules](./configs/member-order.js).) |
+| [@typescript-eslint/member-ordering](https://typescript-eslint.io/rules/member-ordering/) | warn (with alphabetical ordering and [strict rules](./lib/member-order.js).) |
 | [@typescript-eslint/no-unused-vars](https://typescript-eslint.io/rules/no-unused-vars/) | off |
 
-## `recommended-type-checked` config
-
-all of the `recommended` rules and also the following.
-
-<!-- prettier-ignore -->
-| Rule  | Setting |
-| --- | --- |
-| [@typescript-eslint/no-floating-promises](https://typescript-eslint.io/rules/no-floating-promises/) | warn |
-| [@typescript-eslint/unbound-method](https://typescript-eslint.io/rules/unbound-method/)  | error |
-
 ## development
 
 This is a bare-bones library. There are no npm scripts or monorepo plugins. `npx prettier . -w` works ok.
@@ -79,5 +73,5 @@ This is a bare-bones library. There are no npm scripts or monorepo plugins. `npx
 
 | eslint-plugin-gb version | eslint version |
 | ------------------------ | -------------- |
-| ^9.0.0                   | >=9.0.0        |
+| ^9.2.0                   | >=9.9.0        |
 | ^2.0.0                   | <9.0.0         |

package/configs/base.js

@@ -0,0 +1,10 @@
+// @ts-check
+import { ESLint } from "eslint";
+
+/** @type {ESLint.ConfigData} */
+export const base = {
+  rules: {
+    "@typescript-eslint/explicit-member-accessibility": "warn",
+    "@typescript-eslint/consistent-type-imports": "warn",
+  },
+};

package/configs/recommended.js

@@ -0,0 +1,19 @@
+import { memberOrder } from "../lib/member-order.js";
+import { base } from "./base.js";
+
+export const recommended = {
+  ...base,
+  rules: {
+    "@typescript-eslint/member-ordering": [
+      "warn",
+      {
+        default: {
+          memberTypes: memberOrder,
+          order: "alphabetically",
+        },
+      },
+    ],
+    "@typescript-eslint/explicit-module-boundary-types": "warn",
+    "@typescript-eslint/no-unused-vars": "off",
+  },
+};

package/index.d.ts

@@ -1,15 +1,15 @@
-declare const flatBase: any;
-declare const flatRecommended: any;
-declare const pkg: any;
-declare const plugin: {
-  meta: {
-    name: string;
-    version: string;
+import type { Linter } from "eslint";
+
+declare const gb: {
+  readonly meta: {
+    readonly name: string;
+    readonly version: string;
+    readonly namespace: string;
   };
-  configs: {
-    "flat/base": any;
-    "flat/recommended": any;
+  readonly configs: {
+    readonly recommended: { readonly rules: Readonly<Linter.RulesRecord> };
+    readonly all: { readonly rules: Readonly<Linter.RulesRecord> };
   };
-  rules: {};
-  processors: {};
 };
+
+export = gb;

package/index.js

@@ -1,42 +1,22 @@
-const flatBase = require("./configs/flat/base.js");
-const flatRecommended = require("./configs/flat/recommended.js");
-
-const pkg = require("./package.json");
-
-const plugin = {
-  meta: {
-    name: pkg.name,
-    version: pkg.version,
-  },
-  configs: {
-    "flat/base": flatBase,
-    "flat/recommended": flatRecommended,
-  },
-  rules: {},
-  processors: {},
-};
-
-// Object.assign(plugin.configs, {
-//   recommended: [
-//     {
-//       plugins: {
-//         gb: plugin,
-//       },
-//       rules: {
-//         "example/dollar-sign": "error",
-//       },
-//       languageOptions: {
-//         globals: {
-//           myGlobal: "readonly",
-//         },
-//         parserOptions: {
-//           ecmaFeatures: {
-//             jsx: true,
-//           },
-//         },
-//       },
-//     },
-//   ],
-// });
-
-module.exports = plugin;
+// @ts-check
+import { readFileSync } from "fs";
+import { base } from "./configs/base.js";
+import { recommended } from "./configs/recommended.js";
+
+const pkg = JSON.parse(
+  readFileSync(new URL("./package.json", import.meta.url), "utf8"),
+);
+
+const plugin = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+    namespace: "gb",
+  },
+  configs: {
+    base,
+    recommended,
+  },
+};
+
+export default plugin;

package/{configs → lib}/member-order.js

@@ -1,4 +1,4 @@
-module.exports = [
+export const memberOrder = [
   // Index signature
   "signature",
   "call-signature",

package/package.json

@@ -1,36 +1,32 @@
-{
-  "name": "eslint-plugin-gb",
-  "version": "9.1.0",
-  "description": "ESLint rules I like",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "scripts": {
-    "test": "npx jest"
-  },
-  "peerDependencies": {
-    "eslint": "^9.9.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/GaryB432/eslint-plugin-gb.git"
-  },
-  "type": "commonjs",
-  "keywords": [
-    "eslint",
-    "eslint-plugin",
-    "eslintplugin"
-  ],
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/GaryB432/eslint-plugin-gb/issues"
-  },
-  "homepage": "https://github.com/GaryB432/eslint-plugin-gb#readme",
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.9.1",
-    "eslint": "^9.9.1",
-    "globals": "^15.9.0"
-  }
-}
+{
+  "name": "eslint-plugin-gb",
+  "version": "9.2.0-beta.2",
+  "description": "ESLint rules I like",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "peerDependencies": {
+    "eslint": "^9.9.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GaryB432/eslint-plugin-gb.git"
+  },
+  "type": "module",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "eslintplugin"
+  ],
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/GaryB432/eslint-plugin-gb/issues"
+  },
+  "homepage": "https://github.com/GaryB432/eslint-plugin-gb#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2"
+  },
+  "packageManager": "pnpm@10.25.0"
+}

package/configs/flat/base.js

@@ -1,22 +0,0 @@
-const memberOrder = require("../member-order.js");
-
-module.exports = [
-  {
-    name: "gb/base/rules",
-    rules: {
-      "@typescript-eslint/explicit-member-accessibility": "warn",
-      "@typescript-eslint/explicit-module-boundary-types": "warn",
-      "@typescript-eslint/no-unused-vars": "off",
-      "@typescript-eslint/member-ordering": [
-        "warn",
-        {
-          default: {
-            memberTypes: memberOrder,
-            order: "alphabetically",
-          },
-        },
-      ],
-      "@typescript-eslint/consistent-type-imports": "warn",
-    },
-  },
-];

package/configs/flat/recommended.js

@@ -1,6 +0,0 @@
-const basePlugins = require("./base.js");
-
-module.exports = basePlugins.map((p) => ({
-  ...p,
-  name: "gb/recommended/rules",
-}));

package/test.js

@@ -1,25 +0,0 @@
-const plugin = require("./index");
-
-describe("plugin", () => {
-  it("has correct plugin names", () => {
-    expect(Object.keys(plugin.configs).sort()).toEqual([
-      "flat/base",
-      "flat/recommended",
-    ]);
-  });
-
-  it("has correct config name", () => {
-    const rec = plugin.configs["flat/recommended"];
-    expect(rec[0]).toEqual({
-      name: "gb/recommended/rules",
-      rules: expect.any(Object),
-    });
-  });
-
-  it("has correct plugin meta", () => {
-    expect(plugin.meta).toEqual({
-      name: "eslint-plugin-gb",
-      version: expect.any(String),
-    });
-  });
-});