feat!: migrate to esm-only (#218)

This migrates to ESM only, meaning you must `import` the plugin in your
flat config, or use a version of node which supports `require(esm)`
(>=20).

Also bumps the minimum node version to 18.

Author: 43081j

.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
       fail-fast: false
     steps:
       - name: Checkout

custom_types/requireindex.d.ts

@@ -1,6 +1,7 @@
 {
   "name": "eslint-plugin-lit",
   "version": "0.0.0-dev",
+  "type": "module",
   "description": "lit-html support for ESLint",
   "main": "lib/index.js",
   "files": [
@@ -10,13 +11,12 @@
     "custom_types"
   ],
   "scripts": {
-    "clean": "rimraf ./lib",
+    "clean": "premove ./lib ./coverage",
     "lint": "eslint \"src/**/*.ts\"",
     "prebuild": "npm run clean",
     "build": "tsc",
-    "start": "nodemon --watch src --ext ts --exec \"npm run dev\"",
-    "dev": "npm run lint && npm run build && npm run test ",
-    "test": "nyc --reporter=html --reporter=text-summary --reporter=lcov mocha \"lib/test/**/*_test.js\"",
+    "dev": "npm run lint && npm run build && npm run test",
+    "test": "c8 --reporter=lcov --reporter=text-summary mocha \"lib/test/**/*_test.js\"",
     "format": "prettier --write \"src/**/*.ts\"",
     "prepare": "npm run build",
     "prepublishOnly": "npm run lint && npm run test"
@@ -38,15 +38,14 @@
   },
   "homepage": "https://github.com/43081j/eslint-plugin-lit#readme",
   "engines": {
-    "node": ">= 12"
+    "node": ">= 18"
   },
   "dependencies": {
     "parse5": "^6.0.1",
-    "parse5-htmlparser2-tree-adapter": "^6.0.1",
-    "requireindex": "^1.2.0"
+    "parse5-htmlparser2-tree-adapter": "^6.0.1"
   },
   "peerDependencies": {
-    "eslint": ">= 5"
+    "eslint": ">= 8"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.24.5",
@@ -60,16 +59,15 @@
     "@types/parse5-htmlparser2-tree-adapter": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.9.0",
     "@typescript-eslint/parser": "^6.9.0",
+    "c8": "^10.1.3",
     "chai": "^4.2.0",
     "eslint": "^8.23.0",
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-eslint-plugin": "^5.0.6",
     "espree": "^9.0.0",
     "mocha": "^10.0.0",
-    "nodemon": "^3.0.1",
-    "nyc": "^15.1.0",
+    "premove": "^4.0.0",
     "prettier": "^3.0.3",
-    "rimraf": "^5.0.5",
     "typescript": "^5.2.2"
   }
 }

package-lock.json

@@ -1,14 +1,60 @@
+/* eslint-disable max-len */
 import type {Rule, ESLint} from 'eslint';
-import {configFactory as configAll} from './configs/all';
-import {config as configLegacyAll} from './configs/legacy-all';
-import {config as configLegacyRecommended} from './configs/legacy-recommended';
-import {configFactory as configRecommended} from './configs/recommended';
-import requireIndex = require('requireindex');
+import {configFactory as configAll} from './configs/all.js';
+import {config as configLegacyAll} from './configs/legacy-all.js';
+import {config as configLegacyRecommended} from './configs/legacy-recommended.js';
+import {configFactory as configRecommended} from './configs/recommended.js';
+import {rule as ruleAttributeNames} from './rules/attribute-names.js';
+import {rule as ruleAttributeValueEntities} from './rules/attribute-value-entities.js';
+import {rule as ruleBanAttributes} from './rules/ban-attributes.js';
+import {rule as ruleBindingPositions} from './rules/binding-positions.js';
+import {rule as ruleLifecycleSuper} from './rules/lifecycle-super.js';
+import {rule as ruleNoClassfieldShadowing} from './rules/no-classfield-shadowing.js';
+import {rule as ruleNoDuplicateTemplateBindings} from './rules/no-duplicate-template-bindings.js';
+import {rule as ruleNoInvalidEscapeSequences} from './rules/no-invalid-escape-sequences.js';
+import {rule as ruleNoInvalidHtml} from './rules/no-invalid-html.js';
+import {rule as ruleNoLegacyImports} from './rules/no-legacy-imports.js';
+import {rule as ruleNoLegacyTemplateSyntax} from './rules/no-legacy-template-syntax.js';
+import {rule as ruleNoNativeAttributes} from './rules/no-native-attributes.js';
+import {rule as ruleNoPrivateProperties} from './rules/no-private-properties.js';
+import {rule as ruleNoPropertyChangeUpdate} from './rules/no-property-change-update.js';
+import {rule as ruleNoTemplateArrow} from './rules/no-template-arrow.js';
+import {rule as ruleNoTemplateBind} from './rules/no-template-bind.js';
+import {rule as ruleNoTemplateMap} from './rules/no-template-map.js';
+import {rule as ruleNoThisAssign} from './rules/no-this-assign-in-render.js';
+import {rule as ruleNoUselessTemplateLiterals} from './rules/no-useless-template-literals.js';
+import {rule as ruleNoValueAttribute} from './rules/no-value-attribute.js';
+import {rule as rulePreferNothing} from './rules/prefer-nothing.js';
+import {rule as rulePreferStaticStyles} from './rules/prefer-static-styles.js';
+import {rule as ruleQuotedExpressions} from './rules/quoted-expressions.js';
+import {rule as ruleValueAfterConstraints} from './rules/value-after-constraints.js';
 
-export const rules = requireIndex(`${__dirname}/rules`) as Record<
-  string,
-  Rule.RuleModule
->;
+export const rules: Record<string, Rule.RuleModule> = {
+  'attribute-names': ruleAttributeNames,
+  'attribute-value-entities': ruleAttributeValueEntities,
+  'ban-attributes': ruleBanAttributes,
+  'binding-positions': ruleBindingPositions,
+  'lifecycle-super': ruleLifecycleSuper,
+  'no-classfield-shadowing': ruleNoClassfieldShadowing,
+  'no-duplicate-template-bindings': ruleNoDuplicateTemplateBindings,
+  'no-invalid-escape-sequences': ruleNoInvalidEscapeSequences,
+  'no-invalid-html': ruleNoInvalidHtml,
+  'no-legacy-imports': ruleNoLegacyImports,
+  'no-legacy-template-syntax': ruleNoLegacyTemplateSyntax,
+  'no-native-attributes': ruleNoNativeAttributes,
+  'no-private-properties': ruleNoPrivateProperties,
+  'no-property-change-update': ruleNoPropertyChangeUpdate,
+  'no-template-arrow': ruleNoTemplateArrow,
+  'no-template-bind': ruleNoTemplateBind,
+  'no-template-map': ruleNoTemplateMap,
+  'no-this-assign-in-render': ruleNoThisAssign,
+  'no-useless-template-literals': ruleNoUselessTemplateLiterals,
+  'no-value-attribute': ruleNoValueAttribute,
+  'prefer-nothing': rulePreferNothing,
+  'prefer-static-styles': rulePreferStaticStyles,
+  'quoted-expressions': ruleQuotedExpressions,
+  'value-after-constraints': ruleValueAfterConstraints
+};
 
 const plugin: ESLint.Plugin = {rules};
 

package.json

@@ -5,13 +5,13 @@
 
 import {Rule} from 'eslint';
 import * as ESTree from 'estree';
-import {getPropertyMap, isLitClass, toKebabCase, toSnakeCase} from '../util';
+import {getPropertyMap, isLitClass, toKebabCase, toSnakeCase} from '../util.js';
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const rule: Rule.RuleModule = {
+export const rule: Rule.RuleModule = {
   meta: {
     docs: {
       description: 'Enforces attribute naming conventions',
@@ -107,5 +107,3 @@ const rule: Rule.RuleModule = {
     };
   }
 };
-
-export = rule;

src/index.ts

@@ -5,13 +5,13 @@
 
 import {Rule} from 'eslint';
 import * as ESTree from 'estree';
-import {TemplateAnalyzer} from '../template-analyzer';
+import {TemplateAnalyzer} from '../template-analyzer.js';
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const rule: Rule.RuleModule = {
+export const rule: Rule.RuleModule = {
   meta: {
     docs: {
       description: 'Disallows unencoded HTML entities in attribute values',
@@ -98,5 +98,3 @@ const rule: Rule.RuleModule = {
     };
   }
 };
-
-export = rule;

src/rules/attribute-names.ts

@@ -5,13 +5,13 @@
 
 import {Rule} from 'eslint';
 import * as ESTree from 'estree';
-import {TemplateAnalyzer} from '../template-analyzer';
+import {TemplateAnalyzer} from '../template-analyzer.js';
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const rule: Rule.RuleModule = {
+export const rule: Rule.RuleModule = {
   meta: {
     docs: {
       description: 'Disallows a set of attributes from being used in templates',
@@ -79,5 +79,3 @@ const rule: Rule.RuleModule = {
     };
   }
 };
-
-export = rule;

src/rules/attribute-value-entities.ts

@@ -10,7 +10,7 @@ import * as ESTree from 'estree';
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const rule: Rule.RuleModule = {
+export const rule: Rule.RuleModule = {
   meta: {
     docs: {
       description: 'Disallows invalid binding positions in templates',
@@ -96,5 +96,3 @@ const rule: Rule.RuleModule = {
     };
   }
 };
-
-export = rule;

src/rules/ban-attributes.ts

@@ -5,15 +5,15 @@
 
 import {Rule} from 'eslint';
 import * as ESTree from 'estree';
-import {isLitClass} from '../util';
+import {isLitClass} from '../util.js';
 
 const methodNames = ['connectedCallback', 'disconnectedCallback', 'update'];
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const rule: Rule.RuleModule = {
+export const rule: Rule.RuleModule = {
   meta: {
     docs: {
       description: 'Enforces calling `super` in lifecycle methods',
@@ -141,5 +141,3 @@ const rule: Rule.RuleModule = {
     };
   }
 };
-
-export = rule;