@prairielearn/eslint-plugin 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @prairielearn/eslint-plugin
 
+## 4.3.0
+
+### Minor Changes
+
+- 9717de9: Add a new rule `@prairielearn/html-no-duplicate-id`. It's a variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start with `pl-`, since the `id` attribute on PrairieLearn elements (e.g. `<pl-sketch-tool id="fd">`) is an element-scoped identifier consumed by the parent element, not a DOM id. It also ignores `id` values that contain mustache template parameters.
+
+### Patch Changes
+
+- 3927197: Update dependencies
+
 ## 4.2.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -2,6 +2,7 @@ declare const _default: {
     rules: {
         'aws-client-mandatory-config': import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingConfig", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         'aws-client-shared-config': import("@typescript-eslint/utils/ts-eslint").RuleModule<"improperConfig" | "unknownConfig", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'html-no-duplicate-id': import("@typescript-eslint/utils/ts-eslint").RuleModule<"duplicateId", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         'jsx-no-dollar-interpolation': import("@typescript-eslint/utils/ts-eslint").RuleModule<"dollarInterpolationNotAllowed", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         'no-current-target-in-callback': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noCurrentTargetInCallback", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         'no-hydrate-reslocals': import("@typescript-eslint/utils/ts-eslint").RuleModule<"forbiddenProp" | "forbiddenSpread", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\nimport noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';\nimport noHydrateResLocals from './rules/no-hydrate-reslocals.js';\nimport noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';\nimport requireTrpcPermissionMiddleware from './rules/require-trpc-permission-middleware.js';\nimport safeDbTypes from './rules/safe-db-types.js';\n\nconst rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n  'no-current-target-in-callback': noCurrentTargetInCallback,\n  'no-hydrate-reslocals': noHydrateResLocals,\n  'no-unused-sql-blocks': noUnusedSqlBlocks,\n  'require-trpc-permission-middleware': requireTrpcPermissionMiddleware,\n  'safe-db-types': safeDbTypes,\n};\n\nexport default { rules };\n"]}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport htmlNoDuplicateId from './rules/html-no-duplicate-id.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\nimport noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';\nimport noHydrateResLocals from './rules/no-hydrate-reslocals.js';\nimport noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';\nimport requireTrpcPermissionMiddleware from './rules/require-trpc-permission-middleware.js';\nimport safeDbTypes from './rules/safe-db-types.js';\n\nconst rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'html-no-duplicate-id': htmlNoDuplicateId,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n  'no-current-target-in-callback': noCurrentTargetInCallback,\n  'no-hydrate-reslocals': noHydrateResLocals,\n  'no-unused-sql-blocks': noUnusedSqlBlocks,\n  'require-trpc-permission-middleware': requireTrpcPermissionMiddleware,\n  'safe-db-types': safeDbTypes,\n};\n\nexport default { rules };\n"]}

package/dist/index.js

@@ -1,5 +1,6 @@
 import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';
 import awsClientSharedConfig from './rules/aws-client-shared-config.js';
+import htmlNoDuplicateId from './rules/html-no-duplicate-id.js';
 import jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';
 import noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';
 import noHydrateResLocals from './rules/no-hydrate-reslocals.js';
