@ttsc/lint 0.13.1 → 0.14.0-dev.20250530.1

package/src/structures/ITtscLintFormatConfig.ts

@@ -1,168 +0,0 @@
-import type { TtscLintSeverity } from "./TtscLintSeverity";
-
-/**
- * Prettier-style flat configuration for the `format/*` rules.
- *
- * The `format` block is the recommended way to enable formatting in
- * `@ttsc/lint`. Each key mirrors a Prettier option of the same name — users
- * coming from a `.prettierrc` can copy their config almost verbatim. The block
- * is opt-in by presence: a `lint.config.ts` with no `format` field keeps every
- * format rule off, exactly as before.
- *
- * Once present, the block configures a curated set of format rules at
- * Prettier-aligned defaults. `ttsc format` uses these rules to rewrite source.
- * `ttsc check` does not report format findings unless `severity` is set to a
- * non-off value. Individual rules can be overridden or disabled through the
- * `rules` map (the `rules` entry wins on conflict).
- *
- * @example
- *   import type { ITtscLintConfig } from "@ttsc/lint";
- *
- *   export default {
- *   rules: { "no-var": "error" },
- *   format: {
- *   severity: "warning",
- *   printWidth: 100,
- *   singleQuote: true,
- *   importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"],
- *   },
- *   } satisfies ITtscLintConfig;
- *
- *   Deviations from Prettier:
- *   - `endOfLine` is restricted to `"lf"` and `"crlf"`. Prettier's
- *   `"cr"` and `"auto"` modes are intentionally unsupported — the
- *   printer does not auto-detect terminators.
- *   - Many Prettier knobs (`bracketSpacing`, `arrowParens`,
- *   `quoteProps`, JSX-specific switches) are not yet implemented.
- *
- *   Rule enablement matrix (when the `format` block is present):
- *
- *   - `format/semi` — always on. `semi: false` flips it to `prefer:
- *   "never"`.
- *   - `format/quotes` — always on. `singleQuote: true` flips to
- *   `prefer: "single"`.
- *   - `format/trailing-comma` — always on. `trailingComma: "none"`
- *   disables the rule's edits without removing the surface.
- *   - `format/print-width` — always on, driven by `printWidth`,
- *   `tabWidth`, `useTabs`, `endOfLine`.
- *   - `format/sort-imports` — opt-in. Setting `importOrder` enables it.
- *   - `format/jsdoc` — opt-in. Setting `jsdoc` enables it.
- *
- *   Format findings produced from this block are off by default. Set `severity`
- *   only when a project intentionally wants check-time format diagnostics.
- */
-export interface ITtscLintFormatConfig {
-  /**
-   * Check-time severity for format findings generated from this block.
-   *
-   * The default is `"off"` so formatting policy does not affect compilation
-   * unless the project opts into that behavior. `ttsc format` can still use the
-   * rest of this block to rewrite files.
-   *
-   * @default "off"
-   */
-  severity?: TtscLintSeverity;
-
-  /**
-   * Insert trailing semicolons on ASI-terminated statements. Mirrors Prettier's
-   * `semi`. `false` flips the rule to require _no_ trailing semicolon (rare;
-   * matches prettier's `semi: false`).
-   *
-   * @default true
-   */
-  semi?: boolean;
-
-  /**
-   * Prefer single-quoted strings. Mirrors Prettier's `singleQuote`. `false`
-   * means double quotes (Prettier's default).
-   *
-   * @default false
-   */
-  singleQuote?: boolean;
-
-  /**
-   * Trailing-comma policy. Mirrors Prettier's `trailingComma`. The `"none"`
-   * mode disables the rule's edits.
-   *
-   * @default "all"
-   */
-  trailingComma?: "all" | "es5" | "none";
-
-  /**
-   * Maximum column width before broken-form layout is chosen. Mirrors
-   * Prettier's `printWidth`.
-   *
-   * @default 80
-   */
-  printWidth?: number;
-
-  /**
-   * Indentation increment in columns. Mirrors Prettier's `tabWidth`.
-   *
-   * @default 2
-   */
-  tabWidth?: number;
-
-  /**
-   * Emit indentation as tab characters. Mirrors Prettier's `useTabs`.
-   *
-   * @default false
-   */
-  useTabs?: boolean;
-
-  /**
-   * Line terminator the printer emits on reflow. `@ttsc/lint` supports `"lf"`
-   * and `"crlf"`. Prettier's `"cr"` and `"auto"` are intentionally unsupported
-   * because the printer does not auto-detect line endings.
-   *
-   * @default "lf"
-   */
-  endOfLine?: "lf" | "crlf";
-
-  /**
-   * Group order for `format/sort-imports`. Setting this enables the rule;
-   * mirrors `@trivago/prettier-plugin-sort-imports`' `importOrder`. The
-   * `<THIRD_PARTY_MODULES>` literal is the catch-all placeholder for specifiers
-   * that match no other group.
-   */
-  importOrder?: readonly ("<THIRD_PARTY_MODULES>" | (string & {}))[];
-
-  /**
-   * Insert blank line between sort-imports groups.
-   *
-   * @default true
-   */
-  importOrderSeparation?: boolean;
-
-  /**
-   * Sort named import specifiers alphabetically within each declaration.
-   *
-   * @default true
-   */
-  importOrderSortSpecifiers?: boolean;
-
-  /**
-   * Case-insensitive comparison for sort-imports.
-   *
-   * @default false
-   */
-  importOrderCaseInsensitive?: boolean;
-
-  /**
-   * Enable `format/jsdoc`. Pass `true` to turn it on with built-in defaults, or
-   * an object to customize:
-   *
-   * - `tagSynonyms` — extra `from → to` rewrites layered on the built-in synonym
-   *   table.
-   * - `sortTags` — sort JSDoc tags into canonical order (reserved; today's MVP
-   *   only rewrites tag names).
-   *
-   * @default false (off)
-   */
-  jsdoc?:
-    | boolean
-    | {
-        tagSynonyms?: Record<string, string>;
-        sortTags?: boolean;
-      };
-}

