@travetto/eslint 3.0.0-rc.11

package/README.md

@@ -0,0 +1,9 @@
+<!-- This file was generated by @travetto/doc and should not be modified directly -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/eslint-plugin/DOC.ts and execute "npx trv doc" to rebuild -->
+# ES Linting Rules
+## ES Linting Rules
+
+**Install: @travetto/eslint-plugin**
+```bash
+npm install @travetto/eslint-plugin
+```

package/__index__.ts

@@ -0,0 +1 @@
+export * from './support/bin/types';

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@travetto/eslint",
+  "version": "3.0.0-rc.11",
+  "description": "ES Linting Rules",
+  "keywords": [
+    "eslint",
+    "travetto",
+    "typescript"
+  ],
+  "homepage": "https://travetto.io",
+  "license": "MIT",
+  "author": {
+    "email": "travetto.framework@gmail.com",
+    "name": "Travetto Framework"
+  },
+  "main": "__index__.ts",
+  "files": [
+    "support",
+    "__index__.ts"
+  ],
+  "repository": {
+    "url": "https://github.com/travetto/travetto.git",
+    "directory": "module/eslint"
+  },
+  "dependencies": {
+    "@travetto/manifest": "^3.0.0-rc.12",
+    "@types/eslint": "^8.21.1",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.52.0",
+    "eslint": "^8.34.0",
+    "eslint-plugin-unused-imports": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@travetto/cli": "^3.0.0-rc.14"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/cli": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "ES Linting Rules"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/support/bin/eslint-common.ts

@@ -0,0 +1,113 @@
+import * as parser from '@typescript-eslint/parser';
+
+import { RootIndex } from '@travetto/manifest';
+
+export const RULE_COMMON = {
+  languageOptions: {
+    ecmaVersion: 'latest',
+    sourceType: RootIndex.manifest.moduleType,
+    globals: {
+      AbortController: false,
+      AbortSignal: false,
+      AggregateError: false,
+      Array: false,
+      ArrayBuffer: false,
+      Atomics: false,
+      BigInt: false,
+      BigInt64Array: false,
+      BigUint64Array: false,
+      Boolean: false,
+      Buffer: false,
+      clearImmediate: false,
+      clearInterval: false,
+      clearTimeout: false,
+      console: false,
+      DataView: false,
+      Date: false,
+      decodeURI: false,
+      decodeURIComponent: false,
+      DOMException: false,
+      encodeURI: false,
+      encodeURIComponent: false,
+      Error: false,
+      EvalError: false,
+      Event: false,
+      EventTarget: false,
+      fetch: false,
+      FinalizationRegistry: false,
+      Float32Array: false,
+      Float64Array: false,
+      FormData: false,
+      Function: false,
+      global: false,
+      globalThis: false,
+      Headers: false,
+      Infinity: false,
+      Int16Array: false,
+      Int32Array: false,
+      Int8Array: false,
+      Intl: false,
+      isFinite: false,
+      isNaN: false,
+      JSON: false,
+      Map: false,
+      Math: false,
+      MessageChannel: false,
+      MessageEvent: false,
+      MessagePort: false,
+      NaN: false,
+      Number: false,
+      Object: false,
+      parseFloat: false,
+      parseInt: false,
+      performance: false,
+      process: false,
+      Promise: false,
+      propertyIsEnumerable: false,
+      Proxy: false,
+      queueMicrotask: false,
+      RangeError: false,
+      ReferenceError: false,
+      Reflect: false,
+      RegExp: false,
+      Request: false,
+      require: false,
+      Response: false,
+      Set: false,
+      setImmediate: false,
+      setInterval: false,
+      setTimeout: false,
+      SharedArrayBuffer: false,
+      String: false,
+      structuredClone: false,
+      Symbol: false,
+      SyntaxError: false,
+      TextDecoder: false,
+      TextEncoder: false,
+      TypeError: false,
+      Uint16Array: false,
+      Uint32Array: false,
+      Uint8Array: false,
+      Uint8ClampedArray: false,
+      undefined: false,
+      unescape: false,
+      URIError: false,
+      WeakMap: false,
+      WeakRef: false,
+      WeakSet: false,
+    },
+    parser,
+    parserOptions: {
+      project: 'tsconfig.json'
+    },
+  },
+};
+
+export const IGNORES = [
+  'node_modules/**/*',
+  'dist/**/*',
+  'out/**/*',
+  '**/*.d.ts',
+  '**/fixtures/**/*',
+  '**/resources/**/*'
+];

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

@@ -0,0 +1,39 @@
+import path from 'path';
+
+import { RootIndex } 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;
+
+  const common = {
+    manifest: `process.env.TRV_MANIFEST = '${path.resolve(manifestFile)}'`,
+    pluginFiles: 'const pluginFiles = RootIndex.findSupport({ filter: 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');
+}

