@travetto/eslint 7.0.3 → 7.0.4

package/README.md

@@ -32,18 +32,8 @@ This is the file the linter will use, and any other tooling (e.g. IDEs).
 **Code: Sample configuration**
 ```javascript
 process.env.TRV_MANIFEST = './.trv/output/node_modules/@travetto/mono-repo';
-
-const { buildConfig } = await import('./.trv/output/node_modules/@travetto/eslint/support/bin/eslint-config.js');
-const { RuntimeIndex } = await import('./.trv/output/node_modules/@travetto/runtime/__index__.js');
-
-const pluginFiles = RuntimeIndex.find({
-  folder: folder => folder === 'support',
-  file: file => /support\/eslint[.]/.test(file.relativeFile)
-});
-const plugins = await Promise.all(pluginFiles.map(plugin => import(plugin.outputFile)))
-const config = buildConfig(plugins);
-
-export default config;
+const { rules } = await import('./.trv/output/node_modules/@travetto/eslint/support/bin/eslint-config.js');
+export { rules as default };
 ```
 
 The output is tied to whether or not you are using the [CommonJS](https://nodejs.org/api/modules.html) or [Ecmascript Module](https://nodejs.org/api/esm.html) format.
@@ -70,7 +60,7 @@ import type eslint from 'eslint';
 export type TrvEslintPlugin = {
   name: string;
   rules: Record<string, {
-    defaultLevel?: string | boolean | number;
+    defaultLevel?: Exclude<eslint.Linter.Config['rules'], undefined>[string];
     create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener;
   }>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/eslint",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "type": "module",
   "description": "ES Linting Rules",
   "keywords": [
@@ -17,7 +17,6 @@
   "main": "__index__.ts",
   "files": [
     "support",
-    "resources",
     "__index__.ts"
   ],
   "repository": {
@@ -26,16 +25,17 @@
   },
   "dependencies": {
     "@eslint/js": "^9.39.2",
-    "@stylistic/eslint-plugin": "^5.6.1",
-    "@travetto/runtime": "^7.0.3",
+    "@stylistic/eslint-plugin": "^5.7.0",
+    "@travetto/runtime": "^7.0.4",
     "@types/eslint": "^9.6.1",
-    "@typescript-eslint/eslint-plugin": "^8.51.0",
-    "@typescript-eslint/parser": "^8.51.0",
+    "@typescript-eslint/eslint-plugin": "^8.52.0",
+    "@typescript-eslint/parser": "^8.52.0",
     "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-unused-imports": "^4.3.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.0.3"
+    "@travetto/cli": "^7.0.6"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/bin/eslint-common.ts

@@ -99,7 +99,8 @@ export const IGNORES = [
   '**/.trv/**',
   '**/fixtures/**/*',
   '**/resources/**/*',
-  '**/compiler/bin/gen.*'
+  '**/ui/**',
+  '**/api-client/**'
 ];
 
 export const TS_OPTIONS = {

package/support/bin/eslint-config.ts

@@ -1,103 +1,110 @@
 import eslintJs from '@eslint/js';
+import type { Linter } from 'eslint';
 import tsEslintPlugin from '@typescript-eslint/eslint-plugin';
 import stylisticPlugin from '@stylistic/eslint-plugin';
 import unusedImports from 'eslint-plugin-unused-imports';
+import importPlugin from 'eslint-plugin-import';
 
-import { JSONUtil, Runtime } from '@travetto/runtime';
+import { castTo, JSONUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { IGNORES, GLOBALS, TS_OPTIONS } from './eslint-common.ts';
 import { STD_RULES } from './eslint-std-rules.ts';
-import { TrvEslintPlugin } from './types.ts';
+import type { TrvEslintPlugin } from './types.ts';
 
-export function buildConfig(pluginMaps: Record<string, TrvEslintPlugin>[]): readonly unknown[] {
-  const plugins: TrvEslintPlugin[] = pluginMaps.map(Object.values).flat();
-  const pluginRules: Record<string, TrvEslintPlugin['rules'][string]['defaultLevel']> = {};
-  for (const { name, rules } of plugins) {
-    for (const ruleName of Object.keys(rules)) {
-      pluginRules[`${name}/${ruleName}`] = rules[ruleName].defaultLevel ?? 'error';
-    }
+const pluginFiles = RuntimeIndex.find({
+  folder: folder => folder === 'support',
+  file: file => /support\/eslint[.]/.test(file.relativeFile)
+});
+
+const pluginMaps = await Promise.all(pluginFiles.map(plugin => import(plugin.outputFile)));
+const plugins: TrvEslintPlugin[] = pluginMaps.map(Object.values).flat();
+const pluginRules: Linter.Config['rules'] = {};
+
+for (const plugin of plugins) {
+  for (const ruleName of Object.keys(plugin.rules)) {
+    pluginRules[`${plugin.name}/${ruleName}`] = plugin.rules[ruleName].defaultLevel ?? 'error';
   }
+}
 
-  const overrides = Runtime.workspaceRelative('eslint-overrides.json');
+const overrides = Runtime.workspaceRelative('eslint-overrides.json');
 
-  const extra: (typeof STD_RULES)[] = JSONUtil.readFileSync(overrides, []);
+const extra: (typeof STD_RULES)[] = JSONUtil.readFileSync(overrides, []);
 
-  const result = [
-    eslintJs.configs.recommended,
-    { ignores: IGNORES, },
-    {
-      ...TS_OPTIONS,
-      files: ['**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts'],
-      plugins: {
-        '@stylistic': {
-          rules: stylisticPlugin.rules
-        },
-        '@typescript-eslint': {
-          rules: tsEslintPlugin.rules,
-        },
-        'unused-imports': unusedImports,
-        ...(Object.fromEntries(plugins.map(plugin => [plugin.name, plugin])))
-      },
-      rules: {
-        ...STD_RULES,
-        ...pluginRules
-      }
-    },
-    {
-      languageOptions: {
-        globals: GLOBALS,
-        ecmaVersion: 'latest',
+export const rules: Linter.Config[] = [
+  eslintJs.configs.recommended,
+  { ignores: IGNORES, },
+  {
+    ...TS_OPTIONS,
+    files: ['**/*.ts', '**/*.tsx', '**/*.cts', '**/*.mts'],
+    plugins: {
+      '@stylistic': {
+        rules: stylisticPlugin.rules
       },
-      files: ['**/*.js', '**/*.mjs', '**/*.cjs'],
-      plugins: {
-        '@stylistic': {
-          rules: stylisticPlugin.rules
-        },
-        'unused-imports': unusedImports,
+      '@typescript-eslint': {
+        rules: castTo(tsEslintPlugin.rules),
       },
-      rules: {
-        ...Object.fromEntries(Object.entries(STD_RULES).filter(rule => !rule[0].startsWith('@typescript'))),
-      }
-    },
-    {
-      files: ['**/*.ts', '**/*.tsx'],
-      rules: {
-        '@typescript-eslint/explicit-function-return-type': 'warn',
-        'no-undef': 0,
-      }
+      import: importPlugin,
+      'unused-imports': unusedImports,
+      ...(Object.fromEntries(plugins.map(plugin => [plugin.name, plugin])))
     },
-    {
-      files: ['**/DOC.ts', '**/DOC.tsx', '**/doc/**/*.ts', '**/doc/**/*.tsx'],
-      rules: {
-        'max-len': 0,
-        'no-unused-private-class-members': 0,
-        '@typescript-eslint/no-unused-vars': 0,
-        '@typescript-eslint/explicit-function-return-type': 0
-      }
-    },
-    {
-      files: [
-        'module/compiler/**/*.ts', 'module/transformer/**/*.ts',
-        '**/support/transformer/**/*.ts', '**/support/transformer/**/*.tsx',
-        '**/support/transformer.*.ts', '**/support/transformer.*.tsx',
-      ],
-      rules: {
-        'no-restricted-imports': 0
-      }
+    rules: {
+      ...STD_RULES,
+      ...pluginRules
+    }
+  },
+  {
+    languageOptions: {
+      globals: GLOBALS,
+      ecmaVersion: 'latest',
     },
-    {
-      files: ['**/test/**/*.ts', '**/test/**/*.tsx', '**/support/test/**/*.ts', '**/support/test/**/*.tsx'],
-      ignores: [...IGNORES, 'module/test/src/**'],
-      rules: {
-        '@typescript-eslint/no-unused-vars': 0,
-        '@typescript-eslint/explicit-function-return-type': 0
-      }
+    files: ['**/*.js', '**/*.mjs', '**/*.cjs'],
+    plugins: {
+      '@stylistic': {
+        rules: stylisticPlugin.rules
+      },
+      'unused-imports': unusedImports,
+      import: importPlugin,
     },
-    ...extra.map(ex => ({
-      ...TS_OPTIONS,
-      ...ex
-    }))
-  ] as const;
-
-  return result;
-}
+    rules: {
+      ...Object.fromEntries(Object.entries(STD_RULES!).filter(rule => !rule[0].startsWith('@typescript'))),
+    }
+  },
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'warn',
+      'no-undef': 0,
+    }
+  },
+  {
+    files: ['**/DOC.ts', '**/DOC.tsx', '**/doc/**/*.ts', '**/doc/**/*.tsx'],
+    rules: {
+      'max-len': 0,
+      'no-unused-private-class-members': 0,
+      '@typescript-eslint/no-unused-vars': 0,
+      '@typescript-eslint/explicit-function-return-type': 0
+    }
+  },
+  {
+    files: [
+      'module/compiler/**/*.ts', 'module/transformer/**/*.ts',
+      '**/support/transformer/**/*.ts', '**/support/transformer/**/*.tsx',
+      '**/support/transformer.*.ts', '**/support/transformer.*.tsx',
+    ],
+    rules: {
+      'no-restricted-imports': 0
+    }
+  },
+  {
+    files: ['**/test/**/*.ts', '**/test/**/*.tsx', '**/support/test/**/*.ts', '**/support/test/**/*.tsx'],
+    ignores: [...IGNORES, 'module/test/src/**'],
+    rules: {
+      '@typescript-eslint/no-unused-vars': 0,
+      '@typescript-eslint/explicit-function-return-type': 0
+    }
+  },
+  ...extra.map(ex => ({
+    ...TS_OPTIONS,
+    ...ex
+  }))
+] as const;

package/support/bin/eslint-std-rules.ts

@@ -1,4 +1,6 @@
-export const STD_RULES = {
+import type { Linter } from 'eslint';
+
+export const STD_RULES: Linter.Config['rules'] = {
   'no-loss-of-precision': 0,
   'no-unused-vars': 0,
   'no-dupe-class-members': 0,
@@ -221,5 +223,17 @@ export const STD_RULES = {
     { line: { markers: ['/'] } }
   ],
   '@typescript-eslint/no-namespace': ['error'],
-  '@typescript-eslint/consistent-type-assertions': ['warn', { assertionStyle: 'never' }]
+  '@typescript-eslint/consistent-type-assertions': ['warn', { assertionStyle: 'never' }],
+  '@typescript-eslint/consistent-type-imports': [
+    'error',
+    {
+      fixStyle: 'inline-type-imports',
+    },
+  ],
+  'import/enforce-node-protocol-usage': ['error', 'always'],
+  'import/no-self-import': ['error'],
+  'import/extensions': ['error', 'ignorePackages'],
+  'import/order': ['error', {
+    groups: ['builtin', 'external', ['parent', 'sibling']],
+  }]
 };

package/support/bin/types.ts

@@ -3,7 +3,7 @@ import type eslint from 'eslint';
 export type TrvEslintPlugin = {
   name: string;
   rules: Record<string, {
-    defaultLevel?: string | boolean | number;
+    defaultLevel?: Exclude<eslint.Linter.Config['rules'], undefined>[string];
     create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener;
   }>;
 };

package/support/cli.eslint.ts

@@ -1,7 +1,7 @@
 import { spawn } from 'node:child_process';
 
 import { Env, ExecUtil, Runtime } from '@travetto/runtime';
-import { CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
+import { type CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
 
 /**
  * Command line support for eslint

package/support/cli.eslint_register.ts

@@ -1,9 +1,7 @@
 import fs from 'node:fs/promises';
 
-import { CliCommandShape, CliCommand } from '@travetto/cli';
-import { Runtime } from '@travetto/runtime';
-
-import { buildEslintConfig } from './bin/eslint-config-file.ts';
+import { type CliCommandShape, CliCommand } from '@travetto/cli';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
 /**
  * Writes the eslint configuration file
@@ -12,7 +10,12 @@ import { buildEslintConfig } from './bin/eslint-config-file.ts';
 export class ESLintConfigureCommand implements CliCommandShape {
 
   async main(): Promise<void> {
-    const content = await buildEslintConfig();
+    const entry = RuntimeIndex.getFromImport('@travetto/eslint/support/bin/eslint-config');
+    const content = `
+process.env.TRV_MANIFEST = '${Runtime.workspaceRelative(RuntimeIndex.outputRoot, 'node_modules', Runtime.workspace.name)}';
+const { rules } = await import('${entry?.outputFile}');
+export { rules as default };
+`;
     const output = Runtime.workspaceRelative('eslint.config.js');
     await fs.writeFile(output, content.replaceAll(Runtime.workspace.path, '.').trim());
     console.log(`Wrote eslint config to ${output}`);

package/resources/eslint-config-file.js

@@ -1,13 +0,0 @@
-process.env.TRV_MANIFEST = '%MANIFEST_FILE%';
-
-const { buildConfig } = await import('@travetto/eslint/support/bin/eslint-config');
-const { RuntimeIndex } = await import('@travetto/runtime/__index__');
-
-const pluginFiles = RuntimeIndex.find({
-  folder: folder => folder === 'support',
-  file: file => /support\/eslint[.]/.test(file.relativeFile)
-});
-const plugins = await Promise.all(pluginFiles.map(plugin => import(plugin.outputFile)))
-const config = buildConfig(plugins);
-
-export default config;

package/support/bin/eslint-config-file.ts

@@ -1,21 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-import { Runtime, RuntimeIndex } from '@travetto/runtime';
-
-export async function buildEslintConfig(): Promise<string> {
-  const root = RuntimeIndex.getModule('@travetto/eslint')!.sourcePath;
-  const tpl = await fs.readFile(path.resolve(root, 'resources', 'eslint-config-file.js'), 'utf8');
-
-  // Get path to repo-root output
-  const outputPath = path.join(
-    Runtime.workspace.path,
-    RuntimeIndex.manifest.build.outputFolder,
-    'node_modules',
-    Runtime.workspace.name
-  );
-
-  return tpl
-    .replace(/'(@travetto\/[^']+)'/g, (_, mod) => `'${RuntimeIndex.resolveFileImport(mod)}'`)
-    .replace('%MANIFEST_FILE%', outputPath);
-}