@@ -9,6 +10,7 @@ import safeDbTypes from './rules/safe-db-types.js';
 const rules = {
     'aws-client-mandatory-config': awsClientMandatoryConfig,
     'aws-client-shared-config': awsClientSharedConfig,
+    'html-no-duplicate-id': htmlNoDuplicateId,
     'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,
     'no-current-target-in-callback': noCurrentTargetInCallback,
     'no-hydrate-reslocals': noHydrateResLocals,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,wBAAwB,MAAM,wCAAwC,CAAC;AAC9E,OAAO,qBAAqB,MAAM,qCAAqC,CAAC;AACxE,OAAO,wBAAwB,MAAM,wCAAwC,CAAC;AAC9E,OAAO,yBAAyB,MAAM,0CAA0C,CAAC;AACjF,OAAO,kBAAkB,MAAM,iCAAiC,CAAC;AACjE,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,+BAA+B,MAAM,+CAA+C,CAAC;AAC5F,OAAO,WAAW,MAAM,0BAA0B,CAAC;AAEnD,MAAM,KAAK,GAAG;IACZ,6BAA6B,EAAE,wBAAwB;IACvD,0BAA0B,EAAE,qBAAqB;IACjD,6BAA6B,EAAE,wBAAwB;IACvD,+BAA+B,EAAE,yBAAyB;IAC1D,sBAAsB,EAAE,kBAAkB;IAC1C,sBAAsB,EAAE,iBAAiB;IACzC,oCAAoC,EAAE,+BAA+B;IACrE,eAAe,EAAE,WAAW;CAC7B,CAAC;AAEF,eAAe,EAAE,KAAK,EAAE,CAAC","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\nimport noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';\nimport noHydrateResLocals from './rules/no-hydrate-reslocals.js';\nimport noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';\nimport requireTrpcPermissionMiddleware from './rules/require-trpc-permission-middleware.js';\nimport safeDbTypes from './rules/safe-db-types.js';\n\nconst rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n  'no-current-target-in-callback': noCurrentTargetInCallback,\n  'no-hydrate-reslocals': noHydrateResLocals,\n  'no-unused-sql-blocks': noUnusedSqlBlocks,\n  'require-trpc-permission-middleware': requireTrpcPermissionMiddleware,\n  'safe-db-types': safeDbTypes,\n};\n\nexport default { rules };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,wBAAwB,MAAM,wCAAwC,CAAC;AAC9E,OAAO,qBAAqB,MAAM,qCAAqC,CAAC;AACxE,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,wBAAwB,MAAM,wCAAwC,CAAC;AAC9E,OAAO,yBAAyB,MAAM,0CAA0C,CAAC;AACjF,OAAO,kBAAkB,MAAM,iCAAiC,CAAC;AACjE,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,+BAA+B,MAAM,+CAA+C,CAAC;AAC5F,OAAO,WAAW,MAAM,0BAA0B,CAAC;AAEnD,MAAM,KAAK,GAAG;IACZ,6BAA6B,EAAE,wBAAwB;IACvD,0BAA0B,EAAE,qBAAqB;IACjD,sBAAsB,EAAE,iBAAiB;IACzC,6BAA6B,EAAE,wBAAwB;IACvD,+BAA+B,EAAE,yBAAyB;IAC1D,sBAAsB,EAAE,kBAAkB;IAC1C,sBAAsB,EAAE,iBAAiB;IACzC,oCAAoC,EAAE,+BAA+B;IACrE,eAAe,EAAE,WAAW;CAC7B,CAAC;AAEF,eAAe,EAAE,KAAK,EAAE,CAAC","sourcesContent":["import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';\nimport awsClientSharedConfig from './rules/aws-client-shared-config.js';\nimport htmlNoDuplicateId from './rules/html-no-duplicate-id.js';\nimport jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';\nimport noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';\nimport noHydrateResLocals from './rules/no-hydrate-reslocals.js';\nimport noUnusedSqlBlocks from './rules/no-unused-sql-blocks.js';\nimport requireTrpcPermissionMiddleware from './rules/require-trpc-permission-middleware.js';\nimport safeDbTypes from './rules/safe-db-types.js';\n\nconst rules = {\n  'aws-client-mandatory-config': awsClientMandatoryConfig,\n  'aws-client-shared-config': awsClientSharedConfig,\n  'html-no-duplicate-id': htmlNoDuplicateId,\n  'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,\n  'no-current-target-in-callback': noCurrentTargetInCallback,\n  'no-hydrate-reslocals': noHydrateResLocals,\n  'no-unused-sql-blocks': noUnusedSqlBlocks,\n  'require-trpc-permission-middleware': requireTrpcPermissionMiddleware,\n  'safe-db-types': safeDbTypes,\n};\n\nexport default { rules };\n"]}

package/dist/rules/html-no-duplicate-id.d.ts

@@ -0,0 +1,10 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+/**
+ * Variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start
+ * with `pl-`. The `id` attribute on PrairieLearn elements (e.g. `pl-sketch-tool
+ * id="fd"`) is not a DOM id, it's an element-specific identifier consumed by
+ * the parent element, so duplicates across separate parents are legal.
+ */
+declare const _default: ESLintUtils.RuleModule<"duplicateId", [], unknown, ESLintUtils.RuleListener>;
+export default _default;
+//# sourceMappingURL=html-no-duplicate-id.d.ts.map

