@stride.it/appoint-lint-governance 0.1.0

package/README.md

@@ -0,0 +1,63 @@
+# @stride-info-tech/appoint-lint-governance
+
+Shareable ESLint **flat-config** profiles for normalizing lint rules across repositories.
+
+## MVP: TypeScript profile
+
+This package currently ships a minimal TypeScript profile to prove end-to-end packaging + consumption.
+
+Exports:
+
+- `typescriptMinimal()` — MVP profile (enables TS parsing + 1 rule)
+- `typescriptRecommended()` — optional profile that layers in TypeScript ESLint recommended presets
+
+## Install
+
+In a consumer repo:
+
+```bash
+pnpm add -D @stride-info-tech/appoint-lint-governance eslint
+```
+
+## Use in a consumer repo (ESLint v9 flat config)
+
+Create (or edit) `eslint.config.mjs`:
+
+```js
+import { typescriptMinimal } from "@stride-info-tech/appoint-lint-governance";
+
+export default [
+ ...typescriptMinimal(),
+ // overrides go last
+ {
+  rules: {
+   // example override
+   "@typescript-eslint/consistent-type-imports": "warn",
+  },
+ },
+];
+```
+
+## Local testing (before publishing to npm)
+
+From this repo:
+
+```bash
+pnpm install
+pnpm build
+npm pack
+```
+
+Then in a different repo, install the generated `.tgz`:
+
+```bash
+pnpm add -D ../appoint-lint-governance/<generated-file>.tgz
+```
+
+## Can consumer repos override rules?
+
+Yes.
+
+In flat config, **later config entries win**. So a consumer can override by adding their own config object after spreading the profile (as shown above).
+
+If you want to prevent overrides for governance reasons, ESLint itself cannot “lock” consumer rules — you’d enforce that via policy/CI (for example: validate `eslint.config.*` in consumers and fail if it sets forbidden overrides).

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { ESLint } from 'eslint';
+import * as typescript_eslint from 'typescript-eslint';
+
+/**
+ * Placeholder for future custom rules.
+ *
+ * Exporting a plugin object now keeps the package structure stable as you add
+ * domain-specific rules later.
+ */
+declare const plugin: ESLint.Plugin;
+
+type TypescriptConfigFiles = string[];
+interface TypescriptMinimalOptions {
+    files?: TypescriptConfigFiles;
+}
+/**
+ * MVP TypeScript profile.
+ *
+ * Intentionally minimal: enables TypeScript parsing and one rule to prove
+ * end-to-end packaging + consumption.
+ */
+declare function typescriptMinimal(options?: TypescriptMinimalOptions): typescript_eslint.FlatConfig.ConfigArray;
+
+interface TypescriptRecommendedOptions {
+    /**
+     * When set, enables type-aware rules (more powerful, can be slower).
+     *
+     * Recommended for mature codebases, but not required for MVP.
+     */
+    typeChecked?: boolean;
+    /**
+     * Type-aware linting requires a project TSConfig.
+     * Example: "./tsconfig.json".
+     */
+    tsconfigPath?: string | string[];
+    /**
+     * tsconfigRootDir should usually be import.meta.dirname from the consumer repo.
+     */
+    tsconfigRootDir?: string;
+    files?: string[];
+}
+declare function typescriptRecommended(options?: TypescriptRecommendedOptions): typescript_eslint.FlatConfig.ConfigArray;
+
+export { type TypescriptMinimalOptions, type TypescriptRecommendedOptions, plugin, typescriptMinimal, typescriptRecommended };

package/dist/index.js

