Merge pull request #22 from github/eslint-plugin-custom-elements

koddsson · web-flow · commit 3048bebd8f9d · 2021-04-29T10:13:57.000+01:00
Enabled `eslint-plugin-custom-elements`
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,10 +1,16 @@
 {
   "root": true,
+  "plugins": ["custom-elements"],
   "extends": [
     "plugin:github/recommended",
     "plugin:github/browser",
-    "plugin:github/typescript"
+    "plugin:github/typescript",
+    "plugin:custom-elements/recommended"
   ],
+  "rules": {
+    "custom-elements/file-name-matches-element": ["error", {"suffix": "Element"}],
+    "custom-elements/tag-name-matches-class": ["error", {"suffix": "Element"}]
+  },
   "globals": {
     "CustomElementElement": "readonly"
   }
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -6,10 +6,10 @@ jobs:
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js 12.x
+    - name: Use Node.js 14.x
       uses: actions/setup-node@v1
       with:
-        node-version: 12.x
+        node-version: 14.x
     - name: npm install, build, and test
       run: |
         npm install
diff --git a/examples/index.html b/examples/index.html
@@ -1,15 +1,15 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
-<head>
-  <meta charset="utf-8">
-  <title>custom-element demo</title>
-</head>
-<body>
-  <custom-element></custom-element>
+  <head>
+    <meta charset="utf-8" />
+    <title>custom-element demo</title>
+  </head>
+  <body>
+    <custom-element></custom-element>
 
-  <script type="module">
-    // import 'https://unpkg.com/@github/custom-element-boilerplate@latest/dist/index.js'
-    import '../dist/index.js'
-  </script>
-</body>
+    <script type="module">
+      // import 'https://unpkg.com/@github/custom-element-boilerplate@latest/dist/custom-element.js'
+      import '../dist/custom-element.js'
+    </script>
+  </body>
 </html>
diff --git a/karma.config.cjs b/karma.config.cjs
@@ -2,7 +2,7 @@ module.exports = function(config) {
   config.set({
     frameworks: ['mocha', 'chai'],
     files: [
-      {pattern: 'dist/index.js', type: 'module'},
+      {pattern: 'dist/custom-element.js', type: 'module'},
       {pattern: 'test/test.js', type: 'module'}
     ],
     reporters: ['mocha'],
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,10 +2,10 @@
   "name": "@github/custom-element-element",
   "version": "0.0.1",
   "description": "Boilerplate for creating a custom element.",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "main": "dist/custom-element.js",
+  "module": "dist/custom-element.js",
   "type": "module",
-  "types": "dist/index.d.ts",
+  "types": "dist/custom-elements.d.ts",
   "license": "MIT",
   "repository": "github/custom-element-boilerplate",
   "files": [
@@ -26,6 +26,7 @@
     "@github/prettier-config": "0.0.4",
     "chai": "^4.3.4",
     "eslint": "^7.25.0",
+    "eslint-plugin-custom-elements": "^0.0.2",
     "eslint-plugin-github": "^4.1.3",
     "karma": "^6.3.2",
     "karma-chai": "^0.1.0",
diff --git a/src/custom-element.ts b/src/custom-element.ts