package/support/bin/eslint-config.ts

@@ -0,0 +1,86 @@
+// @ts-expect-error
+import * as unused from 'eslint-plugin-unused-imports';
+import * as tsEslintPlugin from '@typescript-eslint/eslint-plugin';
+import { existsSync, readFileSync } from 'fs';
+
+import { path, RootIndex } from '@travetto/manifest';
+
+import { IGNORES, RULE_COMMON } from './eslint-common';
+import { STD_RULES } from './eslint-std-rules';
+import { TrvEslintPlugin } from './types';
+
+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 overrides = path.resolve(RootIndex.manifest.workspacePath, 'eslint-overrides.json');
+
+  const extra: (typeof STD_RULES)[] = existsSync(overrides) ? JSON.parse(readFileSync(overrides, 'utf8')) : [];
+
+  const result = [
+    'eslint:recommended',
+    { ignores: IGNORES, },
+    {
+      ...RULE_COMMON,
+      files: ['**/*.ts', '**/*.js'],
+      plugins: {
+        '@typescript-eslint': {
+          rules: tsEslintPlugin.rules,
+        },
+        'unused-imports': {
+          rules: unused.rules,
+        },
+        ...(Object.fromEntries(plugins.map(x => [x.name, x])))
+      },
+      rules: {
+        ...STD_RULES,
+        ...pluginRules
+      }
+    },
+    {
+      ...RULE_COMMON,
+      files: ['**/*.ts'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'warn',
+        'no-undef': 0,
+      }
+    },
+    {
+      ...RULE_COMMON,
+      files: ['**/DOC.ts', '**/doc/**/*.ts'],
+      rules: {
+        'max-len': 0,
+        '@typescript-eslint/quotes': 'warn',
+        '@typescript-eslint/indent': 0,
+        '@typescript-eslint/consistent-type-assertions': 0,
+        '@typescript-eslint/explicit-function-return-type': 0
+      }
+    },
+    {
+      ...RULE_COMMON,
+      files: ['module/compiler/**/*.ts', 'module/transformer/**/*.ts', '**/support/transform*.ts', '**/support/transformer.*.ts'],
+      rules: {
+        'no-restricted-imports': 0
+      }
+    },
+    {
+      ...RULE_COMMON,
+      files: ['**/test/**/*.ts', '**/support/test/**/*.ts'],
+      rules: {
+        '@typescript-eslint/consistent-type-assertions': 0,
+        '@typescript-eslint/explicit-function-return-type': 0
+      }
+    },
+    ...extra.map(ex => ({
+      ...RULE_COMMON,
+      ...ex
+    }))
+  ] as const;
+
+  return result;
+}

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

