eslint-plugin-ts-fortress 0.3.0 → 0.4.0

package/README.md

@@ -15,6 +15,39 @@ 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 { eslintPluginTsFortress } from 'eslint-plugin-ts-fortress';
+
+export default [eslintPluginTsFortress.configs.recommended];
+```
+
+Since the preset is a plain flat-config object, individual rules can be
+adjusted by a later config entry:
+
+```ts
+// eslint.config.mts
+import {
+    eslintPluginTsFortress,
+    type EslintTsFortressRules,
+} from 'eslint-plugin-ts-fortress';
+
+export default [
+    eslintPluginTsFortress.configs.recommended,
+    {
+        files: ['src/legacy/**'],
+        rules: {
+            'ts-fortress/prefer-canonical-length-constrained-type': 'off',
+        } satisfies Partial<EslintTsFortressRules>,
+    },
+];
+```
+
+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 { eslintPluginTsFortress } from './plugin.mjs';
 export type { EslintTsFortressRules, EslintTsFortressRulesOption, } from './rule-types.mjs';
 export { tsFortressRules } 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,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,YAAY,EACV,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,YAAY,EACV,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/plugin.d.mts

@@ -1,3 +1,22 @@
 import { type ESLintPlugin } from './types.mjs';
-export declare const eslintPluginTsFortress: ESLintPlugin;
+export declare const eslintPluginTsFortress: {
+    readonly meta: {
+        readonly name: 'eslint-plugin-ts-fortress';
+    };
+    readonly rules: {
+        readonly 'prefer-canonical-length-constrained-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useCanonicalType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    };
+    readonly configs: {
+        /** Enables every rule of this plugin at `error`. */
+        readonly recommended: {
+            readonly name: 'ts-fortress/recommended';
+            readonly plugins: {
+                readonly 'ts-fortress': ESLintPlugin;
+            };
+            readonly rules: {
+                readonly 'ts-fortress/prefer-canonical-length-constrained-type': '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,sBAAsB,EAAE,YAK3B,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,sBAAsB;;iBAE/B,IAAI,EAAE,2BAA2B;;;;;;QAIjC,oDAAoD;iBACpD,WAAW;2BAtBP,yBAAyB;;yBAQzB,aAAa,EAAI,YAAY;;;iFAdqB,OAAO;;;;CA8BhC,CAAC"}

package/dist/plugin.mjs

@@ -1,10 +1,32 @@
 import { tsFortressRules } from './rules/rules.mjs';
 
+const recommendedRules = {
+  "ts-fortress/prefer-canonical-length-constrained-type": "error"
+};
+const recommendedConfig = {
+  name: "ts-fortress/recommended",
+  plugins: {
+    // Resolved lazily so that this config registers the *same* object that
+    // `eslintPluginTsFortress` 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-fortress': eslintPluginTsFortress }` entry would hit if
+    // the preset embedded a separate copy of the plugin.
+    get "ts-fortress"() {
+      return eslintPluginTsFortress;
+    }
+  },
+  rules: recommendedRules
+};
 const eslintPluginTsFortress = {
   meta: {
     name: "eslint-plugin-ts-fortress"
   },
-  rules: tsFortressRules
+  rules: tsFortressRules,
+  configs: {
+    /** Enables every rule of this plugin at `error`. */
+    recommended: recommendedConfig
+  }
 };
 
 export { eslintPluginTsFortress };

