@ttsc/lint 0.19.3 → 0.20.1

package/src/structures/rules/ITtscLintStorybookRules.ts

@@ -66,6 +66,9 @@ export interface ITtscLintStorybookRules {
    * character, so the title collapses into a single sidebar entry instead of
    * nested folders.
    *
+   * Tagged `Deprecated`: the separator is superseded rather than broken, and
+   * the story still renders, so an editor strikes that separator through.
+   *
    * @reference https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/hierarchy-separator.md
    */
   "storybook/hierarchy-separator"?: TtscLintRuleSetting;
@@ -99,6 +102,11 @@ export interface ITtscLintStorybookRules {
    * The explicit value adds boilerplate and drifts from the export when one
    * side is renamed without the other.
    *
+   * Tagged `Unnecessary`: both reported shapes — the `name` / `storyName`
+   * property and a standalone `Story.storyName = ...` assignment — span the
+   * complete removable annotation, including its trailing comma or semicolon,
+   * so an editor greys out a range whose deletion leaves valid syntax.
+   *
    * @reference https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-redundant-story-name.md
    */
   "storybook/no-redundant-story-name"?: TtscLintRuleSetting;
@@ -107,6 +115,11 @@ export interface ITtscLintStorybookRules {
    * Reject direct imports from Storybook renderer packages (`@storybook/react`,
    * etc.); use the user-facing package surface.
    *
+   * The diagnostic names the framework packages that replace the renderer, and
+   * offers each as an editor suggestion that rewrites the module specifier.
+   * None is applied automatically: which one is right depends on the project's
+   * bundler, which the import does not state.
+   *
    * @reference https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-renderer-packages.md
    */
   "storybook/no-renderer-packages"?: TtscLintRuleSetting;
@@ -117,6 +130,10 @@ export interface ITtscLintStorybookRules {
    * Storybook 7 removed it in favour of CSF default-export metadata; remaining
    * uses block the migration to CSF3 and the modern indexer.
    *
+   * Tagged `Deprecated`: an editor strikes the import specifier through, since
+   * the instruction is to migrate off the builder rather than to delete the
+   * import and leave the calls below it unresolved.
+   *
    * @reference https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-stories-of.md
    */
   "storybook/no-stories-of"?: TtscLintRuleSetting;
@@ -128,6 +145,10 @@ export interface ITtscLintStorybookRules {
    * CSF3 derives the title from the file path, so an explicit `title` is
    * redundant and drifts from the on-disk layout when files are moved.
    *
+   * Tagged `Unnecessary`: the reported range is the complete removable
+   * property, including a trailing comma when present, so deleting the faded
+   * range is the resolution and leaves valid object syntax.
+   *
    * @reference https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-title-property-in-meta.md
    */
   "storybook/no-title-property-in-meta"?: TtscLintRuleSetting;

package/src/structures/rules/ITtscLintTypeScriptRuleOptions.ts

@@ -73,7 +73,16 @@ export interface ITtscLintTypeScriptNoFloatingPromisesRuleOptions {
   allowForKnownSafeCalls?: readonly TtscLintTypeOrValueSpecifier[];
   /** Promise types whose values may be discarded safely. */
   allowForKnownSafePromises?: readonly TtscLintTypeOrValueSpecifier[];
-  /** Also inspect catchable structural thenables. Defaults to `false`. */
+  /**
+   * Check all thenables, not just the built-in `Promise` type. Defaults to
+   * `false`, matching `@typescript-eslint/no-floating-promises`.
+   *
+   * The option selects what the rule examines, so turning it on reports more.
+   * Left off, a structural thenable is outside the rule entirely: neither a
+   * floating one nor a handled chain on one is reported. A configuration
+   * carried over from typescript-eslint therefore produces the same findings
+   * here.
+   */
   checkThenables?: boolean;
   /**
    * Ignore immediately invoked function-expression results. Defaults to

package/src/structures/rules/ITtscLintTypeScriptRules.ts

@@ -189,6 +189,11 @@ export interface ITtscLintTypeScriptRules {
    *
    * `delete` leaves a hole; use `arr.splice` to shrink the array.
    *
+   * Type-aware via the Checker. `delete target[key]` is spelled identically
+   * whether the target is an array or a `Record` / index-signature object, and
+   * on the latter it is the correct way to remove an entry, so only the
+   * target's type separates the two.
+   *
    * @reference https://typescript-eslint.io/rules/no-array-delete
    */
   "typescript/no-array-delete"?: TtscLintRuleSetting;
@@ -1055,12 +1060,18 @@ export interface ITtscLintTypeScriptRules {
   "typescript/require-array-sort-compare"?: TtscLintRuleSetting;
 
   /**
-   * Reject `async` functions whose body contains no `await` expression.
+   * Reject `async` functions that have no `await` expression and return no
+   * promise.
    *
    * An async function with no `await` only inflates the return type to
    * `Promise<T>` without doing any asynchronous work; collapse it to a sync
    * function. Async generators are accepted as long as they have at least one
-   * `yield`.
+   * `yield`, and a `for await` loop counts as an await.
+   *
+   * Type-aware via the Checker, which upstream uses for the same purpose: a
+   * function that returns a promise is accepted without an `await`, because
+   * marking it `async` states the contract for callers and forwards the inner
+   * promise rather than leaving a refactor artifact behind.
    *
    * @reference https://typescript-eslint.io/rules/require-await
    */