eslint-plugin-ts-type-forge 0.3.1 → 0.4.0

package/README.md

@@ -16,6 +16,41 @@ configured TypeScript project is not required.
 
 ## Usage (flat config)
 
+The plugin ships a `recommended` config preset that registers the plugin and
+turns on **every** rule at `error`:
+
+```ts
+// eslint.config.mts
+import { eslintPluginTsTypeForge } from 'eslint-plugin-ts-type-forge';
+
+export default [eslintPluginTsTypeForge.configs.recommended];
+```
+
+Since the preset is a plain flat-config object, individual rules can be
+adjusted by a later config entry — for instance to pass [options](#options):
+
+```ts
+// eslint.config.mts
+import {
+    eslintPluginTsTypeForge,
+    type EslintTsTypeForgeRules,
+} from 'eslint-plugin-ts-type-forge';
+
+export default [
+    eslintPluginTsTypeForge.configs.recommended,
+    {
+        rules: {
+            'ts-type-forge/prefer-canonical-length-constrained-tuple': [
+                'error',
+                { importStyle: 'named' },
+            ],
+        } satisfies Partial<EslintTsTypeForgeRules>,
+    },
+];
+```
+
+Or register the plugin yourself and pick the rules one by one:
+
 ```ts
 // eslint.config.mts
 import {

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 export { eslintPluginTsTypeForge } from './plugin.mjs';
 export type { EslintTsTypeForgeRules, EslintTsTypeForgeRulesOption, } from './rule-types.mjs';
 export { tsTypeForgeRules } from './rules/index.mjs';
-export { type ESLintPlugin } from './types.mjs';
+export { type ESLintFlatConfig, type ESLintPlugin } from './types.mjs';
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,YAAY,EACV,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,YAAY,EACV,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/plugin.d.mts

@@ -1,3 +1,25 @@
 import { type ESLintPlugin } from './types.mjs';
-export declare const eslintPluginTsTypeForge: ESLintPlugin;
+export declare const eslintPluginTsTypeForge: {
+    readonly meta: {
+        readonly name: 'eslint-plugin-ts-type-forge';
+    };
+    readonly rules: {
+        readonly 'prefer-canonical-length-constrained-tuple': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useCanonicalTuple", readonly [(Readonly<{
+            importStyle?: 'global' | 'named';
+            maxLength?: number;
+        }> | undefined)?], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    };
+    readonly configs: {
+        /** Enables every rule of this plugin at `error`. */
+        readonly recommended: {
+            readonly name: 'ts-type-forge/recommended';
+            readonly plugins: {
+                readonly 'ts-type-forge': ESLintPlugin;
+            };
+            readonly rules: {
+                readonly 'ts-type-forge/prefer-canonical-length-constrained-tuple': 'error';
+            };
+        };
+    };
+};
 //# sourceMappingURL=plugin.d.mts.map

package/dist/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","sourceRoot":"","sources":["../src/plugin.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,eAAO,MAAM,uBAAuB,EAAE,YAK5B,CAAC"}
+{"version":3,"file":"plugin.d.mts","sourceRoot":"","sources":["../src/plugin.mts"],"names":[],"mappings":"AACA,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AA8BvE,eAAO,MAAM,uBAAuB;;iBAEhC,IAAI,EAAE,6BAA6B;;;;;;;;;QAInC,oDAAoD;iBACpD,WAAW;2BAtBP,2BAA2B;;yBAQ3B,eAAe,EAAI,YAAY;;;oFAdsB,OAAO;;;;CA8BnC,CAAC"}

package/dist/plugin.mjs

@@ -1,10 +1,32 @@
 import { tsTypeForgeRules } from './rules/rules.mjs';
 
+const recommendedRules = {
+  "ts-type-forge/prefer-canonical-length-constrained-tuple": "error"
+};
+const recommendedConfig = {
+  name: "ts-type-forge/recommended",
+  plugins: {
+    // Resolved lazily so that this config registers the *same* object that
+    // `eslintPluginTsTypeForge` refers to. ESLint rejects a plugin name that
+    // maps to two different objects with `Cannot redefine plugin`, which is
+    // what a user combining this preset with their own
+    // `plugins: { 'ts-type-forge': eslintPluginTsTypeForge }` entry would hit
+    // if the preset embedded a separate copy of the plugin.
+    get "ts-type-forge"() {
+      return eslintPluginTsTypeForge;
+    }
+  },
+  rules: recommendedRules
+};
 const eslintPluginTsTypeForge = {
   meta: {
     name: "eslint-plugin-ts-type-forge"
   },
-  rules: tsTypeForgeRules
+  rules: tsTypeForgeRules,
+  configs: {
+    /** Enables every rule of this plugin at `error`. */
+    recommended: recommendedConfig
+  }
 };
 
 export { eslintPluginTsTypeForge };

package/dist/plugin.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.mjs","sources":["../src/plugin.mts"],"sourcesContent":["import { tsTypeForgeRules } from './rules/index.mjs';\nimport { type ESLintPlugin } from './types.mjs';\n\nexport const eslintPluginTsTypeForge: ESLintPlugin = {\n  meta: {\n    name: 'eslint-plugin-ts-type-forge',\n  },\n  rules: tsTypeForgeRules,\n} as const;\n"],"names":[],"mappings":";;AAGO,MAAM,uBAAA,GAAwC;AAAA,EACnD,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM;AAAA,GACR;AAAA,EACA,KAAA,EAAO;AACT;;;;"}
+{"version":3,"file":"plugin.mjs","sources":["../src/plugin.mts"],"sourcesContent":["import { tsTypeForgeRules } from './rules/index.mjs';\nimport { type ESLintFlatConfig, type ESLintPlugin } from './types.mjs';\n\n/**\n * Every rule this plugin ships, at `error`.\n *\n * The `satisfies` clause below is keyed off {@link tsTypeForgeRules}, so adding\n * a rule without listing it here fails to type-check.\n */\nconst recommendedRules = {\n  'ts-type-forge/prefer-canonical-length-constrained-tuple': 'error',\n} as const satisfies Readonly<\n  Record<`ts-type-forge/${keyof typeof tsTypeForgeRules}`, 'error'>\n>;\n\nconst recommendedConfig = {\n  name: 'ts-type-forge/recommended',\n  plugins: {\n    // Resolved lazily so that this config registers the *same* object that\n    // `eslintPluginTsTypeForge` refers to. ESLint rejects a plugin name that\n    // maps to two different objects with `Cannot redefine plugin`, which is\n    // what a user combining this preset with their own\n    // `plugins: { 'ts-type-forge': eslintPluginTsTypeForge }` entry would hit\n    // if the preset embedded a separate copy of the plugin.\n    get 'ts-type-forge'(): ESLintPlugin {\n      return eslintPluginTsTypeForge;\n    },\n  },\n  rules: recommendedRules,\n} as const satisfies ESLintFlatConfig;\n\nexport const eslintPluginTsTypeForge = {\n  meta: {\n    name: 'eslint-plugin-ts-type-forge',\n  },\n  rules: tsTypeForgeRules,\n  configs: {\n    /** Enables every rule of this plugin at `error`. */\n    recommended: recommendedConfig,\n  },\n} as const satisfies ESLintPlugin;\n"],"names":[],"mappings":";;AASA,MAAM,gBAAA,GAAmB;AAAA,EACvB,yDAAA,EAA2D;AAC7D,CAAA;AAIA,MAAM,iBAAA,GAAoB;AAAA,EACxB,IAAA,EAAM,2BAAA;AAAA,EACN,OAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOP,IAAI,eAAA,GAAgC;AAClC,MAAA,OAAO,uBAAA;AAAA,IACT;AAAA,GACF;AAAA,EACA,KAAA,EAAO;AACT,CAAA;AAEO,MAAM,uBAAA,GAA0B;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM;AAAA,GACR;AAAA,EACA,KAAA,EAAO,gBAAA;AAAA,EACP,OAAA,EAAS;AAAA;AAAA,IAEP,WAAA,EAAa;AAAA;AAEjB;;;;"}

package/dist/types.d.mts

@@ -1,4 +1,5 @@
 import { type TSESLint } from '@typescript-eslint/utils';
 import { type DeepReadonly } from 'ts-type-forge';
 export type ESLintPlugin = DeepReadonly<TSESLint.FlatConfig.Plugin>;
+export type ESLintFlatConfig = DeepReadonly<TSESLint.FlatConfig.Config>;
 //# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAEpE,MAAM,MAAM,gBAAgB,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-ts-type-forge",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "private": false,
   "description": "ESLint rules that steer type declarations toward ts-type-forge idioms.",
   "keywords": [
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "@typescript-eslint/utils": "8.65.0",
-    "ts-type-forge": "8.0.0"
+    "ts-type-forge": "8.1.0"
   },
   "devDependencies": {
     "@typescript-eslint/parser": "8.65.0",

package/src/index.mts

@@ -4,4 +4,4 @@ export type {
   EslintTsTypeForgeRulesOption,
 } from './rule-types.mjs';
 export { tsTypeForgeRules } from './rules/index.mjs';
-export { type ESLintPlugin } from './types.mjs';
+export { type ESLintFlatConfig, type ESLintPlugin } from './types.mjs';

package/src/plugin.mts

@@ -1,9 +1,41 @@
 import { tsTypeForgeRules } from './rules/index.mjs';
-import { type ESLintPlugin } from './types.mjs';
+import { type ESLintFlatConfig, type ESLintPlugin } from './types.mjs';
 
-export const eslintPluginTsTypeForge: ESLintPlugin = {
+/**
+ * Every rule this plugin ships, at `error`.
+ *
+ * The `satisfies` clause below is keyed off {@link tsTypeForgeRules}, so adding
+ * a rule without listing it here fails to type-check.
+ */
+const recommendedRules = {
+  'ts-type-forge/prefer-canonical-length-constrained-tuple': 'error',
+} as const satisfies Readonly<
+  Record<`ts-type-forge/${keyof typeof tsTypeForgeRules}`, 'error'>
+>;
+
+const recommendedConfig = {
+  name: 'ts-type-forge/recommended',
+  plugins: {
+    // Resolved lazily so that this config registers the *same* object that
+    // `eslintPluginTsTypeForge` refers to. ESLint rejects a plugin name that
+    // maps to two different objects with `Cannot redefine plugin`, which is
+    // what a user combining this preset with their own
+    // `plugins: { 'ts-type-forge': eslintPluginTsTypeForge }` entry would hit
+    // if the preset embedded a separate copy of the plugin.
+    get 'ts-type-forge'(): ESLintPlugin {
+      return eslintPluginTsTypeForge;
+    },
+  },
+  rules: recommendedRules,
+} as const satisfies ESLintFlatConfig;
+
+export const eslintPluginTsTypeForge = {
   meta: {
     name: 'eslint-plugin-ts-type-forge',
   },
   rules: tsTypeForgeRules,
-} as const;
+  configs: {
+    /** Enables every rule of this plugin at `error`. */
+    recommended: recommendedConfig,
+  },
+} as const satisfies ESLintPlugin;

package/src/plugin.test.mts

@@ -0,0 +1,24 @@
+import { eslintPluginTsTypeForge } from './plugin.mjs';
+import { tsTypeForgeRules } from './rules/index.mjs';
+
+describe('eslintPluginTsTypeForge.configs.recommended', () => {
+  const recommended = eslintPluginTsTypeForge.configs.recommended;
+
+  test('enables every rule of the plugin, and nothing else, at "error"', () => {
+    assert.deepStrictEqual(
+      recommended.rules,
+      Object.fromEntries(
+        Object.keys(tsTypeForgeRules).map((name) => [
+          `ts-type-forge/${name}`,
+          'error',
+        ]),
+      ),
+    );
+  });
+
+  test('registers the exported plugin object itself', () => {
+    // Registering a *copy* would make `Cannot redefine plugin` errors possible
+    // for users who also list the plugin in their own `plugins` record.
+    expect(recommended.plugins['ts-type-forge']).toBe(eslintPluginTsTypeForge);
+  });
+});

package/src/types.mts

@@ -2,3 +2,5 @@ import { type TSESLint } from '@typescript-eslint/utils';
 import { type DeepReadonly } from 'ts-type-forge';
 
 export type ESLintPlugin = DeepReadonly<TSESLint.FlatConfig.Plugin>;
+
+export type ESLintFlatConfig = DeepReadonly<TSESLint.FlatConfig.Config>;