@swiftwc/eslint-plugin 1.1.7-canary.0 → 1.1.7-canary.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @swiftwc/eslint-plugin
 
+## 1.1.7-canary.1
+
+### Patch Changes
+
+- ed31ef2: - Renamed `TagNode` to `BaseNode` for clarity.
+
 ## 1.1.7-canary.0
 
 ### Patch Changes

package/generated/emberjs/en.d.ts

@@ -1,2 +1,25 @@
-import { swiftwc } from '../index.js';
-export default swiftwc;
+declare const _default: {
+    meta: {
+        name: any;
+        version: any;
+        namespace: string;
+    };
+    configs: {};
+    rules: {
+        'allowed-tags': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                schema: never[];
+                messages: {
+                    disallowedTag: string;
+                };
+            };
+            create: (context: Readonly<import("@typescript-eslint/utils/ts-eslint").RuleContext<string, readonly unknown[]>>) => import("@typescript-eslint/utils/ts-eslint").RuleListener;
+        };
+    };
+};
+export default _default;

package/generated/emberjs/en.js

@@ -1,18 +1,22 @@
-import { DIRECT_PARENT_RULES, swiftwc, validate } from '../index.js';
-swiftwc.rules['allowed-tags'].meta.docs.description = 'Restrict allowed HTML tags';
-swiftwc.rules['allowed-tags'].meta.messages.disallowedTag = 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}';
-swiftwc.rules['allowed-tags'].create = (context) => {
-    return {
-        // '*': (node) => {
-        // if('GlimmerElementNode' !== node.type) return
-        GlimmerElementNode(node) {
-            // @ts-expect-error
-            const tag = node.tag;
-            const allowedParents = DIRECT_PARENT_RULES[tag];
-            if (!allowedParents)
-                return; // 👈 ignore unknown tags completely
-            validate(tag, (item) => item.parent, allowedParents, context, node);
-        },
-    };
-};
-export default swiftwc;
+import { createPlugin, getAllowedParents, validate } from '../index.js';
+/** Nearest real element ancestor; skips {{#let}}/{{#if}}/{{#each}} blocks, mustaches, text. */
+/** This still accepts content-view, div and scroll-view, and rejects Foo, :header, @arg, this.foo and foo.bar. */
+function getParentName(n) {
+    for (let p = n.parent; p; p = p.parent) {
+        if (p.type === 'GlimmerElementNode' && /^[a-z][\w-]*$/.test(p.tag))
+            return p.tag;
+        if (p.type === 'GlimmerTemplate')
+            return 'template';
+    }
+    return undefined;
+}
+export default createPlugin((context) => ({
+    // '*': (node) => {
+    // if('GlimmerElementNode' !== node.type) return
+    GlimmerElementNode(node) {
+        const allowedParents = getAllowedParents(node.tag);
+        if (!allowedParents)
+            return;
+        validate(node.tag, getParentName, allowedParents, context, node);
+    },
+}));

package/generated/html/en.d.ts

@@ -1,2 +1,25 @@
-import { swiftwc } from '../index.js';
-export default swiftwc;
+declare const _default: {
+    meta: {
+        name: any;
+        version: any;
+        namespace: string;
+    };
+    configs: {};
+    rules: {
+        'allowed-tags': {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                schema: never[];
+                messages: {
+                    disallowedTag: string;
+                };
+            };
+            create: (context: Readonly<import("@typescript-eslint/utils/ts-eslint").RuleContext<string, readonly unknown[]>>) => import("@typescript-eslint/utils/ts-eslint").RuleListener;
+        };
+    };
+};
+export default _default;

package/generated/html/en.js

@@ -1,15 +1,10 @@
-import { DIRECT_PARENT_RULES, swiftwc, validate } from '../index.js';
-swiftwc.rules['allowed-tags'].meta.docs.description = 'Restrict allowed HTML tags';
-swiftwc.rules['allowed-tags'].meta.messages.disallowedTag = 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}';
-swiftwc.rules['allowed-tags'].create = (context) => {
-    return {
-        Tag(node) {
-            const tag = node.name;
-            const allowedParents = DIRECT_PARENT_RULES[tag];
-            if (!allowedParents)
-                return; // 👈 ignore unknown tags completely
-            validate(tag, (item) => item.parent, allowedParents, context, node);
-        },
-    };
-};
-export default swiftwc;
+import { createPlugin, getAllowedParents, validate } from '../index.js';
+const getParentName = (n) => (n.parent?.type === 'Tag' ? n.parent.name : undefined);
+export default createPlugin((context) => ({
+    Tag(node) {
+        const allowedParents = getAllowedParents(node.name);
+        if (!allowedParents)
+            return;
+        validate(node.name, getParentName, allowedParents, context, node);
+    },
+}));