package/src/structures/TtscLintRule.ts

@@ -1,160 +0,0 @@
-/**
- * Union of every built-in lint rule name understood by the `@ttsc/lint` native
- * sidecar.
- *
- * These names intentionally mirror familiar ESLint / TypeScript-ESLint rule
- * names so a `compilerOptions.plugins[]` entry can configure native linting
- * without introducing a separate lint config file.
- *
- * The `format/*` members at the bottom of the union are applied by `ttsc
- * format`; their severity also controls whether `ttsc check` surfaces
- * unformatted code as a diagnostic.
- *
- * This type is used as the key constraint in `TtscLintRuleMap` for rules that
- * carry no per-rule options. Rules with typed option objects are additionally
- * listed in `ITtscLintRuleOptionsMap`.
- */
-export type TtscLintRule =
-  | "adjacent-overload-signatures"
-  | "array-type"
-  | "await-thenable"
-  | "ban-ts-comment"
-  | "ban-tslint-comment"
-  | "consistent-indexed-object-style"
-  | "consistent-type-assertions"
-  | "consistent-type-definitions"
-  | "consistent-type-imports"
-  | "default-param-last"
-  | "dot-notation"
-  | "eqeqeq"
-  | "for-direction"
-  | "no-alert"
-  | "no-array-constructor"
-  | "no-array-delete"
-  | "no-async-promise-executor"
-  | "no-bitwise"
-  | "no-caller"
-  | "no-case-declarations"
-  | "no-class-assign"
-  | "no-compare-neg-zero"
-  | "no-cond-assign"
-  | "no-confusing-non-null-assertion"
-  | "no-console"
-  | "no-constant-condition"
-  | "no-continue"
-  | "no-control-regex"
-  | "no-debugger"
-  | "no-delete-var"
-  | "no-dupe-args"
-  | "no-dupe-else-if"
-  | "no-dupe-keys"
-  | "no-duplicate-case"
-  | "no-duplicate-enum-values"
-  | "no-dynamic-delete"
-  | "no-empty"
-  | "no-empty-character-class"
-  | "no-empty-function"
-  | "no-empty-interface"
-  | "no-empty-object-type"
-  | "no-empty-pattern"
-  | "no-empty-static-block"
-  | "no-eq-null"
-  | "no-eval"
-  | "no-ex-assign"
-  | "no-explicit-any"
-  | "no-extra-bind"
-  | "no-extra-boolean-cast"
-  | "no-extra-non-null-assertion"
-  | "no-fallthrough"
-  | "no-func-assign"
-  | "no-import-type-side-effects"
-  | "no-inferrable-types"
-  | "no-inner-declarations"
-  | "no-irregular-whitespace"
-  | "no-iterator"
-  | "no-labels"
-  | "no-lone-blocks"
-  | "no-lonely-if"
-  | "no-loss-of-precision"
-  | "no-misleading-character-class"
-  | "no-misused-new"
-  | "no-mixed-enums"
-  | "no-multi-assign"
-  | "no-multi-str"
-  | "no-namespace"
-  | "no-negated-condition"
-  | "no-nested-ternary"
-  | "no-new"
-  | "no-new-func"
-  | "no-new-wrappers"
-  | "no-non-null-asserted-nullish-coalescing"
-  | "no-non-null-asserted-optional-chain"
-  | "no-non-null-assertion"
-  | "no-obj-calls"
-  | "no-object-constructor"
-  | "no-octal"
-  | "no-octal-escape"
-  | "no-plusplus"
-  | "no-promise-executor-return"
-  | "no-proto"
-  | "no-prototype-builtins"
-  | "no-regex-spaces"
-  | "no-require-imports"
-  | "no-return-assign"
-  | "no-script-url"
-  | "no-self-assign"
-  | "no-self-compare"
-  | "no-sequences"
-  | "no-setter-return"
-  | "no-shadow-restricted-names"
-  | "no-sparse-arrays"
-  | "no-template-curly-in-string"
-  | "no-this-alias"
-  | "no-throw-literal"
-  | "no-undef-init"
-  | "no-undefined"
-  | "no-unnecessary-type-constraint"
-  | "no-unneeded-ternary"
-  | "no-unsafe-declaration-merging"
-  | "no-unsafe-finally"
-  | "no-unsafe-function-type"
-  | "no-unsafe-negation"
-  | "no-unused-expressions"
-  | "no-unused-labels"
-  | "no-useless-call"
-  | "no-useless-catch"
-  | "no-useless-computed-key"
-  | "no-useless-concat"
-  | "no-useless-constructor"
-  | "no-useless-escape"
-  | "no-useless-rename"
-  | "no-var"
-  | "no-with"
-  | "no-wrapper-object-types"
-  | "object-shorthand"
-  | "operator-assignment"
-  | "prefer-as-const"
-  | "prefer-const"
-  | "prefer-enum-initializers"
-  | "prefer-exponentiation-operator"
-  | "prefer-for-of"
-  | "prefer-function-type"
-  | "prefer-literal-enum-member"
-  | "prefer-namespace-keyword"
-  | "prefer-spread"
-  | "prefer-template"
-  | "radix"
-  | "require-yield"
-  | "triple-slash-reference"
-  | "use-isnan"
-  | "valid-typeof"
-  | "vars-on-top"
-  | "yoda"
-  // Format rules — applied by `ttsc format`. Severity also controls
-  // whether `ttsc check` surfaces unformatted code as a diagnostic.
-  | "format/semi"
-  | "format/quotes"
-  | "format/trailing-comma"
-  | "format/sort-imports"
-  | "format/jsdoc"
-  | "format/print-width";