@@ -0,0 +1,52 @@
+// src/plugin/index.ts
+var plugin = {
+  rules: {}
+};
+
+// src/configs/typescript/minimal.ts
+import tseslint from "typescript-eslint";
+function typescriptMinimal(options = {}) {
+  const files = options.files ?? ["**/*.{ts,tsx,mts,cts}"];
+  return tseslint.config(
+    {
+      files,
+      languageOptions: {
+        parserOptions: {
+          ecmaVersion: "latest",
+          sourceType: "module"
+        }
+      }
+    },
+    {
+      rules: {
+        "@typescript-eslint/consistent-type-imports": "error"
+      }
+    }
+  );
+}
+
+// src/configs/typescript/recommended.ts
+import tseslint2 from "typescript-eslint";
+function typescriptRecommended(options = {}) {
+  const files = options.files ?? ["**/*.{ts,tsx,mts,cts}"];
+  const configs = options.typeChecked ? tseslint2.configs.recommendedTypeChecked : tseslint2.configs.recommended;
+  return tseslint2.config(...configs, {
+    files,
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+        ...options.typeChecked ? {
+          project: options.tsconfigPath ?? "./tsconfig.json",
+          tsconfigRootDir: options.tsconfigRootDir
+        } : {}
+      }
+    }
+  });
+}
+export {
+  plugin,
+  typescriptMinimal,
+  typescriptRecommended
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin/index.ts","../src/configs/typescript/minimal.ts","../src/configs/typescript/recommended.ts"],"sourcesContent":["import type { ESLint } from \"eslint\";\r\n\r\n/**\r\n * Placeholder for future custom rules.\r\n *\r\n * Exporting a plugin object now keeps the package structure stable as you add\r\n * domain-specific rules later.\r\n */\r\nexport const plugin: ESLint.Plugin = {\r\n  rules: {},\r\n};\r\n","import tseslint from \"typescript-eslint\";\r\n\r\nexport type TypescriptConfigFiles = string[];\r\n\r\nexport interface TypescriptMinimalOptions {\r\n  files?: TypescriptConfigFiles;\r\n}\r\n\r\n/**\r\n * MVP TypeScript profile.\r\n *\r\n * Intentionally minimal: enables TypeScript parsing and one rule to prove\r\n * end-to-end packaging + consumption.\r\n */\r\nexport function typescriptMinimal(options: TypescriptMinimalOptions = {}) {\r\n  const files = options.files ?? [\"**/*.{ts,tsx,mts,cts}\"];\r\n\r\n  return tseslint.config(\r\n    {\r\n      files,\r\n      languageOptions: {\r\n        parserOptions: {\r\n          ecmaVersion: \"latest\",\r\n          sourceType: \"module\",\r\n        },\r\n      },\r\n    },\r\n    {\r\n      rules: {\r\n        \"@typescript-eslint/consistent-type-imports\": \"error\",\r\n      },\r\n    }\r\n  );\r\n}\r\n","import tseslint from \"typescript-eslint\";\r\n\r\nexport interface TypescriptRecommendedOptions {\r\n  /**\r\n   * When set, enables type-aware rules (more powerful, can be slower).\r\n   *\r\n   * Recommended for mature codebases, but not required for MVP.\r\n   */\r\n  typeChecked?: boolean;\r\n\r\n  /**\r\n   * Type-aware linting requires a project TSConfig.\r\n   * Example: \"./tsconfig.json\".\r\n   */\r\n  tsconfigPath?: string | string[];\r\n\r\n  /**\r\n   * tsconfigRootDir should usually be import.meta.dirname from the consumer repo.\r\n   */\r\n  tsconfigRootDir?: string;\r\n\r\n  files?: string[];\r\n}\r\n\r\nexport function typescriptRecommended(\r\n  options: TypescriptRecommendedOptions = {}\r\n) {\r\n  const files = options.files ?? [\"**/*.{ts,tsx,mts,cts}\"];\r\n\r\n  const configs = options.typeChecked\r\n    ? tseslint.configs.recommendedTypeChecked\r\n    : tseslint.configs.recommended;\r\n\r\n  return tseslint.config(...configs, {\r\n    files,\r\n    languageOptions: {\r\n      parserOptions: {\r\n        ecmaVersion: \"latest\",\r\n        sourceType: \"module\",\r\n        ...(options.typeChecked\r\n          ? {\r\n              project: options.tsconfigPath ?? \"./tsconfig.json\",\r\n              tsconfigRootDir: options.tsconfigRootDir,\r\n            }\r\n          : {}),\r\n      },\r\n    },\r\n  });\r\n}\r\n"],"mappings":";AAQO,IAAM,SAAwB;AAAA,EACnC,OAAO,CAAC;AACV;;;ACVA,OAAO,cAAc;AAcd,SAAS,kBAAkB,UAAoC,CAAC,GAAG;AACxE,QAAM,QAAQ,QAAQ,SAAS,CAAC,uBAAuB;AAEvD,SAAO,SAAS;AAAA,IACd;AAAA,MACE;AAAA,MACA,iBAAiB;AAAA,QACf,eAAe;AAAA,UACb,aAAa;AAAA,UACb,YAAY;AAAA,QACd;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,MACE,OAAO;AAAA,QACL,8CAA8C;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AACF;;;ACjCA,OAAOA,eAAc;AAwBd,SAAS,sBACd,UAAwC,CAAC,GACzC;AACA,QAAM,QAAQ,QAAQ,SAAS,CAAC,uBAAuB;AAEvD,QAAM,UAAU,QAAQ,cACpBA,UAAS,QAAQ,yBACjBA,UAAS,QAAQ;AAErB,SAAOA,UAAS,OAAO,GAAG,SAAS;AAAA,IACjC;AAAA,IACA,iBAAiB;AAAA,MACf,eAAe;AAAA,QACb,aAAa;AAAA,QACb,YAAY;AAAA,QACZ,GAAI,QAAQ,cACR;AAAA,UACE,SAAS,QAAQ,gBAAgB;AAAA,UACjC,iBAAiB,QAAQ;AAAA,QAC3B,IACA,CAAC;AAAA,MACP;AAAA,IACF;AAAA,EACF,CAAC;AACH;","names":["tseslint"]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@stride.it/appoint-lint-governance",
+  "version": "0.1.0",
+  "description": "Shareable ESLint flat-config profiles (MVP: TypeScript) for normalizing lint across repos.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "typescript-eslint": "^8.44.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.8",
+    "@vitest/coverage-v8": "^4.0.17",
+    "eslint": "^9.39.2",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run --passWithNoTests"
+  }
+}