New tests for multiple test attributes; formatting; fix Dependabot 4;…

… Github Actions for unit testing (#21) * new tests for multiple testAttributes * add Prettier config; formatting (trivial change) * regenerate package-lock (fixes Dependabot 4) * Github Actions for unit testing
davidcalhoun · Aug 20, 2023 · 662e773 · 662e773
1 parent 026f1c5
commit 662e773
Show file tree

Hide file tree

Showing 23 changed files with 260 additions and 221 deletions.
diff --git a/.github/workflows/units-tests.yaml b/.github/workflows/units-tests.yaml
@@ -0,0 +1,31 @@
+name: unit testing
+on:
+    push:
+    pull_request:
+jobs:
+    build-and-test:
+        runs-on: ubuntu-latest
+        steps:
+            # Checks out code from Github.
+            - name: Checkout repo
+              uses: actions/checkout@v3
+            # Restore cache if available.
+            - name: Restore cached dependencies
+              id: dep-cache
+              uses: actions/cache@v3
+              env:
+                  cache-name: jstoxml-cache
+              with:
+                  path: node_modules
+                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-build-${{ env.cache-name }}-
+                      ${{ runner.os }}-build-
+                      ${{ runner.os }}-
+            # Fully install from scratch when no cache is available.
+            - name: Install dependencies from scratch (cache miss only)
+              if: steps.dep-cache.outputs.cache-hit != 'true'
+              run: npm i
+            - name: Unit tests
+              run: npm test
+              shell: bash
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,11 @@
+/**
+ * Config for Prettier, to automatically format code.  See https://prettier.io/
+ */
+
+module.exports = {
+    semi: true,
+    trailingComma: 'none',
+    singleQuote: true,
+    printWidth: 120,
+    tabWidth: 4
+};
diff --git a/lib/constants.js b/lib/constants.js
@@ -6,32 +6,32 @@ module.exports = {
     },
     defaultRuleSchema: [
         {
-            "enum": ["always", "never"]
+            enum: ['always', 'never']
         },
         {
-            "type": "object",
-            "properties": {
-                "testAttribute": {
-                    "oneOf": [
-                      {
-                        "type": "string",
-                      },
-                      {
-                        "type": "array",
-                        "items": {
-                          "type": "string",
+            type: 'object',
+            properties: {
+                testAttribute: {
+                    oneOf: [
+                        {
+                            type: 'string'
                         },
-                      },
-                    ],
-                  },
-                "ignoreDisabled": {
-                    "type": "boolean"
+                        {
+                            type: 'array',
+                            items: {
+                                type: 'string'
+                            }
+                        }
+                    ]
                 },
-                "ignoreReadonly": {
-                    "type": "boolean"
+                ignoreDisabled: {
+                    type: 'boolean'
+                },
+                ignoreReadonly: {
+                    type: 'boolean'
                 }
             },
-            "additionalProperties": false
+            additionalProperties: false
         }
     ],
     errors: {

diff --git a/lib/index.js b/lib/index.js
@@ -2,12 +2,12 @@
  * @fileoverview Makes sure test attributes (e.g. data-test-id) are added to interactive DOM elements.
  * @author David Calhoun
  */
-"use strict";
+'use strict';
 
-const requireIndex = require("requireindex");
+const requireIndex = require('requireindex');
 
 module.exports = {
-    rules: requireIndex(`${ __dirname }/rules`),
+    rules: requireIndex(`${__dirname}/rules`),
     configs: {
         recommended: {
             parserOptions: {

diff --git a/lib/rules/anchor.js b/lib/rules/anchor.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attributes on anchors.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/button.js b/lib/rules/button.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attributes on buttons.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -33,7 +26,7 @@ module.exports = {
         }
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/input.js b/lib/rules/input.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attributes on inputs.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/onChange.js b/lib/rules/onChange.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attribute data-test-id on elements with the onChange property.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/onClick.js b/lib/rules/onClick.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attribute data-test-id on elements with the onClick property.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 
@@ -47,15 +40,13 @@ module.exports = {
                         const { nanoid } = require('nanoid');
                         const suggestedId = nanoid();
                         const namePositionEnd = node.name.range[1];
-                        const attributeText = `${ testAttribute }="${ suggestedId }"`;
+                        const singleTestAttribute = Array.isArray(testAttribute) ? testAttribute[0] : testAttribute;
+                        const attributeText = `${singleTestAttribute}="${suggestedId}"`;
                         const start = namePositionEnd - 1;
                         const end = start + 1;
 
-                        return fixer.insertTextAfterRange(
-                            [start, end],
-                            ` ${ attributeText }`
-                        );
-                    },
+                        return fixer.insertTextAfterRange([start, end], ` ${attributeText}`);
+                    }
                 });
             }
         };

diff --git a/lib/rules/onKeyDown.js b/lib/rules/onKeyDown.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attribute data-test-id on elements with the onKeyDown property.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/onKeyUp.js b/lib/rules/onKeyUp.js
@@ -2,16 +2,9 @@
  * @fileoverview Requires test attribute data-test-id on elements with the onKeyUp property.
  * @author David Calhoun
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -25,7 +18,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;
 

diff --git a/lib/rules/onSubmit.js b/lib/rules/onSubmit.js
@@ -1,16 +1,9 @@
 /**
  * @fileoverview Requires test attribute data-test-id on elements with the onSubmit property.
  */
-const {
-    errors,
-    defaultRuleSchema,
-    defaults
-} = require('../constants');
+const { errors, defaultRuleSchema, defaults } = require('../constants');
 
-const {
-    getError,
-    shouldBypass
-} = require('../utils');
+const { getError, shouldBypass } = require('../utils');
 
 module.exports = {
     meta: {
@@ -24,7 +17,7 @@ module.exports = {
         schema: defaultRuleSchema
     },
 
-    create: function(context) {
+    create: function (context) {
         const options = context.options[1] || {};
         const testAttribute = options.testAttribute || defaults.testAttribute;