@tamagui/eslint-plugin 0.0.0-bootstrap.0 → 3.0.0-beta.1097.1

package/src/index.ts

@@ -0,0 +1,125 @@
+import type { Rule } from 'eslint'
+import {
+  extractStyleSitesFromEstree,
+  type EstreeStyleSite,
+} from '@tamagui/language-service/extract-estree'
+import {
+  canonicalizeStyleValue,
+  createCandidatePropertyVocabulary,
+  createModifierRegistry,
+  createStylePropSet,
+  diagnoseStyleValueProgram,
+  type GrammarConfigView,
+} from '@tamagui/style-grammar/tooling'
+
+type RuleOption = {
+  config: GrammarConfigView
+  strictPayloads?: boolean
+}
+
+export const validFlatValues: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    fixable: 'code',
+    docs: {
+      description: 'validate static Tamagui flat values with @tamagui/style-grammar',
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          config: {
+            type: 'object',
+          },
+          strictPayloads: {
+            type: 'boolean',
+          },
+        },
+        required: ['config'],
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      invalidFlatValue: '{{message}}',
+      nonCanonicalFlatValue: 'use the canonical flat value "{{canonical}}"',
+    },
+  },
+
+  create(context) {
+    const option = context.options[0] as RuleOption | undefined
+    const config = option?.config || {}
+    const strictPayloads = option?.strictPayloads ?? false
+    const registry = createModifierRegistry(config).registry
+    const candidates = createCandidatePropertyVocabulary(config)
+    const styleProps = createStylePropSet(config)
+    const sourceCode = context.sourceCode
+
+    const report = (site: EstreeStyleSite): void => {
+      const node = site.node as Rule.Node
+      const diagnostics = diagnoseStyleValueProgram(site.property, site.value, {
+        config,
+        registry,
+        candidates,
+        strictPayloads,
+      })
+      for (const diagnostic of diagnostics) {
+        context.report({
+          node,
+          // the engine reports value-relative spans; surface them exactly
+          loc: {
+            start: sourceCode.getLocFromIndex(site.start + diagnostic.start),
+            end: sourceCode.getLocFromIndex(site.start + diagnostic.end),
+          },
+          messageId: 'invalidFlatValue',
+          data: { message: diagnostic.message },
+        })
+      }
+      if (diagnostics.length > 0) return
+
+      const formatted = canonicalizeStyleValue(site.value, registry)
+      if (!formatted.ok || formatted.value === site.value) return
+      const canonical = formatted.value
+      context.report({
+        node,
+        messageId: 'nonCanonicalFlatValue',
+        data: { canonical },
+        fix(fixer) {
+          return fixer.replaceText(node, JSON.stringify(canonical))
+        },
+      })
+    }
+
+    return {
+      'Program:exit'(program) {
+        const sites = extractStyleSitesFromEstree(program, {
+          isStyleProp: (name) => styleProps.has(name),
+        })
+        for (const site of sites) report(site)
+      },
+    }
+  },
+}
+
+export interface TamaguiEslintRules {
+  'valid-flat-values': Rule.RuleModule
+}
+
+export interface TamaguiEslintPlugin {
+  meta: {
+    name: string
+  }
+  rules: TamaguiEslintRules
+}
+
+export const rules: TamaguiEslintRules = {
+  'valid-flat-values': validFlatValues,
+}
+
+const plugin: TamaguiEslintPlugin = {
+  meta: {
+    name: '@tamagui/eslint-plugin',
+  },
+  rules,
+}
+
+export default plugin

package/src/validFlatValues.ts