@@ -0,0 +1,219 @@
+export const STD_RULES = {
+  'no-loss-of-precision': 0,
+  'unused-imports/no-unused-imports': 'error',
+  'no-unused-vars': 0,
+  'no-dupe-class-members': 0,
+  '@typescript-eslint/array-type': 'error',
+  '@typescript-eslint/explicit-function-return-type': 0,
+  '@typescript-eslint/no-non-null-assertion': 0,
+  '@typescript-eslint/no-explicit-any': 'warn',
+  '@typescript-eslint/explicit-member-accessibility': [0, { accessibility: 'explicit' }],
+  indent: 0,
+  '@typescript-eslint/indent': [
+    'error',
+    2,
+    {
+      ignoredNodes: [
+        'PropertyDefinition[decorators]',
+        'TSUnionType',
+        'TSTypeParameterInstantiation',
+        'FunctionExpression > .params[decorators.length > 0]',
+        'FunctionExpression > .params > :matches(Decorator, :not(:first-child))',
+        'ClassBody.body > PropertyDefinition[decorators.length > 0] > .key'
+      ],
+      SwitchCase: 1
+    }
+  ],
+  '@typescript-eslint/member-delimiter-style': [
+    'error',
+    {
+      multiline: { delimiter: 'semi', requireLast: true },
+      singleline: { delimiter: 'comma', requireLast: false }
+    }
+  ],
+  'no-restricted-imports': ['error', { paths: ['typescript'] }],
+  '@typescript-eslint/no-use-before-define': ['error', { classes: false }],
+  '@typescript-eslint/member-ordering': [
+    'error',
+    {
+      default: [
+        'private-static-field',
+        'protected-static-field',
+        'public-static-field',
+        'private-static-method',
+        'protected-static-method',
+        'public-static-method',
+        'private-instance-field',
+        'protected-instance-field',
+        'public-instance-field',
+        'private-constructor',
+        'protected-constructor',
+        'public-constructor',
+        'private-instance-method',
+        'protected-instance-method',
+        'public-instance-method'
+      ]
+    }
+  ],
+  '@typescript-eslint/no-var-requires': 0,
+  '@typescript-eslint/no-empty-function': 0,
+  '@typescript-eslint/no-for-in-array': 'error',
+  '@typescript-eslint/no-inferrable-types': 0,
+  '@typescript-eslint/no-this-alias': 'error',
+  'require-atomic-updates': 0,
+  '@typescript-eslint/no-unused-vars': [
+    'error',
+    { varsIgnorePattern: '^(_|[A-Z])[A-Za-z0-9]*', args: 'none' }
+  ],
+  '@typescript-eslint/quotes': [
+    'error',
+    'single',
+    { avoidEscape: true, allowTemplateLiterals: false }
+  ],
+  '@typescript-eslint/semi': [
+    'error',
+    'always'
+  ],
+  '@typescript-eslint/no-empty-interface': 0,
+  '@typescript-eslint/triple-slash-reference': 0,
+  '@typescript-eslint/interface-name-prefix': 0,
+  'no-case-declarations': [
+    'error'
+  ],
+  'no-ex-assign': 0,
+  '@typescript-eslint/ban-types': 0,
+  '@typescript-eslint/ban-ts-comment': 0,
+  '@typescript-eslint/type-annotation-spacing': 'error',
+  '@typescript-eslint/explicit-module-boundary-types': 0,
+  'arrow-body-style': ['error', 'as-needed'],
+  '@typescript-eslint/naming-convention': [
+    'error',
+    {
+      selector: 'default',
+      format: ['camelCase']
+    },
+    {
+      selector: 'parameter',
+      format: [],
+      filter: { regex: '^__', match: true }
+    },
+    {
+      selector: 'variable',
+      format: [],
+      filter: { regex: '^__', match: true }
+    },
+    {
+      selector: 'property',
+      format: [
+        'camelCase',
+        'UPPER_CASE',
+        'PascalCase',
+        'snake_case'
+      ],
+      leadingUnderscore: 'allow'
+    },
+    {
+      selector: 'variable',
+      format: [
+        'camelCase',
+        'UPPER_CASE',
+        'PascalCase'
+      ],
+      leadingUnderscore: 'allow'
+    },
+    {
+      selector: 'method',
+      format: [
+        'camelCase',
+        'UPPER_CASE',
+        'PascalCase'
+      ],
+      leadingUnderscore: 'allow'
+    },
+    {
+      selector: 'parameter',
+      format: ['camelCase'],
+      leadingUnderscore: 'allow'
+    },
+    {
+      selector: 'typeLike',
+      format: ['PascalCase']
+    },
+    {
+      selector: 'function',
+      format: ['PascalCase', 'camelCase']
+    },
+    {
+      selector: 'objectLiteralProperty',
+      modifiers: ['requiresQuotes'],
+      format: null,
+      custom: { regex: '.*', match: true }
+    },
+    {
+      selector: 'objectLiteralMethod',
+      modifiers: ['requiresQuotes'],
+      format: null,
+      custom: { regex: '.*', match: true }
+    }
+  ],
+  curly: 'error',
+  'dot-notation': 0,
+  eqeqeq: ['error', 'smart'],
+  'guard-for-in': 'error',
+  'id-match': 'error',
+  'max-len': ['error', { code: 180 }],
+  'new-parens': 'error',
+  'no-bitwise': 'error',
+  'no-caller': 'error',
+  'no-console': [
+    'error',
+    {
+      allow: [
+        'log',
+        'warn',
+        'trace',
+        'debug',
+        'info',
+        'error',
+        'Console',
+        'profile',
+        'profileEnd'
+      ]
+    }
+  ],
+  'no-extra-boolean-cast': 0,
+  'no-prototype-builtins': 0,
+  'no-debugger': 'error',
+  'no-duplicate-imports': 'error',
+  'no-empty': 0,
+  'no-eval': 'error',
+  'no-fallthrough': 'error',
+  'no-invalid-this': 0,
+  'no-irregular-whitespace': 'error',
+  'no-multiple-empty-lines': 'error',
+  'no-new-wrappers': 'error',
+  'no-redeclare': 0,
+  '@typescript-eslint/no-redeclare': ['error', { builtinGlobals: false, }],
+  'no-shadow': ['error', { hoist: 'all' }],
+  'no-sparse-arrays': 'error',
+  'no-template-curly-in-string': 'error',
+  'no-throw-literal': 'error',
+  'no-trailing-spaces': 'error',
+  'no-underscore-dangle': 0,
+  'no-useless-escape': 0,
+  'no-unused-expressions': 0,
+  'no-unused-labels': 'error',
+  'no-var': 'error',
+  'object-shorthand': 'error',
+  'prefer-const': 'error',
+  'prefer-object-spread': 'error',
+  'prefer-template': 'error',
+  'quote-props': ['error', 'as-needed'],
+  radix: 'error',
+  'spaced-comment': [
+    'error',
+    'always',
+    { line: { markers: ['/'] } }
+  ],
+  '@typescript-eslint/consistent-type-assertions': ['warn', { assertionStyle: 'never' }]
+};

