@ttsc/lint 0.13.0 → 0.14.0-dev.20250530.1

package/src/structures/rules/ITtscLintBoundariesRuleOptions.ts

@@ -0,0 +1,117 @@
+/**
+ * Options shapes for every rule in {@link ITtscLintBoundariesRules}.
+ *
+ * The `boundaries/*` family classifies each source file as belonging to a named
+ * _element_ (a layer, feature, or app within the project). Every rule below
+ * shares the same element-declaration block, so the helper interfaces in this
+ * file describe that block first and then layer the per-rule options on top.
+ *
+ * @reference https://github.com/javierbrea/eslint-plugin-boundaries
+ */
+
+/** One source-path element used by the `boundaries/*` rules. */
+export interface ITtscLintBoundariesElement {
+  /** Element type name used by `boundaries/element-types` policies. */
+  type: string;
+
+  /**
+   * Glob-like source path pattern. Relative patterns are matched against any
+   * project-path suffix, so `src/app/**` works in temporary and monorepo roots
+   * alike.
+   */
+  pattern: string;
+
+  /**
+   * File(s) inside the element that may be imported from outside that element.
+   * Used by `boundaries/entry-point`.
+   */
+  entry?: string | readonly string[];
+
+  /**
+   * File(s) inside the element that may only be imported by the same element.
+   * Used by `boundaries/no-private`.
+   */
+  private?: string | readonly string[];
+}
+
+/** Dependency policy used by `boundaries/element-types`. */
+export interface ITtscLintBoundariesElementTypesRule {
+  /** Source element type(s) the policy applies to. Omit to match all sources. */
+  from?: string | readonly string[];
+
+  /** Target element type(s) allowed from the matching source. */
+  allow?: string | readonly string[];
+
+  /** Target element type(s) rejected from the matching source. */
+  disallow?: string | readonly string[];
+
+  /** Optional diagnostic override. */
+  message?: string;
+}
+
+/**
+ * Shared element-declaration block used by every TypeScript source-path
+ * `boundaries/*` rule.
+ */
+export interface ITtscLintBoundariesElementsOptions {
+  /** Source path elements used to classify importers and imported files. */
+  elements?: readonly ITtscLintBoundariesElement[];
+}
+
+/** `boundaries/element-types` rule options. */
+export interface ITtscLintBoundariesElementTypesRuleOptions extends ITtscLintBoundariesElementsOptions {
+  /**
+   * Fallback policy when no rule matches.
+   *
+   * @default "allow"
+   */
+  default?: "allow" | "disallow";
+
+  /** Ordered dependency policies. First matching policy wins. */
+  rules?: readonly ITtscLintBoundariesElementTypesRule[];
+}
+
+/** `boundaries/external` rule options. */
+export interface ITtscLintBoundariesExternalRuleOptions {
+  /** External package/specifier patterns that are allowed. Empty means all. */
+  allow?: string | readonly string[];
+
+  /** External package/specifier patterns that are rejected. */
+  disallow?: string | readonly string[];
+
+  /** Optional diagnostic override. */
+  message?: string;
+}
+
+/** `boundaries/entry-point` rule options. */
+export type ITtscLintBoundariesEntryPointRuleOptions =
+  ITtscLintBoundariesElementsOptions;
+
+/** `boundaries/no-private` rule options. */
+export type ITtscLintBoundariesNoPrivateRuleOptions =
+  ITtscLintBoundariesElementsOptions;
+
+/** `boundaries/no-unknown` rule options. */
+export type ITtscLintBoundariesNoUnknownRuleOptions =
+  ITtscLintBoundariesElementsOptions;
+
+/**
+ * `boundaries/dependencies` rule options.
+ *
+ * The upstream unified rule subsumes `element-types`, `entry-point`,
+ * `external`, `no-private`, and `no-unknown` behind a single direction-aware
+ * policy block. The v1 native port registers the rule name and decodes this
+ * config shape but does not yet emit diagnostics (`v1 stub; full validation
+ * deferred` — see `rules_boundaries.go`).
+ */
+export interface ITtscLintBoundariesDependenciesRuleOptions extends ITtscLintBoundariesElementsOptions {
+  /**
+   * Fallback policy when no rule matches.
+   *
+   * @default "allow"
+   */
+  default?: "allow" | "disallow";
+
+  /** Ordered dependency policies. First matching policy wins. */
+  rules?: readonly ITtscLintBoundariesElementTypesRule[];
+}

