@pandacss/eslint-plugin 0.3.2 → 2.0.0-beta.11

package/dist/index.d.ts

@@ -0,0 +1,214 @@
+import { L as Linter, R as RuleModuleLike, I as Inspect, a as RuleContextWithReport } from './shared-BdjJwg93.js';
+export { c as LintInspection, b as LintRuleContextLike, d as LinterOptions, h as PandaLintSettings, f as ProjectCache, P as ProjectCacheOptions, l as ReportDescriptor, i as RuleContextLike, j as RuleFixer, S as SourceCodeLike, k as SuggestionDescriptor, n as byteToIndex, g as getContextFilename, e as getContextSource, m as getSourceText, p as projectCacheKey, r as resolvePandaSettings, t as toEslintLoc } from './shared-BdjJwg93.js';
+import { Project } from '@pandacss/compiler/tooling';
+export { FileInspectionCacheEntry as InspectionCacheEntry, FileInspector as Inspector, sourceCacheKey } from '@pandacss/compiler/tooling';
+import { Span, Diagnostic, Deprecation, TokenSuggestion, FileInspectionResult } from '@pandacss/compiler';
+
+interface RangeLike {
+    span: Span;
+}
+declare class RangeIndex<T extends RangeLike> {
+    #private;
+    constructor(items: readonly T[]);
+    at(offset: number): T | undefined;
+    enclosing(span: Span): T | undefined;
+    exact(span: Span): T | undefined;
+    all(): readonly T[];
+}
+
+/** Flat-config plugin meta, shared by every entry point. */
+declare const pluginMeta: {
+    name: string;
+    version: string;
+};
+interface PandaPluginOptions {
+    cwd?: string;
+    configPath?: string;
+    linter?: Linter;
+}
+interface PandaProject {
+    linter: Linter;
+    project: Project;
+}
+interface PandaPlugin {
+    rules: Record<string, RuleModuleLike>;
+}
+/** Preload one Panda project (config load + compiler) for a `(cwd, configPath)`. */
+declare function loadPandaProject(options?: PandaPluginOptions): Promise<PandaProject>;
+/** Bind every rule to an already-loaded project so rule visitors stay synchronous. */
+declare function bindRules(linter: Linter, project: Project): Record<string, RuleModuleLike>;
+declare function createPandaPlugin(options?: PandaPluginOptions): Promise<PandaPlugin>;
+
+/** Flat-config plugin key; rule ids are `@pandacss/<rule>`. */
+declare const PLUGIN_NAMESPACE = "@pandacss";
+type RuleSeverity = 'off' | 'warn' | 'error';
+type RuleEntry = RuleSeverity | [RuleSeverity, Record<string, unknown>];
+interface RecommendedOptions extends PandaPluginOptions {
+    /** File globs to lint; defaults to source extensions. */
+    files?: string[];
+}
+interface PandaFlatConfig {
+    files: string[];
+    plugins: Record<string, {
+        meta: {
+            name: string;
+            version?: string;
+        };
+        rules: Record<string, RuleModuleLike>;
+    }>;
+    rules: Record<string, RuleEntry>;
+    settings?: {
+        panda: {
+            configPath: string;
+        };
+    };
+}
+/**
+ * Build the recommended flat config. Async because it preloads the Panda
+ * project (config load + compiler) so rule visitors can run synchronously.
+ *
+ * Scopes itself to JS/TS/JSX via `files` but sets no parser — use your
+ * project's existing parser setup so ESLint can parse the files.
+ *
+ * ```ts
+ * import panda from '@pandacss/eslint-plugin'
+ *
+ * export default [
+ *   await panda.configs.recommended({ configPath: './panda.config.ts' }),
+ * ]
+ * ```
+ */
+declare function recommended(options?: RecommendedOptions): Promise<PandaFlatConfig>;
+declare const configs: {
+    recommended: typeof recommended;
+};
+
+declare const consistentPropertyStyleRuleName = "consistent-property-style";
+interface ConsistentPropertyStyleRuleOptions {
+    inspect: Inspect;
+    /** `shorthand alias -> canonical property`, from `spec.utilities.shorthands`. */
+    shorthands: Record<string, string>;
+}
+declare function createConsistentPropertyStyleRule(options: ConsistentPropertyStyleRuleOptions): RuleModuleLike;
+
+declare const extractionDiagnosticsRuleName = "extraction-diagnostics";
+interface ExtractionDiagnosticsRuleOptions {
+    inspect: Inspect;
+}
+declare function createExtractionDiagnosticsRule(options: ExtractionDiagnosticsRuleOptions): RuleModuleLike;
+declare function reportDiagnostics(context: RuleContextWithReport, diagnostics: readonly Diagnostic[]): void;
+
+declare const noInvalidTokenPathsRuleName = "no-invalid-token-paths";
+interface TokenRuleOptions {
+    inspect: Inspect;
+}
+declare function createNoInvalidTokenPathsRule(options: TokenRuleOptions): RuleModuleLike;
+
+declare const fileNotIncludedRuleName = "file-not-included";
+interface FileNotIncludedRuleOptions {
+    inspect: Inspect;
+    isSourceFile: (path: string) => boolean;
+}
+declare function createFileNotIncludedRule(options: FileNotIncludedRuleOptions): RuleModuleLike;
+
+declare const noDebugRuleName = "no-debug";
+interface NoDebugRuleOptions {
+    inspect: Inspect;
+}
+declare function createNoDebugRule(options: NoDebugRuleOptions): RuleModuleLike;
+
+declare const noDeprecatedRuleName = "no-deprecated";
+type DeprecationKind = 'tokens' | 'utilities' | 'recipes' | 'patterns';
+interface NoDeprecatedRuleOptions {
+    inspect: Inspect;
+    /** Token path → deprecation. */
+    tokens: Record<string, Deprecation>;
+    /** Canonical property → deprecation. */
+    utilities: Record<string, Deprecation>;
+    /** Recipe name → deprecation. */
+    recipes: Record<string, Deprecation>;
+    /** Pattern name → deprecation. */
+    patterns: Record<string, Deprecation>;
+}
+declare function createNoDeprecatedRule(options: NoDeprecatedRuleOptions): RuleModuleLike;
+
+declare const noImportantRuleName = "no-important";
+declare function createNoImportantRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const noInvalidNestingRuleName = "no-invalid-nesting";
+declare function createNoInvalidNestingRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const noPrimitiveTokenRuleName = "no-primitive-token";
+interface NoPrimitiveTokenRuleOptions {
+    inspect: Inspect;
+    /** Semantic tokens that carry the same value as a full token path. */
+    suggestSemanticTokens: (path: string) => TokenSuggestion[];
+}
+interface ReportConfig$1 extends NoPrimitiveTokenRuleOptions {
+    /** Categories to enforce; `undefined` means every category with semantic tokens. */
+    categories?: ReadonlySet<string>;
+    allow: ReadonlySet<string>;
+}
+declare function reportPrimitiveTokenViolations(context: RuleContextWithReport, inspection: FileInspectionResult, config: ReportConfig$1): void;
+declare function createNoPrimitiveTokenRule(options: NoPrimitiveTokenRuleOptions): RuleModuleLike;
+
+declare const noMarginPropertiesRuleName = "no-margin-properties";
+declare function createNoMarginPropertiesRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const noPhysicalPropertiesRuleName = "no-physical-properties";
+declare function createNoPhysicalPropertiesRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const noShorthandLonghandMixRuleName = "no-shorthand-longhand-mix";
+declare function createNoShorthandLonghandMixRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const preferTokenRuleName = "prefer-token";
+type SuggestTokens = (prop: string, value: string) => TokenSuggestion[];
+interface PreferTokenRuleOptions {
+    inspect: Inspect;
+    /** Property (canonical) → its token category, or `undefined` if not token-backed. */
+    categoryOf: (prop: string) => string | undefined;
+    /** Whether `value` on `prop` resolved to a raw value rather than a token var. */
+    isHardcodedValue: (prop: string, value: string) => boolean;
+    /** Tokens that carry a value, ranked (safe equivalents first). */
+    suggest: SuggestTokens;
+}
+/** Flatten the string leaves of a folded style value (handles conditions/arrays). */
+declare function collectStrings(value: unknown, out: string[]): void;
+interface ReportConfig {
+    categoryOf: (prop: string) => string | undefined;
+    isHardcodedValue: (prop: string, value: string) => boolean;
+    suggest: SuggestTokens;
+    /** Categories to enforce; `undefined` means every token-backed category. */
+    categories?: ReadonlySet<string>;
+    allow: ReadonlySet<string>;
+}
+/** Shared engine: flag utility entries whose value is raw where a token exists. */
+declare function reportTokenViolations(context: RuleContextWithReport, inspection: FileInspectionResult, config: ReportConfig): void;
+declare function createPreferTokenRule(options: PreferTokenRuleOptions): RuleModuleLike;
+
+declare const preferTextStyleRuleName = "prefer-text-style";
+declare function createPreferTextStyleRule(options: {
+    inspect: Inspect;
+}): RuleModuleLike;
+
+declare const _default: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    configs: {
+        recommended: typeof recommended;
+    };
+};
+
+export { type ConsistentPropertyStyleRuleOptions, type DeprecationKind, type ExtractionDiagnosticsRuleOptions, type FileNotIncludedRuleOptions, Inspect, Linter, type NoDebugRuleOptions, type NoDeprecatedRuleOptions, type NoPrimitiveTokenRuleOptions, PLUGIN_NAMESPACE, type PandaFlatConfig, type PandaPlugin, type PandaPluginOptions, type PandaProject, type PreferTokenRuleOptions, RangeIndex, type RangeLike, type RecommendedOptions, RuleContextWithReport, RuleModuleLike, type SuggestTokens, type TokenRuleOptions, bindRules, collectStrings, configs, consistentPropertyStyleRuleName, createConsistentPropertyStyleRule, createExtractionDiagnosticsRule, createFileNotIncludedRule, createNoDebugRule, createNoDeprecatedRule, createNoImportantRule, createNoInvalidNestingRule, createNoInvalidTokenPathsRule, createNoMarginPropertiesRule, createNoPhysicalPropertiesRule, createNoPrimitiveTokenRule, createNoShorthandLonghandMixRule, createPandaPlugin, createPreferTextStyleRule, createPreferTokenRule, _default as default, extractionDiagnosticsRuleName, fileNotIncludedRuleName, loadPandaProject, noDebugRuleName, noDeprecatedRuleName, noImportantRuleName, noInvalidNestingRuleName, noInvalidTokenPathsRuleName, noMarginPropertiesRuleName, noPhysicalPropertiesRuleName, noPrimitiveTokenRuleName, noShorthandLonghandMixRuleName, pluginMeta, preferTextStyleRuleName, preferTokenRuleName, recommended, reportDiagnostics, reportPrimitiveTokenViolations, reportTokenViolations };