pasika 0.3.3 → 0.3.4

package/dist/eslint/pasika/index.d.ts

@@ -1,32 +1,140 @@
+import * as eslint from 'eslint';
+import { Rule, Linter } from 'eslint';
+import * as ESTree from 'estree';
+import * as _eslint_markdown from '@eslint/markdown';
+import * as _eslint_css from '@eslint/css';
+import * as _eslint_json from '@eslint/json';
+
 /**
- * Pasika ESLint Ruleset
+ * Local AST node types for the parser-specific shapes ESLint's ESTree types
+ * do not carry: JSX nodes and TypeScript type nodes.
  *
- * Each rule enforces requirements from the `docs/` tree, and each rule file
- * carries a `@see` annotation naming the document it comes from. Which
- * documented requirement each rule covers is recorded in
- * `enforcement/registry.json` and verified by `pasika coverage`.
+ * Every extra field is optional so that any `Rule.Node` is assignable to these
+ * types — the handler parameters of the rules must accept whatever the parser
+ * hands them. Narrowing happens with `type`-discriminant checks inside each
+ * rule, exactly as in `no-arbitrary-tailwind.ts`.
  */
-import type { Linter } from "eslint";
-import { mdRules } from "./rules/md/index.js";
-import { cssRules } from "./rules/css/index.js";
-import { jsonRules } from "./rules/json/index.js";
-export declare const pasikaRules: {
-    "component-placement": import("eslint").Rule.RuleModule;
-    "support-file-placement": import("eslint").Rule.RuleModule;
-    "application-structure": import("eslint").Rule.RuleModule;
-    "named-exports": import("eslint").Rule.RuleModule;
-    "data-testid-case": import("eslint").Rule.RuleModule;
-    "support-folder-shape": import("eslint").Rule.RuleModule;
-    "import-through-index": import("eslint").Rule.RuleModule;
-    "util-file-name": import("eslint").Rule.RuleModule;
-    "no-util-barrel": import("eslint").Rule.RuleModule;
-    "jsx-hygiene": import("eslint").Rule.RuleModule;
-    "interactive-component": import("eslint").Rule.RuleModule;
-    "ui-state": import("eslint").Rule.RuleModule;
-    "filename-case": import("eslint").Rule.RuleModule;
-    "import-boundaries": import("eslint").Rule.RuleModule;
-    "no-mixed-concerns": import("eslint").Rule.RuleModule;
-    "no-arbitrary-tailwind": import("eslint").Rule.RuleModule;
+
+/** JSXIdentifier — the parser-specific name node of a JSX element or attribute. */
+interface JsxIdentifier {
+    type: "JSXIdentifier";
+    name: string;
+}
+/** JSXMemberExpression — `<Foo.Bar>`, used by element and attribute names. */
+interface JsxMemberExpression {
+    type: "JSXMemberExpression";
+    object: JsxIdentifier | JsxMemberExpression;
+    property: JsxIdentifier;
+}
+/** JSXExpressionContainer — the `{expression}` part of a JSX attribute value. */
+interface JsxExpressionContainer {
+    type: "JSXExpressionContainer";
+    expression: ESTree.Expression;
+}
+/** JSXAttribute — `name="value"` or `name={expression}`. */
+type JsxAttribute = Omit<Rule.Node, "type"> & {
+    type: string;
+    name: JsxIdentifier;
+    value: ESTree.Literal | JsxExpressionContainer | null;
+    parent?: JsxOpeningElementNode;
+};
+/** JSXSpreadAttribute — `{...props}`. */
+interface JsxSpreadAttribute {
+    type: "JSXSpreadAttribute";
+    name?: never;
+    value?: never;
+    argument: ESTree.Expression;
+}
+/** Anything that can appear inside `attributes` of a JSX opening element. */
+type JsxAttributeLike = JsxAttribute | JsxSpreadAttribute;
+/** JSXOpeningElement — the part before the closing `>` of an element. */
+interface JsxOpeningElement {
+    type: "JSXOpeningElement";
+    name: JsxIdentifier | JsxMemberExpression;
+    attributes: JsxAttributeLike[];
+}
+/** A node that may be a JSX element — used for parents and helper parameters. */
+type MaybeJsxElement = Rule.Node & {
+    openingElement?: JsxOpeningElement;
+};
+/** JSXElement as received by a `JSXElement` visitor. */
+type JsxElementNode = MaybeJsxElement & {
+    parent?: MaybeJsxElement;
+};
+/** JSXAttribute as received by a `JSXAttribute` visitor, with its parent chain. */
+type JsxAttributeNode = Rule.Node & {
+    name?: JsxIdentifier;
+    value?: ESTree.Literal | JsxExpressionContainer | null;
+    parent?: JsxOpeningElementNode;
+};
+/** JSXOpeningElement reached through a parent chain. */
+type JsxOpeningElementNode = Rule.Node & {
+    name?: JsxIdentifier;
+    attributes?: JsxAttributeLike[];
+    parent?: JsxElementNode;
+};
+
+declare const mdRules: {
+    "doc-kind-suffix": _eslint_markdown.MarkdownRuleDefinition;
+    "title-matches-file-name": _eslint_markdown.MarkdownRuleDefinition;
+    "overview-present": _eslint_markdown.MarkdownRuleDefinition;
+    "overview-length": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-overview-no-links": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-step-single-sentence": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-step-single-link": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-states-no-requirement": _eslint_markdown.MarkdownRuleDefinition;
+    "requirement-present": _eslint_markdown.MarkdownRuleDefinition;
+    "rule-paired-examples": _eslint_markdown.MarkdownRuleDefinition;
+    "example-heading-description": _eslint_markdown.MarkdownRuleDefinition;
+    "policy-no-examples": _eslint_markdown.MarkdownRuleDefinition;
+    "no-cross-document-link": _eslint_markdown.MarkdownRuleDefinition;
+    "reference-no-rfc-vocabulary": _eslint_markdown.MarkdownRuleDefinition;
+    "reference-block-headings": _eslint_markdown.MarkdownRuleDefinition;
+    "support-document-placement": _eslint_markdown.MarkdownRuleDefinition;
+    "no-template-prompt": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-folder-entry-point": _eslint_markdown.MarkdownRuleDefinition;
+    "rfc-only-in-bullets": _eslint_markdown.MarkdownRuleDefinition;
+    "policy-subject-headings": _eslint_markdown.MarkdownRuleDefinition;
+    "guide-link-anchors": _eslint_markdown.MarkdownRuleDefinition;
+    "no-nested-how-to": _eslint_markdown.MarkdownRuleDefinition;
+    "glossary-term-linking": _eslint_markdown.MarkdownRuleDefinition;
+};
+
+declare const cssRules: {
+    "theme-reset": _eslint_css.CSSRuleDefinition;
+    "root-variables": _eslint_css.CSSRuleDefinition;
+    "apply-usage": _eslint_css.CSSRuleDefinition;
+    "base-layer-pair": _eslint_css.CSSRuleDefinition;
+    "stylesheet-ordering": _eslint_css.CSSRuleDefinition;
+    "css-variable-naming": _eslint_css.CSSRuleDefinition;
+    "custom-utility-apply": _eslint_css.CSSRuleDefinition;
+    "surface-utility": _eslint_css.CSSRuleDefinition;
+    "theme-variable-namespace": _eslint_css.CSSRuleDefinition;
+    "global-css-location": _eslint_css.CSSRuleDefinition;
+};
+
+declare const jsonRules: {
+    "no-cache-flag": _eslint_json.JSONRuleDefinition;
+    "no-vulyk-dependency": _eslint_json.JSONRuleDefinition;
+};
+
+declare const pasikaRules: {
+    "component-placement": eslint.Rule.RuleModule;
+    "support-file-placement": eslint.Rule.RuleModule;
+    "application-structure": eslint.Rule.RuleModule;
+    "named-exports": eslint.Rule.RuleModule;
+    "data-testid-case": eslint.Rule.RuleModule;
+    "support-folder-shape": eslint.Rule.RuleModule;
+    "import-through-index": eslint.Rule.RuleModule;
+    "util-file-name": eslint.Rule.RuleModule;
+    "no-util-barrel": eslint.Rule.RuleModule;
+    "jsx-hygiene": eslint.Rule.RuleModule;
+    "interactive-component": eslint.Rule.RuleModule;
+    "ui-state": eslint.Rule.RuleModule;
+    "filename-case": eslint.Rule.RuleModule;
+    "import-boundaries": eslint.Rule.RuleModule;
+    "no-mixed-concerns": eslint.Rule.RuleModule;
+    "no-arbitrary-tailwind": eslint.Rule.RuleModule;
     "enforce-cn-merge": {
         meta: {
             schema: never[];
@@ -35,35 +143,39 @@ export declare const pasikaRules: {
                 description: string;
             };
         };
-        create(context: import("eslint").Rule.RuleContext): {
-            JSXAttribute(node: import("./ast-types.js").JsxAttributeNode): void;
+        create(context: eslint.Rule.RuleContext): {
+            JSXAttribute(node: JsxAttributeNode): void;
         };
     };
-    "enforce-cva-variant-props": import("eslint").Rule.RuleModule;
-    "cva-appearance-props": import("eslint").Rule.RuleModule;
-    "cva-boolean-variants": import("eslint").Rule.RuleModule;
-    "enforce-barrel-exports": import("eslint").Rule.RuleModule;
-    "cross-feature-import": import("eslint").Rule.RuleModule;
-    "pure-function-extract": import("eslint").Rule.RuleModule;
-    "hook-complexity": import("eslint").Rule.RuleModule;
-    "locale-dotted-path": import("eslint").Rule.RuleModule;
-    "locales-location": import("eslint").Rule.RuleModule;
-    "hook-extraction": import("eslint").Rule.RuleModule;
-    "value-extraction": import("eslint").Rule.RuleModule;
-    "config-extraction": import("eslint").Rule.RuleModule;
-    "component-nesting": import("eslint").Rule.RuleModule;
-    "stay-flat": import("eslint").Rule.RuleModule;
-    "type-extraction": import("eslint").Rule.RuleModule;
-    "locale-placement": import("eslint").Rule.RuleModule;
-    "shared-style-dedup": import("eslint").Rule.RuleModule;
-    "no-eslint-disable": import("eslint").Rule.RuleModule;
+    "enforce-cva-variant-props": eslint.Rule.RuleModule;
+    "cva-appearance-props": eslint.Rule.RuleModule;
+    "cva-boolean-variants": eslint.Rule.RuleModule;
+    "enforce-barrel-exports": eslint.Rule.RuleModule;
+    "cross-feature-import": eslint.Rule.RuleModule;
+    "pure-function-extract": eslint.Rule.RuleModule;
+    "hook-complexity": eslint.Rule.RuleModule;
+    "locale-dotted-path": eslint.Rule.RuleModule;
+    "locales-location": eslint.Rule.RuleModule;
+    "hook-extraction": eslint.Rule.RuleModule;
+    "value-extraction": eslint.Rule.RuleModule;
+    "config-extraction": eslint.Rule.RuleModule;
+    "component-nesting": eslint.Rule.RuleModule;
+    "stay-flat": eslint.Rule.RuleModule;
+    "type-extraction": eslint.Rule.RuleModule;
+    "locale-placement": eslint.Rule.RuleModule;
+    "shared-style-dedup": eslint.Rule.RuleModule;
+    "no-eslint-disable": eslint.Rule.RuleModule;
+    "zod-schema-validation": eslint.Rule.RuleModule;
+    "source-under-src": eslint.Rule.RuleModule;
 };
-export { mdRules, cssRules, jsonRules };
+
 /** Rule ids as they appear in configuration and in lint output. */
-export declare const pasikaRuleIds: string[];
-export declare const pasikaMdRuleIds: string[];
-export declare const pasikaCssRuleIds: string[];
-export declare const pasikaJsonRuleIds: string[];
+declare const pasikaRuleIds: string[];
+declare const pasikaMdRuleIds: string[];
+declare const pasikaCssRuleIds: string[];
+declare const pasikaJsonRuleIds: string[];
 /** Every rule id, as they appear in configuration and in lint output. */
-export declare const allPasikaRuleIds: string[];
-export declare const pasikaConfig: Linter.Config;
+declare const allPasikaRuleIds: string[];
+declare const pasikaConfig: Linter.Config;
+
+export { allPasikaRuleIds, cssRules, jsonRules, mdRules, pasikaConfig, pasikaCssRuleIds, pasikaJsonRuleIds, pasikaMdRuleIds, pasikaRuleIds, pasikaRules };