chore: add prettier (1/3): add packages, configurations, fix lint issues (nasa#6382)

* fix: remove redundant eslint rules

* chore: bump `prettier` to v2.8.7

* docs: vue files to use html comments for licenses

- Prettier's Vue parser freaks out if it sees a *.js style comment in a *.vue file.

* docs: more licenses for vue files

* fix: don't ignore *.vue files

* fix: use defaults for tabWidth and printWidth

* simplify .prettierignore

* enforce a printWidth of 100

* fix: use `eslint-plugin-prettier`, remove conflicting rules

* test: fix gauge tests (for real)

* test: fix notebook test selectors

* test: fix restrictedNotebook test selectors

* test: remove useless assignment

* lint: __dirname as global

* lint: revert eslint config + whitespace changes, commit new config

* style: remove unnecessary string concat of literals

* test: fix missed gauge test

* fix: use new eslint rules

* feat: add blank `.git-blame-ignore-revs` file

* docs: update to mention Prettier and format.

* Revert "test: fix gauge tests (for real)"

This reverts commit 6afad45.

* Revert "test: fix notebook test selectors"

This reverts commit 17fe1cb.

* Revert "test: fix restrictedNotebook test selectors"

This reverts commit 97e0ede.

* Revert "test: fix missed gauge test"

This reverts commit e2398fc.

* test: fix gauge tests (no formatting)

* test: update notebook e2e selectors (no formatting)

* test: update restrictedNotebook e2e selectors (no formatting)

* fix: temporarily disable lint check

Author: ozyx

Diff for: .circleci/config.yml

@@ -232,9 +232,9 @@ jobs:
 workflows:
   overall-circleci-commit-status: #These jobs run on every commit
     jobs:
-      - lint:
-          name: node16-lint
-          node-version: lts/gallium
+      # - lint:
+      #     name: node16-lint
+      #     node-version: lts/gallium
       - unit-test:
           name: node18-chrome
           node-version: lts/hydrogen

Diff for: .eslintrc.js

@@ -9,11 +9,13 @@ module.exports = {
     "globals": {
         "_": "readonly"
     },
+    "plugins": ["prettier"],
     "extends": [
         "eslint:recommended",
         "plugin:compat/recommended",
         "plugin:vue/recommended",
-        "plugin:you-dont-need-lodash-underscore/compatible"
+        "plugin:you-dont-need-lodash-underscore/compatible",
+        "plugin:prettier/recommended"
     ],
     "parser": "vue-eslint-parser",
     "parserOptions": {
@@ -26,6 +28,7 @@ module.exports = {
         }
     },
     "rules": {
+        "prettier/prettier": "error",
         "you-dont-need-lodash-underscore/omit": "off",
         "you-dont-need-lodash-underscore/throttle": "off",
         "you-dont-need-lodash-underscore/flatten": "off",
@@ -50,20 +53,6 @@ module.exports = {
             }
         ],
         "no-console": "off",
-        "no-trailing-spaces": "error",
-        "space-before-function-paren": [
-            "error",
-            {
-                "anonymous": "always",
-                "asyncArrow": "always",
-                "named": "never"
-            }
-        ],
-        "array-bracket-spacing": "error",
-        "space-in-parens": "error",
-        "space-before-blocks": "error",
-        "comma-dangle": "error",
-        "eol-last": "error",
         "new-cap": [
             "error",
             {
@@ -72,7 +61,6 @@ module.exports = {
             }
         ],
         "dot-notation": "error",
-        "indent": ["error", 4],
 
         // https://eslint.org/docs/rules/no-case-declarations
         "no-case-declarations": "error",
@@ -82,8 +70,6 @@ module.exports = {
         "no-eq-null": "error",
         // https://eslint.org/docs/rules/no-eval
         "no-eval": "error",
-        // https://eslint.org/docs/rules/no-floating-decimal
-        "no-floating-decimal": "error",
         // https://eslint.org/docs/rules/no-implicit-globals
         "no-implicit-globals": "error",
         // https://eslint.org/docs/rules/no-implied-eval
@@ -112,16 +98,10 @@ module.exports = {
         "no-unmodified-loop-condition": "error",
         // https://eslint.org/docs/rules/no-useless-call
         "no-useless-call": "error",
-        // https://eslint.org/docs/rules/wrap-iife
-        "wrap-iife": "error",
         // https://eslint.org/docs/rules/no-nested-ternary
         "no-nested-ternary": "error",
-        // https://eslint.org/docs/rules/switch-colon-spacing
-        "switch-colon-spacing": "error",
         // https://eslint.org/docs/rules/no-useless-computed-key
         "no-useless-computed-key": "error",
-        // https://eslint.org/docs/rules/rest-spread-spacing
-        "rest-spread-spacing": ["error"],
         // https://eslint.org/docs/rules/no-var
         "no-var": "error",
         // https://eslint.org/docs/rules/one-var
@@ -159,96 +139,11 @@ module.exports = {
         "no-implicit-coercion": "error",
         //https://eslint.org/docs/rules/no-unneeded-ternary
         "no-unneeded-ternary": "error",
-        // https://eslint.org/docs/rules/semi
-        "semi": ["error", "always"],
-        // https://eslint.org/docs/rules/no-multi-spaces
-        "no-multi-spaces": "error",
-        // https://eslint.org/docs/rules/key-spacing
-        "key-spacing": ["error", {
-            "afterColon": true
-        }],
-        // https://eslint.org/docs/rules/keyword-spacing
-        "keyword-spacing": ["error", {
-            "before": true,
-            "after": true
-        }],
-        // https://eslint.org/docs/rules/comma-spacing
-        // Also requires one line code fix
-        "comma-spacing": ["error", {
-            "after": true
-        }],
-        //https://eslint.org/docs/rules/no-whitespace-before-property
-        "no-whitespace-before-property": "error",
-        // https://eslint.org/docs/rules/object-curly-newline
-        "object-curly-newline": ["error", {
-            "consistent": true,
-            "multiline": true
-        }],
-        // https://eslint.org/docs/rules/object-property-newline
-        "object-property-newline": "error",
-        // https://eslint.org/docs/rules/brace-style
-        "brace-style": "error",
-        // https://eslint.org/docs/rules/no-multiple-empty-lines
-        "no-multiple-empty-lines": ["error", {"max": 1}],
-        // https://eslint.org/docs/rules/operator-linebreak
-        "operator-linebreak": ["error", "before", {"overrides": {"=": "after"}}],
-        // https://eslint.org/docs/rules/padding-line-between-statements
-        "padding-line-between-statements": ["error", {
-            "blankLine": "always",
-            "prev": "multiline-block-like",
-            "next": "*"
-        }, {
-            "blankLine": "always",
-            "prev": "*",
-            "next": "return"
-        }],
-        // https://eslint.org/docs/rules/space-infix-ops
-        "space-infix-ops": "error",
-        // https://eslint.org/docs/rules/space-unary-ops
-        "space-unary-ops": ["error", {
-            "words": true,
-            "nonwords": false
-        }],
-        // https://eslint.org/docs/rules/arrow-spacing
-        "arrow-spacing": "error",
-        // https://eslint.org/docs/rules/semi-spacing
-        "semi-spacing": ["error", {
-            "before": false,
-            "after": true
-        }],
-
-        "vue/html-indent": [
-            "error",
-            4,
-            {
-                "attribute": 1,
-                "baseIndent": 0,
-                "closeBracket": 0,
-                "alignAttributesVertically": true,
-                "ignores": []
-            }
-        ],
-        "vue/html-self-closing": ["error",
-            {
-                "html": {
-                    "void": "never",
-                    "normal": "never",
-                    "component": "always"
-                },
-                "svg": "always",
-                "math": "always"
-            }
-        ],
-        "vue/max-attributes-per-line": ["error", {
-            "singleline": 1,
-            "multiline": 1,
-        }],
         "vue/first-attribute-linebreak": "error",
         "vue/multiline-html-element-content-newline": "off",
         "vue/singleline-html-element-content-newline": "off",
         "vue/multi-word-component-names": "off", // TODO enable, align with conventions
         "vue/no-mutating-props": "off"
-
     },
     "overrides": [
         {

Diff for: .git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# git-blame ignored revisions
+# To configure, run:
+#   git config blame.ignoreRevsFile .git-blame-ignore-revs
+# Requires Git > 2.23
+# See https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt
+

Diff for: .prettierignore

@@ -0,0 +1,27 @@
+# Docs
+*.md
+
+# Build output
+target
+dist
+
+# Mac OS X Finder
+.DS_Store
+
+# Node dependencies
+node_modules
+
+# npm-debug log
+npm-debug.log
+
+# karma reports
+report.*.json
+
+# e2e test artifacts
+test-results
+html-test-results
+
+# codecov artifacts
+.nyc_output
+coverage
+codecov

Diff for: .prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "none",
+  "singleQuote": true,
+  "printWidth": 100
+}

Diff for: CONTRIBUTING.md

@@ -18,13 +18,13 @@ The short version:
    for review.)
 4. Respond to any discussion. When the reviewer decides it's ready, they
    will merge back `master` and fill out their own check list.
-5. If you are a first-time contributor, please see [this discussion](https://github.com/nasa/openmct/discussions/3821) for further information.   
+5. If you are a first-time contributor, please see [this discussion](https://github.com/nasa/openmct/discussions/3821) for further information.
 
 ## Contribution Process
 
 Open MCT uses git for software version control, and for branching and
 merging. The central repository is at
-https://github.com/nasa/openmct.git.
+<https://github.com/nasa/openmct.git>.
 
 ### Roles
 
@@ -116,6 +116,7 @@ the pull request containing the reviewer checklist (from below) and complete
 the merge back to the master branch.
 
 Additionally:
+
 * Every pull request must link to the issue that it addresses. Eg. “Addresses #1234” or “Closes #1234”. This is the responsibility of the pull request’s __author__. If no issue exists, [create one](https://github.com/nasa/openmct/issues/new/choose).
 * Every __author__ must include testing instructions. These instructions should identify the areas of code affected, and some minimal test steps. If addressing a bug, reproduction steps should be included, if they were not included in the original issue. If reproduction steps were included on the original issue, and are sufficient, refer to them.
 * A pull request that closes an issue should say so in the description. Including the text “Closes #1234” will cause the linked issue to be automatically closed when the pull request is merged. This is the responsibility of the pull request’s __author__.
@@ -132,25 +133,26 @@ changes.
 
 ### Code Standards
 
-JavaScript sources in Open MCT must satisfy the ESLint rules defined in 
-this repository. This is verified by the command line build.
+JavaScript sources in Open MCT must satisfy the [ESLint](https://eslint.org/) rules defined in
+this repository. [Prettier](https://prettier.io/) is used in conjunction with ESLint to enforce code style
+via automated formatting. These are verified by the command line build.
 
 #### Code Guidelines
 
 The following guidelines are provided for anyone contributing source code to the Open MCT project:
 
-1. Write clean code. Here’s a good summary - https://github.com/ryanmcdermott/clean-code-javascript.
+1. Write clean code. Here’s a good summary - <https://github.com/ryanmcdermott/clean-code-javascript>.
 1. Include JSDoc for any exposed API (e.g. public methods, classes).
 1. Include non-JSDoc comments as-needed for explaining private variables,
-   methods, or algorithms when they are non-obvious. Otherwise code 
+   methods, or algorithms when they are non-obvious. Otherwise code
    should be self-documenting.
 1. Classes and Vue components should use camel case, first letter capitalized
    (e.g. SomeClassName).
 1. Methods, variables, fields, events, and function names should use camelCase,
    first letter lower-case (e.g. someVariableName).
 1. Source files that export functions should use camelCase, first letter lower-case (eg. testTools.js)
-1. Constants (variables or fields which are meant to be declared and 
-   initialized statically, and never changed) should use only capital 
+1. Constants (variables or fields which are meant to be declared and
+   initialized statically, and never changed) should use only capital
    letters, with underscores between words (e.g. SOME_CONSTANT). They should always be declared as `const`s
 1. File names should be the name of the exported class, plus a .js extension
    (e.g. SomeClassName.js).
@@ -159,21 +161,25 @@ The following guidelines are provided for anyone contributing source code to the
    (e.g. as arguments to a forEach call). Anonymous functions should always be arrow functions.
 1. Named functions are preferred over functions assigned to variables.
    eg.
+
    ```JavaScript
    function renameObject(object, newName) {
        Object.name = newName;
    }
    ```
+
    is preferable to
+
    ```JavaScript
    const rename = (object, newName) => {
        Object.name = newName;
    }
    ```
+
 1. Avoid deep nesting (especially of functions), except where necessary
    (e.g. due to closure scope).
 1. End with a single new-line character.
-1. Always use ES6 `Class`es and inheritance rather than the pre-ES6 prototypal 
+1. Always use ES6 `Class`es and inheritance rather than the pre-ES6 prototypal
    pattern.
 1. Within a given function's scope, do not mix declarations and imperative
    code, and  present these in the following order:
@@ -182,19 +188,24 @@ The following guidelines are provided for anyone contributing source code to the
    * Finally, the returned value. A single return statement at the end of the function should be used, except where an early return would improve code clarity.
 1. Avoid the use of "magic" values.
    eg.
+
    ```JavaScript
    const UNAUTHORIZED = 401;
    if (responseCode === UNAUTHORIZED)
    ```
+
    is preferable to
+
    ```JavaScript
    if (responseCode === 401)
    ```
+
 1. Use the ternary operator only for simple cases such as variable assignment. Nested ternaries should be avoided in all cases.
 1. Unit Test specs should reside alongside the source code they test, not in a separate directory.
 1. Organize code by feature, not by type.
    eg.
-   ```
+
+   ```txt
    - telemetryTable
        - row
            TableRow.js
@@ -206,8 +217,10 @@ The following guidelines are provided for anyone contributing source code to the
        plugin.js
        pluginSpec.js
    ```
+
    is preferable to
-   ```
+
+   ```txt
    - telemetryTable
        - components
            TableRow.vue
@@ -219,6 +232,7 @@ The following guidelines are provided for anyone contributing source code to the
        plugin.js
        pluginSpec.js
    ```
+
 Deviations from Open MCT code style guidelines require two-party agreement,
 typically from the author of the change and its reviewer.
 
@@ -257,7 +271,7 @@ these standards.
 
 ## Issue Reporting
 
-Issues are tracked at https://github.com/nasa/openmct/issues.
+Issues are tracked at <https://github.com/nasa/openmct/issues>.
 
 Issue severity is categorized as follows (in ascending order):
 

Diff for: e2e/helper/faultUtils.js

@@ -19,14 +19,13 @@
  * this source code distribution or the Licensing information page available
  * at runtime from the About dialog for additional information.
  *****************************************************************************/
-
+/* global __dirname */
 const path = require('path');
 
 /**
  * @param {import('@playwright/test').Page} page
  */
 async function navigateToFaultManagementWithExample(page) {
-    // eslint-disable-next-line no-undef
     await page.addInitScript({ path: path.join(__dirname, './', 'addInitExampleFaultProvider.js') });
 
     await navigateToFaultItemInTree(page);
@@ -36,7 +35,6 @@ async function navigateToFaultManagementWithExample(page) {
  * @param {import('@playwright/test').Page} page
  */
 async function navigateToFaultManagementWithStaticExample(page) {
-    // eslint-disable-next-line no-undef
     await page.addInitScript({ path: path.join(__dirname, './', 'addInitExampleFaultProviderStatic.js') });
 
     await navigateToFaultItemInTree(page);
@@ -46,7 +44,6 @@ async function navigateToFaultManagementWithStaticExample(page) {
  * @param {import('@playwright/test').Page} page
  */
 async function navigateToFaultManagementWithoutExample(page) {
-    // eslint-disable-next-line no-undef
     await page.addInitScript({ path: path.join(__dirname, './', 'addInitFaultManagementPlugin.js') });
 
     await navigateToFaultItemInTree(page);