package/dist/plugin.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.mjs","sources":["../src/plugin.mts"],"sourcesContent":["import { tsFortressRules } from './rules/index.mjs';\nimport { type ESLintPlugin } from './types.mjs';\n\nexport const eslintPluginTsFortress: ESLintPlugin = {\n  meta: {\n    name: 'eslint-plugin-ts-fortress',\n  },\n  rules: tsFortressRules,\n} as const;\n"],"names":[],"mappings":";;AAGO,MAAM,sBAAA,GAAuC;AAAA,EAClD,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM;AAAA,GACR;AAAA,EACA,KAAA,EAAO;AACT;;;;"}
+{"version":3,"file":"plugin.mjs","sources":["../src/plugin.mts"],"sourcesContent":["import { tsFortressRules } 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 tsFortressRules}, so adding\n * a rule without listing it here fails to type-check.\n */\nconst recommendedRules = {\n  'ts-fortress/prefer-canonical-length-constrained-type': 'error',\n} as const satisfies Readonly<\n  Record<`ts-fortress/${keyof typeof tsFortressRules}`, 'error'>\n>;\n\nconst recommendedConfig = {\n  name: 'ts-fortress/recommended',\n  plugins: {\n    // Resolved lazily so that this config registers the *same* object that\n    // `eslintPluginTsFortress` 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-fortress': eslintPluginTsFortress }` entry would hit if\n    // the preset embedded a separate copy of the plugin.\n    get 'ts-fortress'(): ESLintPlugin {\n      return eslintPluginTsFortress;\n    },\n  },\n  rules: recommendedRules,\n} as const satisfies ESLintFlatConfig;\n\nexport const eslintPluginTsFortress = {\n  meta: {\n    name: 'eslint-plugin-ts-fortress',\n  },\n  rules: tsFortressRules,\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,sDAAA,EAAwD;AAC1D,CAAA;AAIA,MAAM,iBAAA,GAAoB;AAAA,EACxB,IAAA,EAAM,yBAAA;AAAA,EACN,OAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOP,IAAI,aAAA,GAA8B;AAChC,MAAA,OAAO,sBAAA;AAAA,IACT;AAAA,GACF;AAAA,EACA,KAAA,EAAO;AACT,CAAA;AAEO,MAAM,sBAAA,GAAyB;AAAA,EACpC,IAAA,EAAM;AAAA,IACJ,IAAA,EAAM;AAAA,GACR;AAAA,EACA,KAAA,EAAO,eAAA;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-fortress",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "private": false,
   "description": "ESLint rules that steer schema definitions toward ts-fortress idioms.",
   "keywords": [

package/src/index.mts

@@ -4,4 +4,4 @@ export type {
   EslintTsFortressRulesOption,
 } from './rule-types.mjs';
 export { tsFortressRules } 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 { tsFortressRules } from './rules/index.mjs';
-import { type ESLintPlugin } from './types.mjs';
+import { type ESLintFlatConfig, type ESLintPlugin } from './types.mjs';
 
-export const eslintPluginTsFortress: ESLintPlugin = {
+/**
+ * Every rule this plugin ships, at `error`.
+ *
+ * The `satisfies` clause below is keyed off {@link tsFortressRules}, so adding
+ * a rule without listing it here fails to type-check.
+ */
+const recommendedRules = {
+  'ts-fortress/prefer-canonical-length-constrained-type': 'error',
+} as const satisfies Readonly<
+  Record<`ts-fortress/${keyof typeof tsFortressRules}`, 'error'>
+>;
+
+const recommendedConfig = {
+  name: 'ts-fortress/recommended',
+  plugins: {
+    // Resolved lazily so that this config registers the *same* object that
+    // `eslintPluginTsFortress` 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-fortress': eslintPluginTsFortress }` entry would hit if
+    // the preset embedded a separate copy of the plugin.
+    get 'ts-fortress'(): ESLintPlugin {
+      return eslintPluginTsFortress;
+    },
+  },
+  rules: recommendedRules,
+} as const satisfies ESLintFlatConfig;
+
+export const eslintPluginTsFortress = {
   meta: {
     name: 'eslint-plugin-ts-fortress',
   },
   rules: tsFortressRules,
-} 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 { eslintPluginTsFortress } from './plugin.mjs';
+import { tsFortressRules } from './rules/index.mjs';
+
+describe('eslintPluginTsFortress.configs.recommended', () => {
+  const recommended = eslintPluginTsFortress.configs.recommended;
+
+  test('enables every rule of the plugin, and nothing else, at "error"', () => {
+    assert.deepStrictEqual(
+      recommended.rules,
+      Object.fromEntries(
+        Object.keys(tsFortressRules).map((name) => [
+          `ts-fortress/${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-fortress']).toBe(eslintPluginTsFortress);
+  });
+});

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>;