package/dist/rules/html-no-duplicate-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-no-duplicate-id.d.ts","sourceRoot":"","sources":["../../src/rules/html-no-duplicate-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAiCvD;;;;;GAKG","sourcesContent":["import { ESLintUtils } from '@typescript-eslint/utils';\n\ninterface AttributeValueNode {\n  type: 'AttributeValue';\n  value: string;\n  parts?: { type: string }[];\n}\n\ninterface AttributeKeyNode {\n  type: 'AttributeKey';\n  value: string;\n}\n\ninterface AttributeNode {\n  type: 'Attribute';\n  key: AttributeKeyNode;\n  value?: AttributeValueNode;\n}\n\ninterface TagNode {\n  type: 'Tag';\n  name: string;\n  attributes: AttributeNode[];\n}\n\nfunction findIdAttr(node: TagNode): AttributeNode | undefined {\n  return node.attributes.find((attr) => attr.key && attr.key.value.toLowerCase() === 'id');\n}\n\nfunction hasTemplatePart(node: AttributeValueNode): boolean {\n  return node.parts?.some((part) => part.type === 'Template') ?? false;\n}\n\n/**\n * Variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start\n * with `pl-`. The `id` attribute on PrairieLearn elements (e.g. `pl-sketch-tool\n * id=\"fd\"`) is not a DOM id, it's an element-specific identifier consumed by\n * the parent element, so duplicates across separate parents are legal.\n */\nexport default ESLintUtils.RuleCreator.withoutDocs({\n  meta: {\n    type: 'problem',\n    messages: {\n      duplicateId: \"The id '{{id}}' is duplicated.\",\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n  create(context) {\n    const idAttrs = new Map<string, AttributeValueNode[]>();\n\n    return {\n      Tag(node: TagNode) {\n        if (node.name.toLowerCase().startsWith('pl-')) return;\n        const idAttr = findIdAttr(node);\n        if (!idAttr?.value) return;\n        if (hasTemplatePart(idAttr.value)) return;\n        const list = idAttrs.get(idAttr.value.value) ?? [];\n        list.push(idAttr.value);\n        idAttrs.set(idAttr.value.value, list);\n      },\n      'Document:exit'() {\n        for (const attrs of idAttrs.values()) {\n          if (attrs.length <= 1) continue;\n          for (const attr of attrs) {\n            context.report({\n              node: attr as never,\n              data: { id: attr.value },\n              messageId: 'duplicateId',\n            });\n          }\n        }\n      },\n    };\n  },\n});\n"]}

package/dist/rules/html-no-duplicate-id.js

@@ -0,0 +1,54 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+function findIdAttr(node) {
+    return node.attributes.find((attr) => attr.key && attr.key.value.toLowerCase() === 'id');
+}
+function hasTemplatePart(node) {
+    return node.parts?.some((part) => part.type === 'Template') ?? false;
+}
+/**
+ * Variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start
+ * with `pl-`. The `id` attribute on PrairieLearn elements (e.g. `pl-sketch-tool
+ * id="fd"`) is not a DOM id, it's an element-specific identifier consumed by
+ * the parent element, so duplicates across separate parents are legal.
+ */
+export default ESLintUtils.RuleCreator.withoutDocs({
+    meta: {
+        type: 'problem',
+        messages: {
+            duplicateId: "The id '{{id}}' is duplicated.",
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        const idAttrs = new Map();
+        return {
+            Tag(node) {
+                if (node.name.toLowerCase().startsWith('pl-'))
+                    return;
+                const idAttr = findIdAttr(node);
+                if (!idAttr?.value)
+                    return;
+                if (hasTemplatePart(idAttr.value))
+                    return;
+                const list = idAttrs.get(idAttr.value.value) ?? [];
+                list.push(idAttr.value);
+                idAttrs.set(idAttr.value.value, list);
+            },
+            'Document:exit'() {
+                for (const attrs of idAttrs.values()) {
+                    if (attrs.length <= 1)
+                        continue;
+                    for (const attr of attrs) {
+                        context.report({
+                            node: attr,
+                            data: { id: attr.value },
+                            messageId: 'duplicateId',
+                        });
+                    }
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=html-no-duplicate-id.js.map

package/dist/rules/html-no-duplicate-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-no-duplicate-id.js","sourceRoot":"","sources":["../../src/rules/html-no-duplicate-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAyBvD,SAAS,UAAU,CAAC,IAAa;IAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,eAAe,CAAC,IAAwB;IAC/C,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,KAAK,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,eAAe,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE;YACR,WAAW,EAAE,gCAAgC;SAC9C;QACD,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,IAAI,GAAG,EAAgC,CAAC;QAExD,OAAO;YACL,GAAG,CAAC,IAAa;gBACf,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;oBAAE,OAAO;gBACtD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAChC,IAAI,CAAC,MAAM,EAAE,KAAK;oBAAE,OAAO;gBAC3B,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC;oBAAE,OAAO;gBAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBACnD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACxC,CAAC;YACD,eAAe;gBACb,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;oBACrC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;wBAAE,SAAS;oBAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBACzB,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI,EAAE,IAAa;4BACnB,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE;4BACxB,SAAS,EAAE,aAAa;yBACzB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import { ESLintUtils } from '@typescript-eslint/utils';\n\ninterface AttributeValueNode {\n  type: 'AttributeValue';\n  value: string;\n  parts?: { type: string }[];\n}\n\ninterface AttributeKeyNode {\n  type: 'AttributeKey';\n  value: string;\n}\n\ninterface AttributeNode {\n  type: 'Attribute';\n  key: AttributeKeyNode;\n  value?: AttributeValueNode;\n}\n\ninterface TagNode {\n  type: 'Tag';\n  name: string;\n  attributes: AttributeNode[];\n}\n\nfunction findIdAttr(node: TagNode): AttributeNode | undefined {\n  return node.attributes.find((attr) => attr.key && attr.key.value.toLowerCase() === 'id');\n}\n\nfunction hasTemplatePart(node: AttributeValueNode): boolean {\n  return node.parts?.some((part) => part.type === 'Template') ?? false;\n}\n\n/**\n * Variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start\n * with `pl-`. The `id` attribute on PrairieLearn elements (e.g. `pl-sketch-tool\n * id=\"fd\"`) is not a DOM id, it's an element-specific identifier consumed by\n * the parent element, so duplicates across separate parents are legal.\n */\nexport default ESLintUtils.RuleCreator.withoutDocs({\n  meta: {\n    type: 'problem',\n    messages: {\n      duplicateId: \"The id '{{id}}' is duplicated.\",\n    },\n    schema: [],\n  },\n  defaultOptions: [],\n  create(context) {\n    const idAttrs = new Map<string, AttributeValueNode[]>();\n\n    return {\n      Tag(node: TagNode) {\n        if (node.name.toLowerCase().startsWith('pl-')) return;\n        const idAttr = findIdAttr(node);\n        if (!idAttr?.value) return;\n        if (hasTemplatePart(idAttr.value)) return;\n        const list = idAttrs.get(idAttr.value.value) ?? [];\n        list.push(idAttr.value);\n        idAttrs.set(idAttr.value.value, list);\n      },\n      'Document:exit'() {\n        for (const attrs of idAttrs.values()) {\n          if (attrs.length <= 1) continue;\n          for (const attr of attrs) {\n            context.report({\n              node: attr as never,\n              data: { id: attr.value },\n              messageId: 'duplicateId',\n            });\n          }\n        }\n      },\n    };\n  },\n});\n"]}

package/dist/tests/html-no-duplicate-id.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=html-no-duplicate-id.test.d.ts.map

package/dist/tests/html-no-duplicate-id.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-no-duplicate-id.test.d.ts","sourceRoot":"","sources":["../../src/tests/html-no-duplicate-id.test.ts"],"names":[],"mappings":"","sourcesContent":["import htmlParser from '@html-eslint/parser';\nimport { RuleTester } from '@typescript-eslint/rule-tester';\nimport { afterAll, describe, it } from 'vitest';\n\nimport rule from '../rules/html-no-duplicate-id.js';\n\nRuleTester.afterAll = afterAll;\nRuleTester.describe = describe;\nRuleTester.it = it;\n\nconst ruleTester = new RuleTester({\n  languageOptions: {\n    parser: htmlParser,\n    parserOptions: {\n      templateEngineSyntax: htmlParser.TEMPLATE_ENGINE_SYNTAX.HANDLEBAR,\n    },\n  },\n});\n\nruleTester.run('html-no-duplicate-id', rule, {\n  valid: [\n    {\n      code: '<div id=\"a\"></div><div id=\"b\"></div>',\n    },\n    // Duplicate `id` on `pl-*` elements is a tool/element identifier, not a\n    // DOM id, so it should be ignored.\n    {\n      code: `\n        <pl-sketch>\n          <pl-sketch-tool id=\"fd\" type=\"free-draw\"></pl-sketch-tool>\n        </pl-sketch>\n        <pl-sketch>\n          <pl-sketch-tool id=\"fd\" type=\"free-draw\"></pl-sketch-tool>\n        </pl-sketch>`,\n    },\n    {\n      code: '<div id=\"question-{{params.name}}\"></div><span id=\"question-{{params.name}}\"></span>',\n    },\n  ],\n  invalid: [\n    {\n      code: '<div id=\"x\"></div><div id=\"x\"></div>',\n      errors: [\n        { messageId: 'duplicateId', data: { id: 'x' } },\n        { messageId: 'duplicateId', data: { id: 'x' } },\n      ],\n    },\n    // Duplicate `id` on non-`pl-*` elements should be reported.\n    {\n      code: '<div id=\"fd\"></div><span id=\"fd\"></span>',\n      errors: [\n        { messageId: 'duplicateId', data: { id: 'fd' } },\n        { messageId: 'duplicateId', data: { id: 'fd' } },\n      ],\n    },\n  ],\n});\n"]}

package/dist/tests/html-no-duplicate-id.test.js

@@ -0,0 +1,54 @@
+import htmlParser from '@html-eslint/parser';
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import { afterAll, describe, it } from 'vitest';
+import rule from '../rules/html-no-duplicate-id.js';
+RuleTester.afterAll = afterAll;
+RuleTester.describe = describe;
+RuleTester.it = it;
+const ruleTester = new RuleTester({
+    languageOptions: {
+        parser: htmlParser,
+        parserOptions: {
+            templateEngineSyntax: htmlParser.TEMPLATE_ENGINE_SYNTAX.HANDLEBAR,
+        },
+    },
+});
+ruleTester.run('html-no-duplicate-id', rule, {
+    valid: [
+        {
+            code: '<div id="a"></div><div id="b"></div>',
+        },
+        // Duplicate `id` on `pl-*` elements is a tool/element identifier, not a
+        // DOM id, so it should be ignored.
+        {
+            code: `
+        <pl-sketch>
+          <pl-sketch-tool id="fd" type="free-draw"></pl-sketch-tool>
+        </pl-sketch>
+        <pl-sketch>
+          <pl-sketch-tool id="fd" type="free-draw"></pl-sketch-tool>
+        </pl-sketch>`,
+        },
+        {
+            code: '<div id="question-{{params.name}}"></div><span id="question-{{params.name}}"></span>',
+        },
+    ],
+    invalid: [
+        {
+            code: '<div id="x"></div><div id="x"></div>',
+            errors: [
+                { messageId: 'duplicateId', data: { id: 'x' } },
+                { messageId: 'duplicateId', data: { id: 'x' } },
+            ],
+        },
+        // Duplicate `id` on non-`pl-*` elements should be reported.
+        {
+            code: '<div id="fd"></div><span id="fd"></span>',
+            errors: [
+                { messageId: 'duplicateId', data: { id: 'fd' } },
+                { messageId: 'duplicateId', data: { id: 'fd' } },
+            ],
+        },
+    ],
+});
+//# sourceMappingURL=html-no-duplicate-id.test.js.map

package/dist/tests/html-no-duplicate-id.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-no-duplicate-id.test.js","sourceRoot":"","sources":["../../src/tests/html-no-duplicate-id.test.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEhD,OAAO,IAAI,MAAM,kCAAkC,CAAC;AAEpD,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;AAEnB,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC;IAChC,eAAe,EAAE;QACf,MAAM,EAAE,UAAU;QAClB,aAAa,EAAE;YACb,oBAAoB,EAAE,UAAU,CAAC,sBAAsB,CAAC,SAAS;SAClE;KACF;CACF,CAAC,CAAC;AAEH,UAAU,CAAC,GAAG,CAAC,sBAAsB,EAAE,IAAI,EAAE;IAC3C,KAAK,EAAE;QACL;YACE,IAAI,EAAE,sCAAsC;SAC7C;QACD,wEAAwE;QACxE,mCAAmC;QACnC;YACE,IAAI,EAAE;;;;;;qBAMS;SAChB;QACD;YACE,IAAI,EAAE,sFAAsF;SAC7F;KACF;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,sCAAsC;YAC5C,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;gBAC/C,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE;aAChD;SACF;QACD,4DAA4D;QAC5D;YACE,IAAI,EAAE,0CAA0C;YAChD,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;gBAChD,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;aACjD;SACF;KACF;CACF,CAAC,CAAC","sourcesContent":["import htmlParser from '@html-eslint/parser';\nimport { RuleTester } from '@typescript-eslint/rule-tester';\nimport { afterAll, describe, it } from 'vitest';\n\nimport rule from '../rules/html-no-duplicate-id.js';\n\nRuleTester.afterAll = afterAll;\nRuleTester.describe = describe;\nRuleTester.it = it;\n\nconst ruleTester = new RuleTester({\n  languageOptions: {\n    parser: htmlParser,\n    parserOptions: {\n      templateEngineSyntax: htmlParser.TEMPLATE_ENGINE_SYNTAX.HANDLEBAR,\n    },\n  },\n});\n\nruleTester.run('html-no-duplicate-id', rule, {\n  valid: [\n    {\n      code: '<div id=\"a\"></div><div id=\"b\"></div>',\n    },\n    // Duplicate `id` on `pl-*` elements is a tool/element identifier, not a\n    // DOM id, so it should be ignored.\n    {\n      code: `\n        <pl-sketch>\n          <pl-sketch-tool id=\"fd\" type=\"free-draw\"></pl-sketch-tool>\n        </pl-sketch>\n        <pl-sketch>\n          <pl-sketch-tool id=\"fd\" type=\"free-draw\"></pl-sketch-tool>\n        </pl-sketch>`,\n    },\n    {\n      code: '<div id=\"question-{{params.name}}\"></div><span id=\"question-{{params.name}}\"></span>',\n    },\n  ],\n  invalid: [\n    {\n      code: '<div id=\"x\"></div><div id=\"x\"></div>',\n      errors: [\n        { messageId: 'duplicateId', data: { id: 'x' } },\n        { messageId: 'duplicateId', data: { id: 'x' } },\n      ],\n    },\n    // Duplicate `id` on non-`pl-*` elements should be reported.\n    {\n      code: '<div id=\"fd\"></div><span id=\"fd\"></span>',\n      errors: [\n        { messageId: 'duplicateId', data: { id: 'fd' } },\n        { messageId: 'duplicateId', data: { id: 'fd' } },\n      ],\n    },\n  ],\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/eslint-plugin",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -24,13 +24,13 @@
     "typescript": "^6.0.3"
   },
   "devDependencies": {
+    "@html-eslint/parser": "^0.58.1",
     "@prairielearn/tsconfig": "^2.1.0",
     "@types/node": "^24.12.2",
     "@typescript-eslint/rule-tester": "^8.59.2",
     "@typescript-eslint/types": "^8.59.2",
     "@typescript/native-preview": "beta",
     "@vitest/coverage-v8": "^4.1.5",
-    "tsx": "^4.21.0",
     "vitest": "^4.1.5"
   }
 }

package/src/index.ts

@@ -1,5 +1,6 @@
 import awsClientMandatoryConfig from './rules/aws-client-mandatory-config.js';
 import awsClientSharedConfig from './rules/aws-client-shared-config.js';
+import htmlNoDuplicateId from './rules/html-no-duplicate-id.js';
 import jsxNoDollarInterpolation from './rules/jsx-no-dollar-interpolation.js';
 import noCurrentTargetInCallback from './rules/no-current-target-in-callback.js';
 import noHydrateResLocals from './rules/no-hydrate-reslocals.js';
@@ -10,6 +11,7 @@ import safeDbTypes from './rules/safe-db-types.js';
 const rules = {
   'aws-client-mandatory-config': awsClientMandatoryConfig,
   'aws-client-shared-config': awsClientSharedConfig,
+  'html-no-duplicate-id': htmlNoDuplicateId,
   'jsx-no-dollar-interpolation': jsxNoDollarInterpolation,
   'no-current-target-in-callback': noCurrentTargetInCallback,
   'no-hydrate-reslocals': noHydrateResLocals,

package/src/rules/html-no-duplicate-id.ts

@@ -0,0 +1,76 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+interface AttributeValueNode {
+  type: 'AttributeValue';
+  value: string;
+  parts?: { type: string }[];
+}
+
+interface AttributeKeyNode {
+  type: 'AttributeKey';
+  value: string;
+}
+
+interface AttributeNode {
+  type: 'Attribute';
+  key: AttributeKeyNode;
+  value?: AttributeValueNode;
+}
+
+interface TagNode {
+  type: 'Tag';
+  name: string;
+  attributes: AttributeNode[];
+}
+
+function findIdAttr(node: TagNode): AttributeNode | undefined {
+  return node.attributes.find((attr) => attr.key && attr.key.value.toLowerCase() === 'id');
+}
+
+function hasTemplatePart(node: AttributeValueNode): boolean {
+  return node.parts?.some((part) => part.type === 'Template') ?? false;
+}
+
+/**
+ * Variant of `@html-eslint/no-duplicate-id` that ignores tags whose names start
+ * with `pl-`. The `id` attribute on PrairieLearn elements (e.g. `pl-sketch-tool
+ * id="fd"`) is not a DOM id, it's an element-specific identifier consumed by
+ * the parent element, so duplicates across separate parents are legal.
+ */
+export default ESLintUtils.RuleCreator.withoutDocs({
+  meta: {
+    type: 'problem',
+    messages: {
+      duplicateId: "The id '{{id}}' is duplicated.",
+    },
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const idAttrs = new Map<string, AttributeValueNode[]>();
+
+    return {
+      Tag(node: TagNode) {
+        if (node.name.toLowerCase().startsWith('pl-')) return;
+        const idAttr = findIdAttr(node);
+        if (!idAttr?.value) return;
+        if (hasTemplatePart(idAttr.value)) return;
+        const list = idAttrs.get(idAttr.value.value) ?? [];
+        list.push(idAttr.value);
+        idAttrs.set(idAttr.value.value, list);
+      },
+      'Document:exit'() {
+        for (const attrs of idAttrs.values()) {
+          if (attrs.length <= 1) continue;
+          for (const attr of attrs) {
+            context.report({
+              node: attr as never,
+              data: { id: attr.value },
+              messageId: 'duplicateId',
+            });
+          }
+        }
+      },
+    };
+  },
+});

package/src/tests/html-no-duplicate-id.test.ts

@@ -0,0 +1,57 @@
+import htmlParser from '@html-eslint/parser';
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import { afterAll, describe, it } from 'vitest';
+
+import rule from '../rules/html-no-duplicate-id.js';
+
+RuleTester.afterAll = afterAll;
+RuleTester.describe = describe;
+RuleTester.it = it;
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    parser: htmlParser,
+    parserOptions: {
+      templateEngineSyntax: htmlParser.TEMPLATE_ENGINE_SYNTAX.HANDLEBAR,
+    },
+  },
+});
+
+ruleTester.run('html-no-duplicate-id', rule, {
+  valid: [
+    {
+      code: '<div id="a"></div><div id="b"></div>',
+    },
+    // Duplicate `id` on `pl-*` elements is a tool/element identifier, not a
+    // DOM id, so it should be ignored.
+    {
+      code: `
+        <pl-sketch>
+          <pl-sketch-tool id="fd" type="free-draw"></pl-sketch-tool>
+        </pl-sketch>
+        <pl-sketch>
+          <pl-sketch-tool id="fd" type="free-draw"></pl-sketch-tool>
+        </pl-sketch>`,
+    },
+    {
+      code: '<div id="question-{{params.name}}"></div><span id="question-{{params.name}}"></span>',
+    },
+  ],
+  invalid: [
+    {
+      code: '<div id="x"></div><div id="x"></div>',
+      errors: [
+        { messageId: 'duplicateId', data: { id: 'x' } },
+        { messageId: 'duplicateId', data: { id: 'x' } },
+      ],
+    },
+    // Duplicate `id` on non-`pl-*` elements should be reported.
+    {
+      code: '<div id="fd"></div><span id="fd"></span>',
+      errors: [
+        { messageId: 'duplicateId', data: { id: 'fd' } },
+        { messageId: 'duplicateId', data: { id: 'fd' } },
+      ],
+    },
+  ],
+});