@travetto/eslint 8.0.0-alpha.14 → 8.0.0-alpha.17

package/README.md

@@ -16,18 +16,25 @@ yarn add @travetto/eslint
 [ESLint](https://eslint.org/) is the standard for linting [Typescript](https://typescriptlang.org) and [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) code.  This module provides some standard linting patterns and the ability to create custom rules. Due to the fact that the framework supports both [CommonJS](https://nodejs.org/api/modules.html) and [Ecmascript Module](https://nodejs.org/api/esm.html) formats, a novel solution was required to allow [ESLint](https://eslint.org/) to load [Ecmascript Module](https://nodejs.org/api/esm.html) files.
 
 **Note**: The [ESLint](https://eslint.org/) has introduced [a new configuration format](https://eslint.org/blog/2022/08/new-config-system-part-3/) which allows for [Ecmascript Module](https://nodejs.org/api/esm.html) files.
-
-## CLI - Register
 In a new project, the first thing that will need to be done, post installation, is to create the eslint configuration file.
 
-**Terminal: Registering the Configuration**
+## CLI - eslint:register
+
+**Terminal: Help for eslint:register**
 ```bash
-$ trv eslint:register
+$ trv eslint:register --help
+
+Usage: eslint:register [options]
+
+Generate the workspace ESLint configuration entry file.
 
-Wrote eslint config to <workspace-root>/eslint.config.js
+This bootstraps `eslint.config.js` to load framework-provided rule wiring.
+
+Options:
+  --help  display help for command
 ```
 
-This is the file the linter will use, and any other tooling (e.g. IDEs).
+When registration completes, this is the file the linter will use, and any other tooling (e.g. IDEs).
 
 **Code: Sample configuration**
 ```javascript
@@ -36,10 +43,8 @@ const { rules } = await import('./.trv/output/node_modules/@travetto/eslint/supp
 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.
-
-## CLI - Lint
-Once installed, using the linter is as simple as invoking it via the cli:
+## CLI - eslint
+Once registered, using the linter is as simple as invoking it via the cli:
 
 **Terminal: Running the Linter**
 ```bash
@@ -48,6 +53,25 @@ npx trv eslint
 
 Or pointing your IDE to reference the registered configuration file.
 
+**Terminal: Help for eslint**
+```bash
+$ trv eslint --help
+
+Usage: eslint [options]
+
+Run ESLint for the workspace or changed files.
+
+Supports incremental mode (`changed`/`since`) and forwards formatting/fix
+options to the underlying eslint invocation.
+
+Options:
+  -c, --changed          Only check changed modules (default: false)
+  -f, --format <string>  Output format
+  -s, --since <string>   Since a specific git commit
+  --fix                  Should we attempt to fix?
+  --help                 display help for command
+```
+
 ## Custom Rules
 It can be seen in the sample configuration, that the configuration is looking for files with the pattern of `support/eslint/.*` 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/eslint",
-  "version": "8.0.0-alpha.14",
+  "version": "8.0.0-alpha.17",
   "type": "module",
   "description": "ES Linting Rules",
   "keywords": [
@@ -26,16 +26,16 @@
   "dependencies": {
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "@travetto/runtime": "^8.0.0-alpha.13",
+    "@travetto/runtime": "^8.0.0-alpha.16",
     "@types/eslint": "^9.6.1",
-    "@typescript-eslint/eslint-plugin": "^8.58.2",
-    "@typescript-eslint/parser": "^8.58.2",
-    "@typescript-eslint/typescript-estree": "^8.58.2",
-    "eslint": "^10.2.0",
+    "@typescript-eslint/eslint-plugin": "^8.60.1",
+    "@typescript-eslint/parser": "^8.60.1",
+    "@typescript-eslint/typescript-estree": "^8.60.1",
+    "eslint": "^10.4.1",
     "eslint-plugin-unused-imports": "^4.4.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.19"
+    "@travetto/cli": "^8.0.0-alpha.22"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/cli.eslint.ts

@@ -4,7 +4,10 @@ import { Env, ExecUtil, Runtime } from '@travetto/runtime';
 import { type CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
 
 /**
- * Command line support for eslint
+ * Run ESLint for the workspace or changed files.
+ *
+ * Supports incremental mode (`changed`/`since`) and forwards formatting/fix
+ * options to the underlying eslint invocation.
  */
 @CliCommand()
 export class ESLintCommand implements CliCommandShape {

package/support/cli.eslint_register.ts

@@ -4,7 +4,9 @@ import { type CliCommandShape, CliCommand } from '@travetto/cli';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
 /**
- * Writes the eslint configuration file
+ * Generate the workspace ESLint configuration entry file.
+ *
+ * This bootstraps `eslint.config.js` to load framework-provided rule wiring.
  */
 @CliCommand({})
 export class ESLintConfigureCommand implements CliCommandShape {