@travetto/eslint 3.4.3 → 4.0.0-rc.1

package/README.md

@@ -32,11 +32,14 @@ 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/eslint';
+
 const { buildConfig } = require('./.trv/output/node_modules/@travetto/eslint/support/bin/eslint-config.js');
-const { RootIndex } = require('./.trv/output/node_modules/@travetto/manifest/__index__.js');
-const pluginFiles = RootIndex.find({ folder: f => f === 'support', file: f => /support\/eslint[.]/.test(f) });
+const { RuntimeIndex } = require('./.trv/output/node_modules/@travetto/manifest/__index__.js');
+
+const pluginFiles = RuntimeIndex.find({ folder: f => f === 'support', file: f => /support\/eslint[.]/.test(f) });
 const plugins = pluginFiles.map(x => require(x.outputFile));
 const config = buildConfig(plugins);
+
 module.exports = config;
 ```
 
@@ -80,9 +83,9 @@ import { Program, BaseExpression, Expression } from 'estree';
 import type { TrvEslintPlugin } from '@travetto/eslint';
 
 const groupTypeMap = {
-  node: ['node', 'travetto', 'local'],
-  travetto: ['travetto', 'local'],
-  local: ['local'],
+  node: ['node', 'travetto', 'workspace'],
+  travetto: ['travetto', 'workspace'],
+  workspace: ['workspace'],
 };
 
 interface TSAsExpression extends BaseExpression {
@@ -140,9 +143,9 @@ export const ImportOrder: TrvEslintPlugin = {
               continue;
             }
 
-            const lineType: typeof groupType = /^@travetto/.test(from) ? 'travetto' : /^[^.]/.test(from) ? 'node' : 'local';
+            const lineType: typeof groupType = /^@travetto/.test(from) ? 'travetto' : /^[^.]/.test(from) ? 'node' : 'workspace';
 
-            if (/module\/[^/]+\/doc\//.test(context.getFilename()) && lineType === 'local' && from.startsWith('..')) {
+            if (/module\/[^/]+\/doc\//.test(context.getFilename()) && lineType === 'workspace' && from.startsWith('..')) {
               context.report({ message: 'Doc does not support parent imports', node });
             }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/eslint",
-  "version": "3.4.3",
+  "version": "4.0.0-rc.1",
   "description": "ES Linting Rules",
   "keywords": [
     "eslint",
@@ -16,6 +16,7 @@
   "main": "__index__.ts",
   "files": [
     "support",
+    "resources",
     "__index__.ts"
   ],
   "repository": {
@@ -23,17 +24,17 @@
     "directory": "module/eslint"
   },
   "dependencies": {
-    "@eslint/js": "^8.52.0",
-    "@travetto/manifest": "^3.4.0",
-    "@types/eslint": "^8.44.7",
+    "@eslint/js": "^8.56.0",
+    "@travetto/manifest": "^4.0.0-rc.1",
+    "@types/eslint": "^8.56.2",
     "@types/eslint__js": "^8.42.3",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
-    "eslint": "^8.54.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-unused-imports": "^3.0.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.4.6"
+    "@travetto/cli": "^4.0.0-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/resources/eslint-config-file.cjs

@@ -0,0 +1,10 @@
+process.env.TRV_MANIFEST = '%MANIFEST_FILE%';
+
+const { buildConfig } = require('@travetto/eslint/support/bin/eslint-config');
+const { RuntimeIndex } = require('@travetto/manifest/__index__');
+
+const pluginFiles = RuntimeIndex.find({ folder: f => f === 'support', file: f => /support\/eslint[.]/.test(f) });
+const plugins = pluginFiles.map(x => require(x.outputFile));
+const config = buildConfig(plugins);
+
+module.exports = config;

package/resources/eslint-config-file.mjs

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

package/support/bin/eslint-common.ts

@@ -1,11 +1,11 @@
 import * as parser from '@typescript-eslint/parser';
 
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 
 export const RULE_COMMON = {
   languageOptions: {
     ecmaVersion: 'latest',
-    sourceType: RootIndex.manifest.moduleType,
+    sourceType: RuntimeContext.workspace.type,
     globals: {
       AbortController: false,
       AbortSignal: false,

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

@@ -1,39 +1,13 @@
-import path from 'path';
+import fs from 'node:fs/promises';
 
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeContext, RuntimeIndex, path } from '@travetto/manifest';
 
-export function buildEslintConfig(): string {
-  const rulesImp = RootIndex.resolveFileImport('@travetto/eslint/support/bin/eslint-config.ts');
-  const manifestImp = RootIndex.resolveFileImport('@travetto/manifest/__index__.ts');
-  const manifestFile = RootIndex.mainModule.outputPath;
+export async function buildEslintConfig(): Promise<string> {
+  const root = RuntimeIndex.getModule('@travetto/eslint')!.sourcePath;
+  const ext = RuntimeContext.workspace.type === 'commonjs' ? '.cjs' : '.mjs';
+  const tpl = await fs.readFile(path.resolve(root, 'resources', `eslint-config-file${ext}`), 'utf8');
 
-  const common = {
-    manifest: `process.env.TRV_MANIFEST = '${path.resolve(manifestFile)}'`,
-    pluginFiles: "const pluginFiles = RootIndex.find({ folder: f => f === 'support', file: f => /support\\/eslint[.]/.test(f) })",
-    build: 'const config = buildConfig(plugins)',
-  };
-
-  const lines = RootIndex.manifest.moduleType === 'commonjs' ?
-    [
-      common.manifest,
-      `const { buildConfig } = require('${rulesImp}')`,
-      `const { RootIndex } = require('${manifestImp}')`,
-      common.pluginFiles,
-      'const plugins = pluginFiles.map(x => require(x.outputFile))',
-      common.build,
-      'module.exports = config',
-      ''
-    ] :
-    [
-      common.manifest,
-      `const { buildConfig } = await import('${rulesImp}')`,
-      `const { RootIndex } = await import('${manifestImp}')`,
-      common.pluginFiles,
-      'const plugins = await Promise.all(pluginFiles.map(x => import(x.outputFile)))',
-      common.build,
-      'export default config',
-      ''
-    ];
-
-  return lines.join(';\n');
+  return tpl
+    .replace(/'(@travetto\/[^']+)'/g, (_, v) => `'${RuntimeIndex.resolveFileImport(v)}'`)
+    .replace('%MANIFEST_FILE%', RuntimeIndex.mainModule.outputPath);
 }

package/support/bin/eslint-config.ts

@@ -1,10 +1,11 @@
+import { existsSync, readFileSync } from 'node:fs';
+
 // @ts-expect-error
 import * as unused from 'eslint-plugin-unused-imports';
 import { configs } from '@eslint/js';
 import * as tsEslintPlugin from '@typescript-eslint/eslint-plugin';
-import { existsSync, readFileSync } from 'fs';
 
-import { path, RootIndex } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 
 import { IGNORES, RULE_COMMON } from './eslint-common';
 import { STD_RULES } from './eslint-std-rules';
@@ -19,7 +20,7 @@ export function buildConfig(pluginMaps: Record<string, TrvEslintPlugin>[]): read
     }
   }
 
-  const overrides = path.resolve(RootIndex.manifest.workspacePath, 'eslint-overrides.json');
+  const overrides = RuntimeContext.workspaceRelative('eslint-overrides.json');
 
   const extra: (typeof STD_RULES)[] = existsSync(overrides) ? JSON.parse(readFileSync(overrides, 'utf8')) : [];
 

package/support/cli.lint.ts

@@ -1,5 +1,7 @@
-import { RootIndex } from '@travetto/manifest';
-import { ExecUtil, defineEnv } from '@travetto/base';
+import { spawn } from 'node:child_process';
+
+import { RuntimeContext } from '@travetto/manifest';
+import { Env, ExecUtil } from '@travetto/base';
 import { CliCommandShape, CliCommand, CliModuleUtil, CliScmUtil } from '@travetto/cli';
 
 /**
@@ -18,7 +20,7 @@ export class LintCommand implements CliCommandShape {
   since?: string;
 
   preMain(): void {
-    defineEnv({ debug: false });
+    Env.DEBUG.set(false);
   }
 
   async main(): Promise<void> {
@@ -28,19 +30,19 @@ export class LintCommand implements CliCommandShape {
         .filter(x => !x.endsWith('package.json') && !x.endsWith('package-lock.json'));
     } else {
       const mods = await CliModuleUtil.findModules(this.changed ? 'changed' : 'all');
-      files = mods.filter(x => x.local).map(x => x.sourcePath);
+      files = mods.filter(x => x.workspace).map(x => x.sourcePath);
     }
 
 
-    const res = await ExecUtil.spawn('npx', [
+    const res = await ExecUtil.getResult(spawn('npx', [
       'eslint',
       ...(this.format ? ['--format', this.format] : []),
       ...files
     ], {
-      cwd: RootIndex.manifest.workspacePath,
+      cwd: RuntimeContext.workspace.path,
       stdio: 'inherit',
-      catchAsResult: true
-    }).result;
+      shell: false
+    }), { catch: true });
 
     process.exitCode = res.code;
   }

package/support/cli.lint_register.ts

@@ -1,7 +1,7 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 import { CliCommandShape, CliCommand } from '@travetto/cli';
-import { path, RootIndex } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 
 import { buildEslintConfig } from './bin/eslint-config-file';
 
@@ -12,9 +12,9 @@ import { buildEslintConfig } from './bin/eslint-config-file';
 export class LintConfigureCommand implements CliCommandShape {
 
   async main(): Promise<void> {
-    const content = buildEslintConfig();
-    const output = path.resolve(RootIndex.manifest.workspacePath, 'eslint.config.js');
-    await fs.writeFile(output, content.replaceAll(RootIndex.manifest.workspacePath, '.').trim());
+    const content = await buildEslintConfig();
+    const output = RuntimeContext.workspaceRelative('eslint.config.js');
+    await fs.writeFile(output, content.replaceAll(RuntimeContext.workspace.path, '.').trim());
 
     console.log(`Wrote eslint config to ${output}`);
   }