@@ -0,0 +1,95 @@
+import {
+  extractStyleSitesFromEstree,
+  type EstreeStyleSite,
+} from '@tamagui/language-service/extract-estree'
+import {
+  canonicalizeStyleValue,
+  createCandidatePropertyVocabulary,
+  createModifierRegistry,
+  createStylePropSet,
+  diagnoseStyleValueProgram,
+  type GrammarConfigView,
+} from '@tamagui/style-grammar/tooling'
+import type { Rule } from 'eslint'
+
+type RuleOption = {
+  config: GrammarConfigView
+}
+
+export const validFlatValues: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    fixable: 'code',
+    docs: {
+      description: 'validate static Tamagui flat values with @tamagui/style-grammar',
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          config: {
+            type: 'object',
+          },
+        },
+        required: ['config'],
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      invalidFlatValue: '{{message}}',
+      nonCanonicalFlatValue: 'use the canonical flat value "{{canonical}}"',
+    },
+  },
+
+  create(context) {
+    const option = context.options[0] as RuleOption | undefined
+    const config = option?.config || {}
+    const registry = createModifierRegistry(config).registry
+    const candidates = createCandidatePropertyVocabulary(config)
+    const styleProps = createStylePropSet(config)
+    const sourceCode = context.sourceCode
+
+    const report = (site: EstreeStyleSite): void => {
+      const node = site.node as Rule.Node
+      const diagnostics = diagnoseStyleValueProgram(site.property, site.value, {
+        config,
+        registry,
+        candidates,
+      })
+      for (const diagnostic of diagnostics) {
+        context.report({
+          node,
+          // the engine reports value-relative spans; surface them exactly
+          loc: {
+            start: sourceCode.getLocFromIndex(site.start + diagnostic.start),
+            end: sourceCode.getLocFromIndex(site.start + diagnostic.end),
+          },
+          messageId: 'invalidFlatValue',
+          data: { message: diagnostic.message },
+        })
+      }
+      if (diagnostics.length > 0) return
+
+      const formatted = canonicalizeStyleValue(site.value, registry)
+      if (!formatted.ok || formatted.value === site.value) return
+      const canonical = formatted.value
+      context.report({
+        node,
+        messageId: 'nonCanonicalFlatValue',
+        data: { canonical },
+        fix(fixer) {
+          return fixer.replaceText(node, JSON.stringify(canonical))
+        },
+      })
+    }
+
+    return {
+      'Program:exit'(program) {
+        const sites = extractStyleSitesFromEstree(program, {
+          isStyleProp: (name) => styleProps.has(name),
+        })
+        for (const site of sites) report(site)
+      },
+    }
+  },
+}

package/types/index.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from "eslint";
+export declare const validFlatValues: Rule.RuleModule;
+export interface TamaguiEslintRules {
+	"valid-flat-values": Rule.RuleModule;
+}
+export interface TamaguiEslintPlugin {
+	meta: {
+		name: string;
+	};
+	rules: TamaguiEslintRules;
+}
+export declare const rules: TamaguiEslintRules;
+declare const plugin: TamaguiEslintPlugin;
+export default plugin;
+
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1,11 @@
+{
+  "mappings": "AAAA,cAAc,YAAY;AAmB1B,OAAO,cAAM,iBAAiB,KAAK;AAmFnC,iBAAiB,mBAAmB;CAClC,qBAAqB,KAAK;;AAG5B,iBAAiB,oBAAoB;CACnC,MAAM;EACJ;;CAEF,OAAO;;AAGT,OAAO,cAAM,OAAO;AAIpB,cAAM,QAAQ;AAOd,eAAe",
+  "names": [],
+  "sources": [
+    "src/index.ts"
+  ],
+  "version": 3,
+  "sourcesContent": [
+    "import type { Rule } from 'eslint'\nimport {\n  extractStyleSitesFromEstree,\n  type EstreeStyleSite,\n} from '@tamagui/language-service/extract-estree'\nimport {\n  canonicalizeStyleValue,\n  createCandidatePropertyVocabulary,\n  createModifierRegistry,\n  createStylePropSet,\n  diagnoseStyleValueProgram,\n  type GrammarConfigView,\n} from '@tamagui/style-grammar/tooling'\n\ntype RuleOption = {\n  config: GrammarConfigView\n  strictPayloads?: boolean\n}\n\nexport const validFlatValues: Rule.RuleModule = {\n  meta: {\n    type: 'problem',\n    fixable: 'code',\n    docs: {\n      description: 'validate static Tamagui flat values with @tamagui/style-grammar',\n    },\n    schema: [\n      {\n        type: 'object',\n        properties: {\n          config: {\n            type: 'object',\n          },\n          strictPayloads: {\n            type: 'boolean',\n          },\n        },\n        required: ['config'],\n        additionalProperties: false,\n      },\n    ],\n    messages: {\n      invalidFlatValue: '{{message}}',\n      nonCanonicalFlatValue: 'use the canonical flat value \"{{canonical}}\"',\n    },\n  },\n\n  create(context) {\n    const option = context.options[0] as RuleOption | undefined\n    const config = option?.config || {}\n    const strictPayloads = option?.strictPayloads ?? false\n    const registry = createModifierRegistry(config).registry\n    const candidates = createCandidatePropertyVocabulary(config)\n    const styleProps = createStylePropSet(config)\n    const sourceCode = context.sourceCode\n\n    const report = (site: EstreeStyleSite): void => {\n      const node = site.node as Rule.Node\n      const diagnostics = diagnoseStyleValueProgram(site.property, site.value, {\n        config,\n        registry,\n        candidates,\n        strictPayloads,\n      })\n      for (const diagnostic of diagnostics) {\n        context.report({\n          node,\n          // the engine reports value-relative spans; surface them exactly\n          loc: {\n            start: sourceCode.getLocFromIndex(site.start + diagnostic.start),\n            end: sourceCode.getLocFromIndex(site.start + diagnostic.end),\n          },\n          messageId: 'invalidFlatValue',\n          data: { message: diagnostic.message },\n        })\n      }\n      if (diagnostics.length > 0) return\n\n      const formatted = canonicalizeStyleValue(site.value, registry)\n      if (!formatted.ok || formatted.value === site.value) return\n      const canonical = formatted.value\n      context.report({\n        node,\n        messageId: 'nonCanonicalFlatValue',\n        data: { canonical },\n        fix(fixer) {\n          return fixer.replaceText(node, JSON.stringify(canonical))\n        },\n      })\n    }\n\n    return {\n      'Program:exit'(program) {\n        const sites = extractStyleSitesFromEstree(program, {\n          isStyleProp: (name) => styleProps.has(name),\n        })\n        for (const site of sites) report(site)\n      },\n    }\n  },\n}\n\nexport interface TamaguiEslintRules {\n  'valid-flat-values': Rule.RuleModule\n}\n\nexport interface TamaguiEslintPlugin {\n  meta: {\n    name: string\n  }\n  rules: TamaguiEslintRules\n}\n\nexport const rules: TamaguiEslintRules = {\n  'valid-flat-values': validFlatValues,\n}\n\nconst plugin: TamaguiEslintPlugin = {\n  meta: {\n    name: '@tamagui/eslint-plugin',\n  },\n  rules,\n}\n\nexport default plugin\n"
+  ]
+}