package/src/structures/TtscLintRuleMap.ts

@@ -1,55 +0,0 @@
-import type { TtscLintRule } from "./TtscLintRule";
-import type { ITtscLintRuleOptionsMap } from "./TtscLintRuleOptions";
-import type { TtscLintSeverity } from "./TtscLintSeverity";
-
-/**
- * Rule-name → severity or severity-tuple map.
- *
- * Built from two independent mapped types intersected together:
- *
- * - Rules listed in `ITtscLintRuleOptionsMap` accept `severity`, `[severity]`, or
- *   `[severity, options]`, with the options type picked per rule key.
- * - Every other built-in rule accepts `severity` or `[severity]`.
- * - Namespaced contributor plugin rules accept `severity`, `[severity]`, or
- *   `[severity, unknownOptions]` because the host type surface no longer knows
- *   contributor rule schemas.
- *
- * Splitting the two halves (instead of folding them into one mapped type with a
- * conditional value) keeps TypeScript's contextual typing intact inside the
- * options object literal: typing
- *
- * ```ts
- * rules: {
- *   "format/sort-imports": ["warning", { importOrder: [...] }],
- *   "no-var":              "error",
- * }
- * ```
- *
- * Yields exact autocomplete on `importOrder`, `importOrderSeparation`, etc.,
- * while `no-var` rejects any tuple beyond a bare severity.
- *
- * The `(string & {})` widener is intentionally absent: typos in rule names
- * produce a `TS2353` excess-property error when the literal is checked in
- * isolation (e.g. one negative-case-per-const). When the literal also carries
- * other shape-incompatible entries — e.g. `prefre` typo on `format/quotes` next
- * to the rule-name typo — TS sometimes elides the rule-name error after
- * reporting the option-key error first. The test at
- * `tests/test-lint/.../test_lib_index_d_ts_rule_options_autocomplete_per_rule.ts`
- * splits each negative case into its own const to keep every branch
- * load-bearing.
- */
-export type TtscLintRuleMap = {
-  [K in keyof ITtscLintRuleOptionsMap]?:
-    | TtscLintSeverity
-    | readonly [TtscLintSeverity]
-    | readonly [TtscLintSeverity, ITtscLintRuleOptionsMap[K]];
-} & {
-  [K in Exclude<TtscLintRule, keyof ITtscLintRuleOptionsMap>]?:
-    | TtscLintSeverity
-    | readonly [TtscLintSeverity];
-} & {
-  [K in `${string}/${string}`]?:
-    | TtscLintSeverity
-    | readonly [TtscLintSeverity]
-    | readonly [TtscLintSeverity, unknown];
-};

