@forinda/kickjs-lint 5.2.4 → 5.2.5

package/README.md

@@ -1,6 +1,6 @@
 # @forinda/kickjs-lint
 
-Lint rules for KickJS conventions — DI tokens, plugin/adapter naming, and other framework patterns.
+Lint rules for KickJS conventions: DI tokens made with `createToken<T>()`, and the reserved `kick/` token prefix.
 
 ## Install
 
@@ -8,42 +8,25 @@ Lint rules for KickJS conventions — DI tokens, plugin/adapter naming, and othe
 pnpm add -D @forinda/kickjs-lint
 ```
 
-## CLI
+## Quick example
 
 ```bash
-# adopter project — lints `src/`, warns on third-party kick/ squatting
-kick-lint
-
-# framework / first-party packages — lints `packages/`, errors on missing kick/ prefix
-kick-lint --first-party
-
-# custom scope
-kick-lint --scope src,libs
+kick-lint                    # lints src/
+kick-lint --scope src,libs   # other folders
 ```
 
-## Programmatic
+| Rule                    | Default | Checks                                                       |
+| ----------------------- | ------- | ------------------------------------------------------------ |
+| `di-token-symbol`       | `error` | tokens use `createToken<T>()`, not `Symbol(...)`             |
+| `token-kick-prefix`     | `error` | first-party tokens start with `kick/` (`--first-party` only) |
+| `token-reserved-prefix` | `warn`  | third-party tokens don't use the reserved `kick/` prefix     |
 
-```ts
-import { runLint, formatViolations } from '@forinda/kickjs-lint'
-
-const result = await runLint({ cwd: process.cwd(), firstParty: false })
-if (result.violations.length > 0) console.error(formatViolations(result.violations))
-```
+Disable one on a line with `// kick-lint-disable <rule>`. `runLint()` and `formatViolations()` run it from code.
 
-## Rules
+## Documentation
 