package/generated/index.d.ts

@@ -1,12 +1,10 @@
 import type { RuleContext, RuleListener } from '@typescript-eslint/utils/ts-eslint';
-export type TagNode = {
-    name: string;
+export type BaseNode = {
     type: string;
-    parent?: TagNode;
 };
-export declare const DIRECT_PARENT_RULES: Record<string, string[]>;
-export declare function validate(tag: string, getParentTag: (node: TagNode) => TagNode | undefined, allowedParents: string[], context: RuleContext<string, readonly unknown[]>, node: TagNode): void;
-export declare const swiftwc: {
+export declare function getAllowedParents(tag: string): string[] | undefined;
+export declare function validate<N extends BaseNode>(tag: string, getParentTag: (node: N) => string | undefined, allowedParents: string[], context: RuleContext<string, readonly unknown[]>, node: N): void;
+export declare function createPlugin(create: (context: Readonly<RuleContext<string, readonly unknown[]>>) => RuleListener): {
     meta: {
         name: any;
         version: any;
@@ -26,7 +24,7 @@ export declare const swiftwc: {
                     disallowedTag: string;
                 };
             };
-            create(context: Readonly<RuleContext<string, readonly unknown[]>>): RuleListener;
+            create: (context: Readonly<RuleContext<string, readonly unknown[]>>) => RuleListener;
         };
     };
 };

package/generated/index.js

@@ -1,5 +1,5 @@
 import { readFileSync } from 'fs';
