@travetto/lint 8.0.0-alpha.20

package/README.md

@@ -0,0 +1,87 @@
+<!-- This file was generated by @travetto/doc and should not be modified directly -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/lint/DOC.tsx and execute "npx trv doc" to rebuild -->
+# Lint Support
+
+## Linting and Formatting integration for Travetto
+
+**Install: @travetto/lint**
+```bash
+npm install @travetto/lint
+
+# or
+
+yarn add @travetto/lint
+```
+
+[Biome](https://biomejs.dev/) is the tool used for linting, formatting, and organizing imports in [Typescript](https://typescriptlang.org) and [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) code. This module provides a unified CLI interface and standard linting patterns. In a new project, the first thing that will need to be done, post installation, is to create the Biome configuration file.
+
+## CLI - lint:register
+
+**Terminal: Help for lint:register**
+```bash
+$ trv lint:register --help
+
+Usage: lint:register [options]
+
+Description:
+  Generate the workspace Biome configuration entry file.
+
+  This bootstraps `biome.jsonc` to extend the framework-provided rules configuration.
+
+Options:
+  --help  display help for command
+```
+
+When registration completes, this is the file the linter will use, and any other tooling (e.g. IDEs).
+
+**Code: Sample configuration**
+```json
+{
+  "$schema": "https://biomejs.dev/schemas/2.5.4/schema.json",
+  "extends": ["./node_modules/@travetto/lint/resources/biome.jsonc"],
+  "files": {
+    "includes": [
+      "**",      
+      "!**/out",
+      "!**/ui",
+      "!**/api-client",
+      "!**/*.d.ts",
+      "!**/fixtures",
+      "!**/resources",
+      "!**/DOC.html",
+      "!**/README.md",
+      "!archived/**",
+      "!related/travetto.github.io/**"
+    ]
+  }
+}
+```
+
+## CLI - lint
+Once registered, using the linter is as simple as invoking it via the cli:
+
+**Terminal: Running the Linter**
+```bash
+npx trv lint
+```
+
+Or pointing your IDE to reference the registered configuration file.
+
+**Terminal: Help for lint**
+```bash
+$ trv lint --help
+
+Usage: lint [options]
+
+Description:
+  Run Biome linter/formatter for the workspace or changed files.
+
+  Supports incremental mode (`changed`/`since`) and forwards format/fix
+  options to the underlying biome invocation.
+
+Options:
+  -c, --changed         Only check changed modules (default: false)
+  -s, --since <string>  Since a specific git commit
+  -f, --fix             Should we attempt to fix/write formatting changes?
+  --help                display help for command
+```

package/__index__.ts

@@ -0,0 +1,2 @@
+// Empty index file for @travetto/lint
+export {};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@travetto/lint",
+  "version": "8.0.0-alpha.20",
+  "type": "module",
+  "description": "Linting and Formatting integration for Travetto",
+  "keywords": [
+    "lint",
+    "travetto",
+    "typescript",
+    "biome"
+  ],
+  "homepage": "https://travetto.io",
+  "license": "MIT",
+  "author": {
+    "email": "travetto.framework@gmail.com",
+    "name": "Travetto Framework"
+  },
+  "main": "__index__.ts",
+  "files": [
+    "support",
+    "__index__.ts",
+    "resources"
+  ],
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/lint"
+  },
+  "dependencies": {
+    "@travetto/runtime": "^8.0.0-alpha.20",
+    "@biomejs/biome": "^2.5.3"
+  },
+  "peerDependencies": {
+    "@travetto/cli": "^8.0.0-alpha.28"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/cli": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "Lint Support"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/resources/biome.jsonc

@@ -0,0 +1,145 @@
+{
+  "root": false,
+  "$schema": "https://biomejs.dev/schemas/2.5.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": true,
+    "includes": [
+      "**",
+      "!**/*.d.ts",
+      "!**/fixtures",
+      "!**/resources",
+      "!**/DOC.html",
+      "!**/.vscode",
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 140,
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "groups": [
+              [
+                ":NODE:",
+                ":BUN:"
+              ],
+              ":BLANK_LINE:",
+              [
+                ":PACKAGE:",
+                "!@travetto/**"
+              ],
+              ":BLANK_LINE:",
+              "@travetto/*",
+              ":BLANK_LINE:",
+              "@travetto/**/*.ts",
+              ":BLANK_LINE:",
+              [
+                ":ALIAS:",
+                ":PATH:"
+              ]
+            ]
+          }
+        }
+      }
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "preset": "recommended",
+      "style": {
+        "useImportType": "error",
+        "noNonNullAssertion": "off",
+        "useConst": "error",
+      },
+      "correctness": {
+        "noUnusedFunctionParameters": "off",
+        "noUnusedPrivateClassMembers": "off",
+        "noUnusedVariables": {
+          "level": "on",
+          "options": {
+            "ignore": {
+              "class": [
+                "*"
+              ],
+              "typeParameter": [
+                "*"
+              ]
+            }
+          }
+        }
+      },
+      "complexity": {
+        "useArrowFunction": "off",
+        "noStaticOnlyClass": "off",
+        "noThisInStatic": "off",
+        "noBannedTypes": "off",
+      },
+      "suspicious": {
+        "noVar": "error",
+        "noTsIgnore": "off",
+        "noConfusingVoidType": "off",
+        "noEmptyInterface": "off",
+        "noAssignInExpressions": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "always",
+      "arrowParentheses": "asNeeded",
+      "trailingCommas": "none"
+    },
+    "parser": {
+      "unsafeParameterDecoratorsEnabled": true
+    }
+  },
+  "json": {
+    "formatter": {
+      "lineWidth": 80
+    }
+  },
+  "overrides": [
+    {
+      "includes": [
+        "**/test/**",
+        "**/support/test/**",
+        "**/doc/**",
+        "!module/test/src/**"
+      ],
+      "linter": {
+        "rules": {
+          "complexity": {
+            "noUselessConstructor": "off"
+          },
+          "correctness": {
+            "noUnusedVariables": "off",
+            "noUnusedFunctionParameters": "off",
+          },
+          "security": {
+            "noBlankTarget": "off"
+          },
+          "style": {
+            "useConst": "off"
+          },
+          "suspicious": {
+            "noSelfCompare": "off"
+          }
+        }
+      }
+    }
+  ]
+}

