feat(sage-monorepo): update the HTML formatter and linter (ARCH-290) (#…

…2854)
Sage-Bionetworks · Sep 25, 2024 · 9779db6 · 9779db6
1 parent 9e0228c
commit 9779db6
Show file tree

Hide file tree

Showing 22 changed files with 106 additions and 2,413 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -57,8 +57,7 @@
         "stkb.rewrap",
         "vmware.vscode-boot-dev-pack",
         "vscjava.vscode-gradle",
-        "vscjava.vscode-java-pack",
-        "webhint.vscode-webhint"
+        "vscjava.vscode-java-pack"
       ],
       "settings": {
         "workbench.startupEditor": "readme"

diff --git a/.hintrc b/.hintrc
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,7 +13,9 @@
   },
   "editor.rulers": [100],
   "editor.inlayHints.enabled": "off",
+  "eslint.enable": true,
   "eslint.workingDirectories": ["."],
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "html"],
   // We need to explicitly set Prettier as the format for JSON formats, otherwise the formatter
   // provided with VS Code will set itself as the default one, despite us specifying that Prettier
   // is the default formatter (editor.defaultFormatter).
@@ -29,6 +31,9 @@
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
   "typescript.tsdk": "node_modules/typescript/lib",
   // Python settings
   "python.analysis.autoImportCompletions": true,

diff --git a/apps/sandbox/angular-app/src/app/app.component.html b/apps/sandbox/angular-app/src/app/app.component.html
@@ -1,3 +1,3 @@
 <app-nx-welcome></app-nx-welcome>
 <sandbox-angular-lib></sandbox-angular-lib>
-<router-outlet></router-outlet>
+<router-outlet></router-outlet>
diff --git a/dev-env.sh b/dev-env.sh
@@ -65,10 +65,6 @@ function workspace-lint {
   nx run-many --target=lint
 }
 
-function workspace-lint-html {
-  nx run-many --target=lint-html
-}
-
 function workspace-build {
   nx run-many --target=build
 }

diff --git a/docs/_archive/linters-and-formatters.md b/docs/_archive/linters-and-formatters.md
@@ -7,22 +7,12 @@
 | File type  | File extension | Linter           |
 | ---------- | -------------- | ---------------- |
 | Dockerfile | `Dockerfile`   | [hadolint]       |
-| HTML       | `*.html`       | [Webhint]        |
+| HTML       | `*.html`       | ESLint           |
 | Java       | `*.java`       | [Checkstyle]     |
 | SCSS       | `*.scss`       | [VS Code (SCSS)] |
 | TypeScript | `*.ts`         | [ESLint]         |
 | XML        | `*.xml`        | -                |
 
-### Webhint
-
-Linter:
-
-- Webhint - VS Code extension
-
-Linter configuration:
-
-- `.hintrc`
-
 ## Formatters
 
 | File type  | File extension | Formatter            | Package type |
@@ -84,7 +74,6 @@ Notes:
 
 <!-- Links -->
 
-[webhint]: https://marketplace.visualstudio.com/items?itemName=webhint.vscode-webhint
 [prettier]: https://prettier.io
 [eslint]: https://eslint.org
 [checkstyle]: https://checkstyle.sourceforge.io/

diff --git a/libs/agora/about/.hintrc b/libs/agora/about/.hintrc
diff --git a/libs/agora/about/project.json b/libs/agora/about/project.json
@@ -20,14 +20,6 @@
       "options": {
         "fix": true
       }
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/agora/about",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:agora", "language:typescript"],

diff --git a/libs/agora/news/.hintrc b/libs/agora/news/.hintrc
diff --git a/libs/agora/news/project.json b/libs/agora/news/project.json
@@ -20,14 +20,6 @@
       "options": {
         "fix": true
       }
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/agora/news",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:agora", "language:typescript"],