package/types/validFlatValues.d.ts

@@ -0,0 +1,4 @@
+import type { Rule } from "eslint";
+export declare const validFlatValues: Rule.RuleModule;
+
+//# sourceMappingURL=validFlatValues.d.ts.map

package/types/validFlatValues.d.ts.map

@@ -0,0 +1,11 @@
+{
+  "mappings": "AAYA,cAAc,YAAY;AAM1B,OAAO,cAAM,iBAAiB,KAAK",
+  "names": [],
+  "sources": [
+    "src/validFlatValues.ts"
+  ],
+  "version": 3,
+  "sourcesContent": [
+    "import {\n  extractStyleSitesFromEstree,\n  type EstreeStyleSite,\n} from '@tamagui/language-service/extract-estree'\nimport {\n  canonicalizeStyleValue,\n  createCandidatePropertyVocabulary,\n  createModifierRegistry,\n  createStylePropSet,\n  diagnoseStyleValueProgram,\n  type GrammarConfigView,\n} from '@tamagui/style-grammar/tooling'\nimport type { Rule } from 'eslint'\n\ntype RuleOption = {\n  config: GrammarConfigView\n}\n\nexport const validFlatValues: Rule.RuleModule = {\n  meta: {\n    type: 'problem',\n    fixable: 'code',\n    docs: {\n      description: 'validate static Tamagui flat values with @tamagui/style-grammar',\n    },\n    schema: [\n      {\n        type: 'object',\n        properties: {\n          config: {\n            type: 'object',\n          },\n        },\n        required: ['config'],\n        additionalProperties: false,\n      },\n    ],\n    messages: {\n      invalidFlatValue: '{{message}}',\n      nonCanonicalFlatValue: 'use the canonical flat value \"{{canonical}}\"',\n    },\n  },\n\n  create(context) {\n    const option = context.options[0] as RuleOption | undefined\n    const config = option?.config || {}\n    const registry = createModifierRegistry(config).registry\n    const candidates = createCandidatePropertyVocabulary(config)\n    const styleProps = createStylePropSet(config)\n    const sourceCode = context.sourceCode\n\n    const report = (site: EstreeStyleSite): void => {\n      const node = site.node as Rule.Node\n      const diagnostics = diagnoseStyleValueProgram(site.property, site.value, {\n        config,\n        registry,\n        candidates,\n      })\n      for (const diagnostic of diagnostics) {\n        context.report({\n          node,\n          // the engine reports value-relative spans; surface them exactly\n          loc: {\n            start: sourceCode.getLocFromIndex(site.start + diagnostic.start),\n            end: sourceCode.getLocFromIndex(site.start + diagnostic.end),\n          },\n          messageId: 'invalidFlatValue',\n          data: { message: diagnostic.message },\n        })\n      }\n      if (diagnostics.length > 0) return\n\n      const formatted = canonicalizeStyleValue(site.value, registry)\n      if (!formatted.ok || formatted.value === site.value) return\n      const canonical = formatted.value\n      context.report({\n        node,\n        messageId: 'nonCanonicalFlatValue',\n        data: { canonical },\n        fix(fixer) {\n          return fixer.replaceText(node, JSON.stringify(canonical))\n        },\n      })\n    }\n\n    return {\n      'Program:exit'(program) {\n        const sites = extractStyleSitesFromEstree(program, {\n          isStyleProp: (name) => styleProps.has(name),\n        })\n        for (const site of sites) report(site)\n      },\n    }\n  },\n}\n"
+  ]
+}