package/src/structures/rules/ITtscLintBoundariesRules.ts

@@ -0,0 +1,91 @@
+import type {
+  TtscLintRuleOptionsSetting,
+  TtscLintRuleSetting,
+} from "../TtscLintRuleSetting";
+import type {
+  ITtscLintBoundariesDependenciesRuleOptions,
+  ITtscLintBoundariesElementTypesRuleOptions,
+  ITtscLintBoundariesEntryPointRuleOptions,
+  ITtscLintBoundariesExternalRuleOptions,
+  ITtscLintBoundariesNoPrivateRuleOptions,
+  ITtscLintBoundariesNoUnknownRuleOptions,
+} from "./ITtscLintBoundariesRuleOptions";
+
+/**
+ * Architecture-boundary rules that enforce import direction and module
+ * visibility between configured source-path _elements_ (layers, features, apps
+ * in a monorepo).
+ *
+ * Every rule operates on the _resolved source file_ of an import — relative
+ * imports are followed to the real `.ts`/`.tsx`/`.d.ts` file before
+ * classification.
+ *
+ * @reference https://github.com/javierbrea/eslint-plugin-boundaries
+ */
+export interface ITtscLintBoundariesRules {
+  /**
+   * Enforce allowed dependency directions between configured source-path
+   * element types.
+   *
+   * Each `element` entry declares a name, a matching glob, and the other
+   * element types it is allowed to import.
+   *
+   * Imports that fall outside the allow-list are reported.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/element-types.md
+   */
+  "boundaries/element-types"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesElementTypesRuleOptions>;
+
+  /**
+   * Require imports that cross element boundaries to target the importee
+   * element's configured public entry files (typically `index.ts`), so the
+   * public surface of each element is explicit.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/entry-point.md
+   */
+  "boundaries/entry-point"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesEntryPointRuleOptions>;
+
+  /**
+   * Restrict external package imports by package or specifier pattern.
+   *
+   * Useful for forbidding direct imports of an underlying library when a
+   * project-local facade exists.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/external.md
+   */
+  "boundaries/external"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesExternalRuleOptions>;
+
+  /**
+   * Reject imports of files declared _private_ by a parent element from outside
+   * that element.
+   *
+   * Combines with `element-types` to keep implementation details hidden.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-private.md
+   */
+  "boundaries/no-private"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesNoPrivateRuleOptions>;
+
+  /**
+   * Reject relative imports whose resolved source file falls under no
+   * configured element.
+   *
+   * Catches stray files that escape the project's boundary map.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/no-unknown.md
+   */
+  "boundaries/no-unknown"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesNoUnknownRuleOptions>;
+
+  /**
+   * Unified dependency-direction rule from upstream `eslint-plugin-boundaries`,
+   * intended to replace `element-types` / `entry-point` / `external` /
+   * `no-private` / `no-unknown` with a single policy block.
+   *
+   * The native port registers the rule name and accepts the same `elements` +
+   * `rules` config shape as `element-types`, but does not emit diagnostics yet
+   * (v1 stub; full direction validation deferred). Configure it today to claim
+   * the upstream rule id; the legacy split rules continue to enforce policy.
+   *
+   * @reference https://github.com/javierbrea/eslint-plugin-boundaries/blob/master/docs/rules/dependencies.md
+   */
+  "boundaries/dependencies"?: TtscLintRuleOptionsSetting<ITtscLintBoundariesDependenciesRuleOptions>;
+}

package/src/structures/rules/ITtscLintContributorRules.ts

@@ -0,0 +1,20 @@
+import type { TtscLintRuleSetting } from "../TtscLintRuleSetting";
+import type { TtscLintSeverity } from "../TtscLintSeverity";
+
+/**
+ * Catch-all index signature for contributor plugin rules.
+ *
+ * Plugin authors expose rules under their own namespace prefix (`demo/no-demo`,
+ * `myplugin/foo-bar`). The signature here accepts any `"<namespace>/<rule>"`
+ * key with either the bare severity form, the severity tuple, or the
+ * severity-plus-options tuple. Plugins ship their own typings to tighten the
+ * options shape per rule.
+ *
+ * @reference https://ttsc.dev/lint/development/rules
+ */
+export interface ITtscLintContributorRules {
+  [ruleName: `${string}/${string}`]:
+    | TtscLintRuleSetting
+    | readonly [TtscLintSeverity, unknown]
+    | undefined;
+}