diff --git a/libs/agora/not-found/src/lib/not-found.component.html b/libs/agora/not-found/src/lib/not-found.component.html
@@ -2,8 +2,7 @@
   <div class="err-message">
     <em class="err-code">404b</em>
     <h1>Page Not Found</h1>
-    <p>Oops! The page you are looking for does not exist. It might have been
-      moved or deleted.</p>
+    <p>Oops! The page you are looking for does not exist. It might have been moved or deleted.</p>
   </div>
   <div *ngIf="dataversion$ | async as dataVersion">
     <h3>Data Release Info</h3>
@@ -23,10 +22,13 @@ <h4>Wiki page fetched with Synapse API Client for Angular</h4>
   </div>
   <div class="btn-group">
     <a mat-raised-button class="home-btn" href="/home">Home</a>
-    <a mat-raised-button color="basic"
-      href="https://github.com/Sage-Bionetworks/sage-monorepo/issues/new/choose">Contact
-      Us</a>
+    <a
+      mat-raised-button
+      color="basic"
+      href="https://github.com/Sage-Bionetworks/sage-monorepo/issues/new/choose"
+      >Contact Us</a
+    >
   </div>
 </main>
 
-<agora-footer [appVersion]="appVersion" [apiDocsUrl]="apiDocsUrl" />
+<agora-footer [appVersion]="appVersion" [apiDocsUrl]="apiDocsUrl" />
diff --git a/libs/agora/teams/.hintrc b/libs/agora/teams/.hintrc
diff --git a/libs/agora/teams/project.json b/libs/agora/teams/project.json
@@ -14,14 +14,6 @@
     },
     "lint": {
       "executor": "@nx/eslint:lint"
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/agora/teams",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:agora", "language:typescript"],

diff --git a/libs/agora/testing/.hintrc b/libs/agora/testing/.hintrc
diff --git a/libs/agora/testing/project.json b/libs/agora/testing/project.json
@@ -20,14 +20,6 @@
       "options": {
         "fix": true
       }
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/agora/testing",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:agora", "language:typescript"],

diff --git a/libs/agora/wiki/.hintrc b/libs/agora/wiki/.hintrc
diff --git a/libs/agora/wiki/project.json b/libs/agora/wiki/project.json
@@ -14,14 +14,6 @@
     },
     "lint": {
       "executor": "@nx/eslint:lint"
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/agora/wiki",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:agora", "language:typescript"],

diff --git a/libs/openchallenges/about/.hintrc b/libs/openchallenges/about/.hintrc
diff --git a/libs/openchallenges/about/project.json b/libs/openchallenges/about/project.json
@@ -20,14 +20,6 @@
       "options": {
         "fix": true
       }
-    },
-    "lint-html": {
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": ["hint src/**/*.html"],
-        "cwd": "libs/openchallenges/about",
-        "parallel": false
-      }
     }
   },
   "tags": ["type:feature", "scope:openchallenges", "language:typescript"],

diff --git a/lint-staged.config.js b/lint-staged.config.js
@@ -8,7 +8,7 @@ module.exports = {
     `nx affected --target=lint --files=${filenames.join(',')}`,
   ],
 
-  '**/*.{json,md,yaml,yml}': (filenames) => [
+  '**/*.{json,md,yaml,yml,html}': (filenames) => [
     // Format files with Prettier
     `prettier --write ${filenames.join(' ')}`,
   ],

diff --git a/package.json b/package.json
@@ -73,8 +73,6 @@
     "@angular/compiler-cli": "18.2.5",
     "@angular/language-service": "18.2.5",
     "@chromatic-com/storybook": "2.0.2",
-    "@hint/configuration-web-recommended": "8.2.16",
-    "@hint/formatter-codeframe": "3.1.33",
     "@nrwl/js": "19.8.0",
     "@nx-tools/container-metadata": "5.0.3",
     "@nx-tools/nx-container": "5.0.3",
@@ -146,7 +144,6 @@
     "eslint-plugin-promise": "6.1.1",
     "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "hint": "7.1.3",
     "husky": "9.1.5",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",