-export const DIRECT_PARENT_RULES = {
+const DIRECT_PARENT_RULES = {
     'v-keyboard': ['template', 'body'],
     'scroll-view': ['template', 'content-view', 'dialog', 'navigation-stack', 'navigation-split-view', 'detail-placeholder'],
     dialog: ['template', 'tab-view', 'navigation-split-view'],
@@ -8,23 +8,15 @@ export const DIRECT_PARENT_RULES = {
     'sidebar-toggle': ['template', 'tab-view', 'form', 'navigation-split-view', 'tool-bar'],
     'content-view': ['template', 'dialog', 'content-view', 'navigation-stack', 'navigation-split-view'],
 };
+export function getAllowedParents(tag) {
+    return Object.hasOwn(DIRECT_PARENT_RULES, tag) ? DIRECT_PARENT_RULES[tag] : undefined;
+}
 export function validate(tag, getParentTag, allowedParents, context, node) {
-    const parentTag = getParentTag(node);
-    if (parentTag?.type === node.type && allowedParents.includes(parentTag.name))
+    const parent = getParentTag(node);
+    if (parent && allowedParents.includes(parent))
         return;
-    // let parentTag = getParentTag(node),
-    //   isValid = false
-    // while (parentTag) {
-    //   if (parentTag.type === node.type && allowedParents.includes(parentTag.name)) {
-    //     isValid = true
-    //     break
-    //   }
-    //   parentTag = getParentTag(parentTag)
-    // }
-    // if (isValid) return
     context.report({
-        // @ts-expect-error
-        node,
+        node: node,
         messageId: 'disallowedTag',
         data: {
             tag,
@@ -33,100 +25,24 @@ export function validate(tag, getParentTag, allowedParents, context, node) {
     });
 }
 const { name, version } = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
-export const swiftwc = {
-    meta: {
-        name,
-        version,
-        namespace: 'swiftwc',
-    },
-    configs: {},
-    rules: {
-        'allowed-tags': {
-            meta: {
-                type: 'problem',
-                docs: {
-                    description: 'Restrict allowed HTML tags',
-                    url: `https://github.com/swiftwc/ui`,
-                },
-                // languages: ['html/html'],
-                schema: [],
-                // schema: [
-                //   {
-                //     type: 'object',
-                //     properties: {
-                //       allowed: {
-                //         type: 'array',
-                //         items: { type: 'string' },
-                //       },
-                //     },
-                //     additionalProperties: false,
-                //   },
-                // ],
-                messages: {
-                    disallowedTag: 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}',
+export function createPlugin(create) {
+    const plugin = {
+        meta: { name, version, namespace: 'swiftwc' },
+        configs: {},
+        rules: {
+            'allowed-tags': {
+                meta: {
+                    type: 'problem',
+                    docs: { description: 'Restrict allowed HTML tags', url: 'https://github.com/swiftwc/ui' },
+                    schema: [],
+                    messages: { disallowedTag: 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}' },
                 },
-            },
-            // create(context) {
-            //   const options = context.options?.[0] || {},
-            //     allowed = new Set(options.allowed || [...DEFAULT_ALLOWED])
-            //   return {
-            //     Tag(node) {
-            //       const tag = node.name
-            //       if (!allowed.has(tag)) {
-            //         context.report({
-            //           node,
-            //           messageId: 'disallowedTag',
-            //           data: {
-            //             tag,
-            //             allowed: [...allowed].join(', '),
-            //           },
-            //         })
-            //       }
-            //     },
-            //   }
-            // },
-            create(context) {
-                return {
-                    Tag(node) {
-                        const tag = node.name;
-                        const allowedParents = DIRECT_PARENT_RULES[tag];
-                        if (!allowedParents)
-                            return; // 👈 ignore unknown tags completely
-                        validate(tag, (item) => item.parent, allowedParents, context, node);
-                        // let parent = node.parent
-                        // let valid = false
-                        // while (parent) {
-                        //   if (parent.type === 'Tag' && allowedParents.includes(parent.name)) {
-                        //     valid = true
-                        //     break
-                        //   }
-                        //   parent = parent.parent
-                        // }
-                        // if (!valid) {
-                        //   context.report({
-                        //     node,
-                        //     messageId: 'disallowedTag',
-                        //     data: {
-                        //       tag,
-                        //       allowed: allowedParents.join(', '),
-                        //     },
-                        //   })
-                        // }
-                    },
-                };
+                create,
             },
         },
-    },
-};
-Object.assign(swiftwc.configs, {
-    recommended: [
-        {
-            plugins: {
-                swiftwc,
-            },
-            rules: {
-                'swiftwc/allowed-tags': 'error', //['error', { allowed: ['div', 'span', 'my-button', 'my-card'] }],
-            },
-        },
-    ],
-});
+    };
+    Object.assign(plugin.configs, {
+        recommended: [{ plugins: { swiftwc: plugin }, rules: { 'swiftwc/allowed-tags': 'error' } }],
+    });
+    return plugin;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swiftwc/eslint-plugin",
-  "version": "1.1.7-canary.0",
+  "version": "1.1.7-canary.1",
   "description": "Rules enforcing best practices while using SwiftWC.",
   "keywords": [
     "eslint",

package/src/emberjs/en.ts

@@ -1,24 +1,24 @@
-import type { RuleContext, RuleListener } from '@typescript-eslint/utils/ts-eslint'
-import { DIRECT_PARENT_RULES, swiftwc, validate, type TagNode } from '../index.js'
+import { createPlugin, getAllowedParents, validate } from '../index.js'
 
-swiftwc.rules['allowed-tags'].meta.docs.description = 'Restrict allowed HTML tags'
+type GlimmerNode = { type: string; tag?: string; parent?: GlimmerNode }
 
-swiftwc.rules['allowed-tags'].meta.messages.disallowedTag = 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}'
-
-swiftwc.rules['allowed-tags'].create = (context: Readonly<RuleContext<string, readonly unknown[]>>): RuleListener => {
-  return {
-    // '*': (node) => {
-    // if('GlimmerElementNode' !== node.type) return
-    GlimmerElementNode(node: TagNode) {
-      // @ts-expect-error
-      const tag = node.tag
-
-      const allowedParents = DIRECT_PARENT_RULES[tag]
-      if (!allowedParents) return // 👈 ignore unknown tags completely
-
-      validate(tag, (item) => item.parent, allowedParents, context, node)
-    },
+/** Nearest real element ancestor; skips {{#let}}/{{#if}}/{{#each}} blocks, mustaches, text. */
+/** This still accepts content-view, div and scroll-view, and rejects Foo, :header, @arg, this.foo and foo.bar. */
+function getParentName(n: GlimmerNode): string | undefined {
+  for (let p = n.parent; p; p = p.parent) {
+    if (p.type === 'GlimmerElementNode' && /^[a-z][\w-]*$/.test(p.tag!)) return p.tag
+    if (p.type === 'GlimmerTemplate') return 'template'
   }
+  return undefined
 }
 
-export default swiftwc
+export default createPlugin((context) => ({
+  // '*': (node) => {
+  // if('GlimmerElementNode' !== node.type) return
+  GlimmerElementNode(node: GlimmerNode) {
+    const allowedParents = getAllowedParents(node.tag!)
+    if (!allowedParents) return
+
+    validate(node.tag!, getParentName, allowedParents, context, node)
+  },
+}))

package/src/html/en.ts

@@ -1,21 +1,14 @@
-import type { RuleContext, RuleListener } from '@typescript-eslint/utils/ts-eslint'
-import { DIRECT_PARENT_RULES, swiftwc, validate, type TagNode } from '../index.js'
+import { createPlugin, getAllowedParents, validate } from '../index.js'
 
-swiftwc.rules['allowed-tags'].meta.docs.description = 'Restrict allowed HTML tags'
+type HtmlNode = { type: 'Tag'; name: string; parent?: { type: string; name?: string } }
 
-swiftwc.rules['allowed-tags'].meta.messages.disallowedTag = 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}'
+const getParentName = (n: HtmlNode) => (n.parent?.type === 'Tag' ? n.parent.name : undefined)
 
-swiftwc.rules['allowed-tags'].create = (context: Readonly<RuleContext<string, readonly unknown[]>>): RuleListener => {
-  return {
-    Tag(node: TagNode) {
-      const tag = node.name
+export default createPlugin((context) => ({
+  Tag(node: HtmlNode) {
+    const allowedParents = getAllowedParents(node.name)
+    if (!allowedParents) return
 
-      const allowedParents = DIRECT_PARENT_RULES[tag]
-      if (!allowedParents) return // 👈 ignore unknown tags completely
-
-      validate(tag, (item) => item.parent, allowedParents, context, node)
-    },
-  }
-}
-
-export default swiftwc
+    validate(node.name, getParentName, allowedParents, context, node)
+  },
+}))

package/src/index.ts

@@ -1,13 +1,10 @@
+import type { TSESTree } from '@typescript-eslint/utils'
 import type { Linter, RuleContext, RuleListener } from '@typescript-eslint/utils/ts-eslint'
 import { readFileSync } from 'fs'
 
-export type TagNode = {
-  name: string
-  type: string
-  parent?: TagNode
-}
+export type BaseNode = { type: string }
 
-export const DIRECT_PARENT_RULES: Record<string, string[]> = {
+const DIRECT_PARENT_RULES: Record<string, string[]> = {
   'v-keyboard': ['template', 'body'],
 
   'scroll-view': ['template', 'content-view', 'dialog', 'navigation-stack', 'navigation-split-view', 'detail-placeholder'],
@@ -23,32 +20,22 @@ export const DIRECT_PARENT_RULES: Record<string, string[]> = {
   'content-view': ['template', 'dialog', 'content-view', 'navigation-stack', 'navigation-split-view'],
 }
 
-export function validate(
+export function getAllowedParents(tag: string): string[] | undefined {
+  return Object.hasOwn(DIRECT_PARENT_RULES, tag) ? DIRECT_PARENT_RULES[tag] : undefined
+}
+
+export function validate<N extends BaseNode>(
   tag: string,
-  getParentTag: (node: TagNode) => TagNode | undefined,
+  getParentTag: (node: N) => string | undefined,
   allowedParents: string[],
   context: RuleContext<string, readonly unknown[]>,
-  node: TagNode
+  node: N
 ) {
-  const parentTag = getParentTag(node)
-
-  if (parentTag?.type === node.type && allowedParents.includes(parentTag.name)) return
-
-  // let parentTag = getParentTag(node),
-  //   isValid = false
-  // while (parentTag) {
-  //   if (parentTag.type === node.type && allowedParents.includes(parentTag.name)) {
-  //     isValid = true
-  //     break
-  //   }
-  //   parentTag = getParentTag(parentTag)
-  // }
-
-  // if (isValid) return
+  const parent = getParentTag(node)
+  if (parent && allowedParents.includes(parent)) return
 
   context.report({
-    // @ts-expect-error
-    node,
+    node: node as unknown as TSESTree.Node,
     messageId: 'disallowedTag',
     data: {
       tag,
@@ -59,108 +46,26 @@ export function validate(
 
 const { name, version } = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'))
 
-export const swiftwc = {
-  meta: {
-    name,
-    version,
-    namespace: 'swiftwc',
-  },
-  configs: {},
-  rules: {
-    'allowed-tags': {
-      meta: {
-        type: 'problem',
-        docs: {
-          description: 'Restrict allowed HTML tags',
-          url: `https://github.com/swiftwc/ui`,
+export function createPlugin(create: (context: Readonly<RuleContext<string, readonly unknown[]>>) => RuleListener) {
+  const plugin = {
+    meta: { name, version, namespace: 'swiftwc' },
+    configs: {},
+    rules: {
+      'allowed-tags': {
+        meta: {
+          type: 'problem',
+          docs: { description: 'Restrict allowed HTML tags', url: 'https://github.com/swiftwc/ui' },
+          schema: [],
+          messages: { disallowedTag: 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}' },
         },
-        // languages: ['html/html'],
-        schema: [],
-        // schema: [
-        //   {
-        //     type: 'object',
-        //     properties: {
-        //       allowed: {
-        //         type: 'array',
-        //         items: { type: 'string' },
-        //       },
-        //     },
-        //     additionalProperties: false,
-        //   },
-        // ],
-        messages: {
-          disallowedTag: 'Tag <{{tag}}> is only allowed inside any of: {{allowed}}',
-        },
-      },
-
-      // create(context) {
-      //   const options = context.options?.[0] || {},
-      //     allowed = new Set(options.allowed || [...DEFAULT_ALLOWED])
-
-      //   return {
-      //     Tag(node) {
-      //       const tag = node.name
-      //       if (!allowed.has(tag)) {
-      //         context.report({
-      //           node,
-      //           messageId: 'disallowedTag',
-      //           data: {
-      //             tag,
-      //             allowed: [...allowed].join(', '),
-      //           },
-      //         })
-      //       }
-      //     },
-      //   }
-      // },
-
-      create(context: Readonly<RuleContext<string, readonly unknown[]>>): RuleListener {
-        return {
-          Tag(node: TagNode) {
-            const tag = node.name
-
-            const allowedParents = DIRECT_PARENT_RULES[tag]
-            if (!allowedParents) return // 👈 ignore unknown tags completely
-
-            validate(tag, (item) => item.parent, allowedParents, context, node)
-
-            // let parent = node.parent
-            // let valid = false
-
-            // while (parent) {
-            //   if (parent.type === 'Tag' && allowedParents.includes(parent.name)) {
-            //     valid = true
-            //     break
-            //   }
-            //   parent = parent.parent
-            // }
-
-            // if (!valid) {
-            //   context.report({
-            //     node,
-            //     messageId: 'disallowedTag',
-            //     data: {
-            //       tag,
-            //       allowed: allowedParents.join(', '),
-            //     },
-            //   })
-            // }
-          },
-        }
+        create,
       },
     },
-  },
-} satisfies Linter.Plugin
+  } satisfies Linter.Plugin
 
-Object.assign(swiftwc.configs, {
-  recommended: [
-    {
-      plugins: {
-        swiftwc,
-      },
-      rules: {
-        'swiftwc/allowed-tags': 'error', //['error', { allowed: ['div', 'span', 'my-button', 'my-card'] }],
-      },
-    },
-  ],
-})
+  Object.assign(plugin.configs, {
+    recommended: [{ plugins: { swiftwc: plugin }, rules: { 'swiftwc/allowed-tags': 'error' } }],
+  })
+
+  return plugin
+}