package/support/bin/types.ts

@@ -0,0 +1,7 @@
+export type TrvEslintPlugin = {
+  name: string;
+  rules: Record<string, {
+    defaultLevel?: string | boolean | number;
+    create: Function;
+  }>;
+};

package/support/cli.lint.ts

@@ -0,0 +1,36 @@
+import { RootIndex } from '@travetto/manifest';
+import { ExecUtil, GlobalEnvConfig } from '@travetto/base';
+import { CliCommand, CliModuleUtil, OptionConfig } from '@travetto/cli';
+
+type Options = {
+  changed: OptionConfig<boolean>;
+};
+
+/**
+ * Command line support for linting
+ */
+export class LintCommand extends CliCommand<Options> {
+  name = 'lint';
+
+  getOptions(): Options {
+    return {
+      changed: this.boolOption({ desc: 'Only check changed modules', def: false }),
+    };
+  }
+
+  envInit(): GlobalEnvConfig {
+    return { debug: false };
+  }
+
+  async action(): Promise<void> {
+    const mods = await CliModuleUtil.findModules(this.cmd.changed ? 'changed' : 'all');
+
+    const res = await ExecUtil.spawn('npx', ['eslint', ...mods.filter(x => x.local).map(x => x.sourcePath)], {
+      cwd: RootIndex.manifest.workspacePath,
+      stdio: 'inherit',
+      catchAsResult: true
+    }).result;
+
+    return this.exit(res.code);
+  }
+}

package/support/cli.lint_register.ts

@@ -0,0 +1,18 @@
+import fs from 'fs/promises';
+
+import { CliCommand } from '@travetto/cli';
+import { path, RootIndex } from '@travetto/manifest';
+
+import { buildEslintConfig } from './bin/eslint-config-file';
+
+export class LintConfigureCommand extends CliCommand {
+  name = 'lint:register';
+
+  async action(): 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());
+
+    console.log(`Wrote eslint config to ${output}`);
+  }
+}