package/support/cli.lint.ts

@@ -0,0 +1,55 @@
+import { spawn } from 'node:child_process';
+
+import { CliCommand, type CliCommandShape, CliModuleUtil, CliParseUtil } from '@travetto/cli';
+import { Env, ExecUtil, Runtime } from '@travetto/runtime';
+
+/**
+ * Run Biome linter/formatter for the workspace or changed files.
+ *
+ * Supports incremental mode (`changed`/`since`) and forwards format/fix
+ * options to the underlying biome invocation.
+ */
+@CliCommand()
+export class LintCommand implements CliCommandShape {
+  /** Only check changed modules */
+  changed = false;
+
+  /** Since a specific git commit */
+  since?: string;
+
+  /** Should we attempt to fix/write formatting changes? */
+  fix?: boolean;
+
+  finalize(): void {
+    Env.DEBUG.set(false);
+  }
+
+  async main(): Promise<void> {
+    const paths = await CliModuleUtil.findChangedPaths({ changed: this.changed, since: this.since, logError: true });
+
+    if ((this.changed || this.since) && paths.length === 0) {
+      console.log('No changed files found to lint.');
+      return;
+    }
+
+    const state = CliParseUtil.getState(this);
+    const result = await ExecUtil.getResult(
+      spawn(
+        process.argv0,
+        [
+          Runtime.workspaceRelative('node_modules', '.bin', 'biome'),
+          'check',
+          ...(this.fix ? ['--write'] : []),
+          ...paths,
+          ...(state?.unknown ?? [])
+        ],
+        {
+          stdio: 'inherit'
+        }
+      ),
+      { catch: true }
+    );
+
+    process.exitCode = result.code;
+  }
+}

package/support/cli.lint_register.ts

@@ -0,0 +1,27 @@
+import fs from 'node:fs/promises';
+
+import { CliCommand, type CliCommandShape } from '@travetto/cli';
+import { Runtime } from '@travetto/runtime';
+
+/**
+ * Generate the workspace Biome configuration entry file.
+ *
+ * This bootstraps `biome.jsonc` to extend the framework-provided rules configuration.
+ */
+@CliCommand({})
+export class LintRegisterCommand implements CliCommandShape {
+  async main(): Promise<void> {
+    const content = `{
+  "$schema": "https://biomejs.dev/schemas/2.5.4/schema.json",
+  "extends": ["./node_modules/@travetto/lint/resources/biome.jsonc"]
+}
+`;
+    const output = Runtime.workspaceRelative('biome.jsonc');
+    if (!(await fs.stat(output, { throwIfNoEntry: false }))) {
+      await fs.writeFile(output, content);
+      console.log(`Wrote lint config to ${output}`);
+    } else {
+      console.log(`Lint config already present ${output}`);
+    }
+  }
+}