@zintrust/governance 0.1.20

package/README.md

@@ -0,0 +1,29 @@
+# @zintrust/governance
+
+ESLint configuration and TypeScript governance setup for Zintrust projects.
+
+## Install
+
+```bash
+npm i --save-dev @zintrust/governance
+```
+
+## Usage
+
+In your `eslint.config.js`:
+
+```ts
+import { zintrust } from '@zintrust/governance';
+
+export default zintrust();
+```
+
+## Includes
+
+- TypeScript ESLint rules
+- Flat config setup
+- Best practices for Type-Safe backend development
+
+## License
+
+This package and its dependencies are MIT licensed, permitting free commercial use.

package/dist/eslint.d.ts

@@ -0,0 +1,5 @@
+export type ZintrustEslintOptions = Readonly<{
+    tsconfigPath?: string;
+    tsconfigRootDir?: string;
+}>;
+export declare function zintrustAppEslintConfig(opts?: ZintrustEslintOptions): unknown[];

package/dist/eslint.js

@@ -0,0 +1,102 @@
+import eslint from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+const DEFAULT_IGNORES = [
+    'node_modules/**',
+    'dist/**',
+    '**/dist/**',
+    'coverage/**',
+    '.git/**',
+    '.vscode/**',
+    '.idea/**',
+    '*.log',
+    '.DS_Store',
+];
+const baseLanguageGlobals = () => ({
+    languageOptions: {
+        globals: {
+            ...globals.node,
+            ...globals.es2022,
+        },
+    },
+});
+const typeAwareAppConfig = (tsconfigPath, tsconfigRootDir) => ({
+    files: ['src/**/*.ts', 'app/**/*.ts', 'routes/**/*.ts', 'config/**/*.ts', 'database/**/*.ts'],
+    languageOptions: {
+        parserOptions: {
+            project: tsconfigPath,
+            tsconfigRootDir,
+        },
+    },
+});
+const testGlobalsConfig = () => ({
+    files: ['tests/**/*.ts'],
+    languageOptions: {
+        globals: {
+            describe: 'readonly',
+            it: 'readonly',
+            test: 'readonly',
+            expect: 'readonly',
+            vi: 'readonly',
+            beforeAll: 'readonly',
+            afterAll: 'readonly',
+            beforeEach: 'readonly',
+            afterEach: 'readonly',
+        },
+    },
+    rules: {
+        'no-restricted-imports': 'off',
+        'no-empty': 'off',
+    },
+});
+const zintrustRulesConfig = () => ({
+    rules: {
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+        ],
+        '@typescript-eslint/no-explicit-any': 'error',
+        'no-console': 'error',
+        eqeqeq: ['error', 'always'],
+        'prefer-const': 'warn',
+        // Keep app code on aliases (relative imports are allowed in tests).
+        'no-restricted-imports': [
+            'error',
+            {
+                patterns: [
+                    {
+                        group: ['./*', '../*'],
+                        message: 'Please use path aliases (e.g., @app/Controllers/UserController) instead of relative imports.',
+                    },
+                ],
+            },
+        ],
+        // Avoid raw throw Error(...) in app code.
+        'no-restricted-syntax': [
+            'error',
+            {
+                selector: "ThrowStatement > NewExpression[callee.name='Error']",
+                message: 'Do not throw raw Errors. Prefer ErrorFactory.create*Error() from @zintrust/core.',
+            },
+        ],
+        // Useful but intentionally lenient by default.
+        'max-nested-callbacks': ['warn', 3],
+    },
+});
+export function zintrustAppEslintConfig(opts = {}) {
+    const tsconfigPath = opts.tsconfigPath ?? './tsconfig.json';
+    const tsconfigRootDir = opts.tsconfigRootDir ?? process.cwd();
+    return [
+        {
+            ignores: DEFAULT_IGNORES,
+        },
+        eslint.configs.recommended,
+        ...tseslint.configs.recommended,
+        ...tseslint.configs.strict,
+        baseLanguageGlobals(),
+        // Enable type-aware linting for app source.
+        typeAwareAppConfig(tsconfigPath, tsconfigRootDir),
+        testGlobalsConfig(),
+        zintrustRulesConfig(),
+    ];
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { zintrustAppEslintConfig } from './eslint';
+export type { ZintrustEslintOptions } from './eslint';

package/dist/index.js

@@ -0,0 +1 @@
+export { zintrustAppEslintConfig } from './eslint';

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@zintrust/governance",
+  "version": "0.1.20",
+  "private": false,
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./eslint": {
+      "types": "./dist/eslint.d.ts",
+      "default": "./dist/eslint.js"
+    }
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "typescript": ">=5.0.0",
+    "@zintrust/core": "^0.1.20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.0.0",
+    "globals": "^16.4.0",
+    "typescript-eslint": "^8.38.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build"
+  }
+}