package/src/structures/TtscLintRuleOptions.ts

@@ -1,151 +0,0 @@
-/** `format/semi` rule options. */
-export interface ITtscLintSemiRuleOptions {
-  /**
-   * Whether trailing semicolons must be present on ASI statements.
-   *
-   * @default "always"
-   */
-  prefer?: "always" | "never";
-}
-
-/** `format/quotes` rule options. */
-export interface ITtscLintQuotesRuleOptions {
-  /**
-   * Quote style for string literals. Template literals are always preserved
-   * regardless of this setting.
-   *
-   * @default "double"
-   */
-  prefer?: "double" | "single";
-}
-
-/** `format/trailing-comma` rule options. */
-export interface ITtscLintTrailingCommaRuleOptions {
-  /**
-   * Which multi-line lists receive a trailing comma. `"all"` matches prettier's
-   * modern default; `"es5"` skips function calls and type parameter lists;
-   * `"none"` disables the rule entirely.
-   *
-   * @default "all"
-   */
-  mode?: "all" | "es5" | "none";
-}
-
-/** `format/sort-imports` rule options. */
-export interface ITtscLintSortImportsRuleOptions {
-  /**
-   * Ordered list of regex strings (or the `<THIRD_PARTY_MODULES>` placeholder)
-   * defining the group order. Imports matching the first pattern land in group
-   * 0, the second in group 1, and so on. The placeholder absorbs any specifier
-   * that does not match another pattern. Mirrors trivago's `importOrder`
-   * semantics.
-   */
-  importOrder?: readonly string[];
-
-  /**
-   * Insert a blank line between groups.
-   *
-   * @default true
-   */
-  importOrderSeparation?: boolean;
-
-  /**
-   * Sort named import specifiers alphabetically within each declaration.
-   *
-   * @default true
-   */
-  importOrderSortSpecifiers?: boolean;
-
-  /**
-   * Treat `A` and `a` as equivalent when comparing module specifiers and
-   * specifier names. Mirrors trivago's `importOrderCaseInsensitive`.
-   *
-   * @default false
-   */
-  importOrderCaseInsensitive?: boolean;
-}
-
-/** `format/print-width` rule options. */
-export interface ITtscLintPrintWidthRuleOptions {
-  /**
-   * Maximum column width before broken-form layout is chosen. Mirrors
-   * prettier's `printWidth`.
-   *
-   * @default 80
-   */
-  printWidth?: number;
-
-  /**
-   * Indentation increment in columns. Mirrors prettier's `tabWidth`.
-   *
-   * @default 2
-   */
-  tabWidth?: number;
-
-  /**
-   * Emit indentation as tab characters rather than spaces. Mirrors prettier's
-   * `useTabs`. Continuation alignment beyond the tab boundary still falls back
-   * to spaces, matching dprint's "indent with tabs, align with spaces"
-   * convention.
-   *
-   * @default false
-   */
-  useTabs?: boolean;
-
-  /**
-   * Line-terminator emitted on every newline the printer inserts. Mirrors
-   * prettier's `endOfLine` `"lf"` and `"crlf"` modes.
-   *
-   * @default "lf"
-   */
-  endOfLine?: "lf" | "crlf";
-
-  /**
-   * Trailing-comma policy the reflow honors when it breaks a list across
-   * lines. Mirrors prettier's `trailingComma` and must match the
-   * `format/trailing-comma` rule's `mode`; otherwise the two rules
-   * disagree on every cascade pass and oscillate against each other.
-   *
-   * When a `format` block is configured, `format.trailingComma` is mirrored
-   * into this option automatically. Set it directly only when overriding
-   * the print-width rule via a `rules` tuple — see the conflict-resolution
-   * notes in the README.
-   *
-   * @default "all"
-   */
-  trailingComma?: "all" | "es5" | "none";
-}
-
-/** `format/jsdoc` rule options. */
-export interface ITtscLintJsdocRuleOptions {
-  /**
-   * Extra `from -> to` tag rewrites layered on top of the built-in synonym
-   * table (`@return -> @returns`, `@arg -> @param`, etc.). User-supplied
-   * entries win on key collision, so a `{"return": "RETURN"}` entry overrides
-   * the built-in default for `@return`.
-   *
-   * @default {} (use built-in table unchanged)
-   */
-  tagSynonyms?: Record<string, string>;
-
-  /**
-   * Sort JSDoc tag blocks into the canonical order (`@description`, `@param`,
-   * `@returns`, ...).
-   *
-   * @default false (deferred; MVP only normalizes tag names)
-   */
-  sortTags?: boolean;
-}
-
-/**
- * Index from rule name to its option object. `TtscLintRuleMap` uses this to
- * produce precise tuple types per rule.
- */
-export interface ITtscLintRuleOptionsMap {
-  "format/semi": ITtscLintSemiRuleOptions;
-  "format/quotes": ITtscLintQuotesRuleOptions;
-  "format/trailing-comma": ITtscLintTrailingCommaRuleOptions;
-  "format/sort-imports": ITtscLintSortImportsRuleOptions;
-  "format/jsdoc": ITtscLintJsdocRuleOptions;
-  "format/print-width": ITtscLintPrintWidthRuleOptions;
-}