Chore/website quality checks (#1212)

* chore/website-quality-checks - adding in prettier and lint scripts for docs website

Author: paulmarsicloud

.github/workflows/ci.yml

@@ -8,13 +8,9 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - "docs/**"
   pull_request:
     branches:
       - main
-    paths-ignore:
-      - "docs/**"
 
 jobs:
   build:

package-scripts.js

@@ -41,6 +41,10 @@ module.exports = {
       'nps prettier:base -- -- --config ../../.prettierrc --ignore-path ../../.prettierignore',
     'prettier:pkg:fix':
       'nps prettier:base:fix -- -- --config ../../.prettierrc --ignore-path ../../.prettierignore',
+    'prettier:website':
+      'nps prettier:base -- -- --config ../.prettierrc --ignore-path ../.prettierignore',
+    'prettier:website:fix':
+      'nps prettier:base:fix -- -- --config ../.prettierrc --ignore-path ../.prettierignore',
 
     // - Lint
     'lint:base': 'eslint --cache --color',

package.json

@@ -166,6 +166,7 @@
       "dependencies": [
         "./packages/spectacle:lint",
         "./packages/create-spectacle:lint",
+        "./website:lint",
         "./examples/js:lint",
         "./examples/md:lint",
         "./examples/one-page:lint",
@@ -176,6 +177,7 @@
       "dependencies": [
         "./packages/spectacle:lint:fix",
         "./packages/create-spectacle:lint:fix",
+        "./website:lint:fix",
         "./examples/js:lint:fix",
         "./examples/md:lint:fix",
         "./examples/one-page:lint:fix",
@@ -224,6 +226,7 @@
       "dependencies": [
         "./packages/spectacle:prettier",
         "./packages/create-spectacle:prettier",
+        "./website:prettier",
         "./examples/js:prettier",
         "./examples/md:prettier",
         "./examples/one-page:prettier",
@@ -234,6 +237,7 @@
       "dependencies": [
         "./packages/spectacle:prettier:fix",
         "./packages/create-spectacle:prettier:fix",
+        "./website:prettier:fix",
         "./examples/js:prettier:fix",
         "./examples/md:prettier:fix",
         "./examples/one-page:prettier:fix",

website/docusaurus.config.js

@@ -65,7 +65,7 @@ async function createConfig() {
     ],
 
     themeConfig:
-    /** @type {import("@docusaurus/preset-classic").ThemeConfig} */
+      /** @type {import("@docusaurus/preset-classic").ThemeConfig} */
       ({
         navbar: {
           title: 'SPECTACLE',

website/package.json

@@ -5,18 +5,6 @@
   "engines": {
     "node": "<18"
   },
-  "scripts": {
-    "docusaurus": "docusaurus",
-    "start": "docusaurus start",
-    "build": "docusaurus build --out-dir build/open-source/spectacle",
-    "clear": "docusaurus clear",
-    "serve": "formideploy serve",
-    "deploy:stage": "formideploy deploy --staging",
-    "deploy:prod": "formideploy deploy --production",
-    "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
-  },
   "devDependencies": {
     "@docusaurus/core": "^2.0.1",
     "@docusaurus/module-type-aliases": "^2.0.1",
@@ -41,6 +29,76 @@
     "styled-components": "^5.3.5",
     "typescript": "^4.6.3"
   },
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build --out-dir build/open-source/spectacle",
+    "clear": "docusaurus clear",
+    "serve": "formideploy serve",
+    "deploy:stage": "formideploy deploy --staging",
+    "deploy:prod": "formideploy deploy --production",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc",
+    "lint": "wireit",
+    "lint:fix": "wireit",
+    "prettier": "wireit",
+    "prettier:fix": "wireit"
+  },
+  "wireit": {
+    "lint": {
+      "command": "nps lint:pkg -- -- \"*.js\" src",
+      "files": [
+        "../.eslintignore",
+        "../.eslintrc",
+        "*.js",
+        "src/**"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    },
+    "lint:fix": {
+      "command": "pnpm run lint || nps lint:pkg:fix -- -- \"*.js\" src",
+      "files": [
+        "../.eslintignore",
+        "../.eslintrc",
+        "*.js",
+        "src/**"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    },
+    "prettier": {
+      "command": "nps prettier:website -- -- \"*.js\" src",
+      "files": [
+        "../.prettierignore",
+        "../.prettierrc",
+        "*.js",
+        "src/**"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    },
+    "prettier:fix": {
+      "command": "pnpm run prettier || nps prettier:website:fix -- -- \"*.js\" src",
+      "files": [
+        "../.prettierignore",
+        "../.prettierrc",
+        "*.js",
+        "src/**"
+      ],
+      "output": [],
+      "packageLocks": [
+        "pnpm-lock.yaml"
+      ]
+    }
+  },
   "browserslist": {
     "production": [
       ">0.5%",

website/src/components/global/body-copy.tsx

@@ -10,11 +10,7 @@ type BodyCopy = {
 
 const BodyCopy = ({ className, theme, children }: BodyCopy) => {
   const isLight = theme === 'Light' || theme === 'Color';
-  const classNames = clsx(
-    styles.bodyCopy,
-    isLight && styles.light,
-    className
-  );
+  const classNames = clsx(styles.bodyCopy, isLight && styles.light, className);
 
   return <p className={classNames}>{children}</p>;
 };

website/src/utils/numbers.js

@@ -42,4 +42,4 @@ module.exports.romanize = function romanize(num) {
   let i = 3;
   while (i--) roman = (key[+digits.pop() + i * 10] || '') + roman;
   return Array(+digits.join('') + 1).join('M') + roman;
-}
+};