-| Rule                    | Default | Description                                                                   |
-| ----------------------- | ------- | ----------------------------------------------------------------------------- |
-| `di-token-symbol`       | `error` | DI tokens must use `createToken<T>()` instead of `Symbol(...)` in token files |
-| `token-kick-prefix`     | `error` | First-party tokens must start with the reserved `kick/` prefix                |
-| `token-reserved-prefix` | `warn`  | Third-party tokens must not squat the reserved `kick/` prefix                 |
-
-Inline-disable a rule on a single line:
-
-```ts
-export const FOO = Symbol('Legacy') // kick-lint-disable di-token-symbol
-```
+[DI tokens](https://kickjs.app/guide/dependency-injection#tokens)
 
-## Why
+## License
 
-See [architecture.md §22](https://github.com/forinda/kick-js/blob/main/architecture.md#22-di-token-convention--symbol-to-string-migration) for the convention rationale. The convention landed in the v3 → v4 migration and has been stable since; refer to the [DI Tokens guide](https://kickjs.app/guide/dependency-injection.html#tokens) for the current shape.
+MIT

package/dist/index.d.mts

@@ -1,6 +1,5 @@
 
 import { LintContext, Rule, Violation, diTokenSymbol, rules, tokenKickPrefix, tokenReservedPrefix } from "./rules.mjs";
-
 //#region src/index.d.ts
 /**
  * Filenames that historically declare DI tokens. Lint runs only on
@@ -11,8 +10,8 @@ import { LintContext, Rule, Violation, diTokenSymbol, rules, tokenKickPrefix, to
  * regression where `TENANT_DB = Symbol(...)` slipped past the rule by
  * living in `database.ts` rather than `tokens.ts` / `constants.ts`.
  */
-declare const TOKEN_FILE_NAMES: Set<string>;
-interface LintOptions {
+export declare const TOKEN_FILE_NAMES: Set<string>;
+export interface LintOptions {
   /** Root directory to walk. Required. */
   cwd: string;
   /**
@@ -32,7 +31,7 @@ interface LintOptions {
   /** Filenames to lint (defaults to {@link TOKEN_FILE_NAMES}). */
   filenames?: ReadonlySet<string>;
 }
-interface LintResult {
+export interface LintResult {
   violations: Violation[];
   filesScanned: number;
 }
@@ -41,13 +40,13 @@ interface LintResult {
  * each token-bearing file, and return the aggregated violations + the
  * number of files actually checked.
  */
-declare function runLint(opts: LintOptions): Promise<LintResult>;
+export declare function runLint(opts: LintOptions): Promise<LintResult>;
 /**
  * Format a violation list for terminal output. One block per violation,
  * trailing summary line. Returns `''` when there are no violations so
  * callers can branch on truthiness.
  */
-declare function formatViolations(violations: readonly Violation[]): string;
+export declare function formatViolations(violations: readonly Violation[]): string;
 //#endregion
-export { type LintContext, LintOptions, LintResult, type Rule, TOKEN_FILE_NAMES, type Violation, rules as defaultRules, diTokenSymbol, formatViolations, runLint, tokenKickPrefix, tokenReservedPrefix };
+export { type LintContext, type Rule, type Violation, rules as defaultRules, diTokenSymbol, tokenKickPrefix, tokenReservedPrefix };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;AA2EyB;AAGzB;;;;cAhDa,gBAAA,EAAgB,GAAA;AAAA,UA2BZ,WAAA;EAuBf;EArBA,GAAA;EAqBY;AAQd;;;;EAvBE,UAAA;EAuBgD;;;;;EAjBhD,KAAA;EAiBwD;EAfxD,KAAA,YAAiB,IAAA;EAeiD;EAblE,SAAA,GAAY,WAAW;AAAA;AAAA,UAGR,UAAA;EACf,UAAA,EAAY,SAAS;EACrB,YAAA;AAAA;;;;;;iBAQoB,OAAA,CAAQ,IAAA,EAAM,WAAA,GAAc,OAAA,CAAQ,UAAA;;;;;;iBAkD1C,gBAAA,CAAiB,UAAgC,WAAX,SAAS"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;;qBA8Ba,kBAAgB;iBA2BZ;;EAEf;;;;;;EAMA;;;;;;EAMA;;EAEA,iBAAiB;;EAEjB,YAAY;;iBAGG;EACf,YAAY;EACZ;;;;;;;wBAQoB,QAAQ,MAAM,cAAc,QAAQ;;;;;;wBAkD1C,iBAAiB,qBAAqB"}

package/dist/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @forinda/kickjs-lint v5.2.4
+ * @forinda/kickjs-lint v5.2.5
  *
  * Copyright (c) Felix Orinda
  *

package/dist/rules.d.mts

@@ -5,7 +5,7 @@
  * and returns the violations it found. Stateless and synchronous so the
  * runner can compose them freely (CLI, devtools, editor extension).
  */
-interface Violation {
+export interface Violation {
   ruleId: string;
   severity: 'error' | 'warn';
   file: string;
@@ -14,7 +14,7 @@ interface Violation {
   message: string;
   suggestion?: string;
 }
-interface LintContext {
+export interface LintContext {
   source: string;
   file: string;
   /**
@@ -24,7 +24,7 @@ interface LintContext {
    */
   firstParty: boolean;
 }
-interface Rule {
+export interface Rule {
   id: string;
   description: string;
   defaultSeverity: 'error' | 'warn';
@@ -39,7 +39,7 @@ interface Rule {
  * Inline-disable: append `// kick-lint-disable di-token-symbol` to the
  * declaration line.
  */
-declare const diTokenSymbol: Rule;
+export declare const diTokenSymbol: Rule;
 /**
  * For first-party files, every `createToken('literal')` literal must
  * start with the reserved `kick/` prefix. Third-party adopter code is
@@ -49,16 +49,15 @@ declare const diTokenSymbol: Rule;
  * `kickjs/` (the dotted convention pre-dates section 22 and gets
  * migrated alongside the symbol-to-string work).
  */
-declare const tokenKickPrefix: Rule;
+export declare const tokenKickPrefix: Rule;
 /**
  * Third-party adopters must NOT squat the reserved `kick/` prefix --
  * mirror image of {@link tokenKickPrefix}. Runs only on non-first-party
  * code and warns rather than errors so the rule is informative without
  * blocking adopter installs.
  */
-declare const tokenReservedPrefix: Rule;
+export declare const tokenReservedPrefix: Rule;
 /** All rules shipped by this package, in run order. */
-declare const rules: readonly Rule[];
+export declare const rules: readonly Rule[];
 //#endregion
-export { LintContext, Rule, Violation, diTokenSymbol, rules, tokenKickPrefix, tokenReservedPrefix };
 //# sourceMappingURL=rules.d.mts.map

package/dist/rules.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"rules.d.mts","names":[],"sources":["../src/rules.ts"],"mappings":";;;AAMA;;;;UAAiB,SAAA;EACf,MAAA;EACA,QAAA;EACA,IAAA;EAGA;EADA,IAAA;EACA,OAAA;EACA,UAAA;AAAA;AAAA,UAGe,WAAA;EACf,MAAA;EACA,IAAA;EADA;;;;AAOU;EAAV,UAAA;AAAA;AAAA,UAGe,IAAA;EACf,EAAA;EACA,WAAA;EACA,eAAA;EACA,KAAA,CAAM,GAAA,EAAK,WAAA,GAAc,SAAS;AAAA;;;;;AAAA;AAmBpC;;;;cAAa,aAAA,EAAe,IAwB3B;AAWD;;;;AAwBC;AAQD;;;;AAhCA,cAAa,eAAA,EAAiB,IAwB7B;AAkCD;;;;AAAiC;;AAAjC,cA1Ba,mBAAA,EAAqB,IAuBjC;;cAGY,KAAA,WAAgB,IAAI"}
+{"version":3,"file":"rules.d.mts","names":[],"sources":["../src/rules.ts"],"mappings":";;;;;;;iBAMiB;EACf;EACA;EACA;;EAEA;EACA;EACA;;iBAGe;EACf;EACA;;;;;;EAMA;;iBAGe;EACf;EACA;EACA;EACA,MAAM,KAAK,cAAc;;;;;;;;;;;qBAmBd,eAAe;;;;;;;;;;qBAmCf,iBAAiB;;;;;;;qBAgCjB,qBAAqB;;qBA0BrB,gBAAgB"}

package/dist/rules.mjs

@@ -1,5 +1,5 @@
 /**
- * @forinda/kickjs-lint v5.2.4
+ * @forinda/kickjs-lint v5.2.5
  *
  * Copyright (c) Felix Orinda
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forinda/kickjs-lint",
-  "version": "5.2.4",
+  "version": "5.2.5",
   "description": "Lint rules for KickJS — DI token convention, plugin/adapter naming, and other framework conventions",
   "keywords": [
     "kickjs",
@@ -35,9 +35,9 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "^25.9.2",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.8"
+    "@types/node": "^26.6.2",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.1"
   },
   "publishConfig": {
     "access": "public"
@@ -60,7 +60,7 @@
     "build": "tsdown",
     "dev": "tsdown --watch",
     "test": "vitest run",
-    "typecheck": "tsgo --noEmit",
+    "typecheck": "tsc --noEmit",
     "clean": "rm -rf dist .wireit"
   }
 }