Lint the docs

mcnuttandrew · Jul 13, 2023 · fbe90a2 · fbe90a2
1 parent 1cf53a0
commit fbe90a2
Show file tree

Hide file tree

Showing 12 changed files with 524 additions and 634 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,7 +1,7 @@
 name: Test and lint
 on: [push]
 jobs:
-  test-and-lint:
+  test-and-lint-package:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
@@ -18,3 +18,16 @@ jobs:
       - name: Lint 🧵
         run: yarn lint
         working-directory: ./packages/prong-editor
+  lint-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+
+      - name: Install 🔧
+        run: yarn
+        working-directory: ./sites/docs
+
+      - name: Lint 🧵
+        run: yarn lint
+        working-directory: ./sites/docs
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -14,6 +14,7 @@
     "pickr",
     "retarget",
     "Retargeted",
+    "seedrandom",
     "simonwep",
     "tabindex"
   ]

diff --git a/sites/docs/package.json b/sites/docs/package.json
@@ -47,6 +47,7 @@
     "@types/react": "^17.0.38",
     "@types/react-dom": "^17.0.11",
     "@types/react-syntax-highlighter": "^15.5.7",
+    "@types/seedrandom": "^3.0.5",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.61.0",
     "@vitejs/plugin-react-swc": "^3.3.2",
@@ -58,4 +59,4 @@
     "vega-datasets": "^2.7.0",
     "vite": "^4.4.0"
   }
-}
+}
diff --git a/sites/docs/src/examples/TraceryExample.tsx b/sites/docs/src/examples/TraceryExample.tsx
@@ -95,7 +95,7 @@ function generateRoots(currentCode: string, randomKey: string) {
 
 function getAllNodes(root: TraceryNode) {
   const allNodes = [];
-  let queue = [root];
+  const queue = [root];
   while (queue.length) {
     const current = queue.shift()!;
     allNodes.push(current);
@@ -282,6 +282,7 @@ const Editable = (props: {
       setTxt(evt.currentTarget.innerHTML);
       setContent(evt.currentTarget.innerHTML);
     }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
   return (
@@ -477,7 +478,7 @@ function TraceryExample() {
 
   function clickNode(node: TraceryNode) {
     const nodeId = node.id;
-    setSelectedNodes(selectedNodes.includes(nodeId) ? [] : [nodeId as string]);
+    setSelectedNodes(selectedNodes.includes(nodeId) ? [] : [nodeId]);
   }
 
   useEffect(() => {

diff --git a/sites/docs/src/examples/VegaLiteStyler.tsx b/sites/docs/src/examples/VegaLiteStyler.tsx
@@ -471,7 +471,7 @@ function VegaLiteExampleApp() {
             })
           }
         >
-          {!!state.suggestions.length ? (
+          {state.suggestions.length ? (
             <div>
               <button
                 onClick={() =>

diff --git a/sites/docs/src/examples/VegaLiteUseCase.tsx b/sites/docs/src/examples/VegaLiteUseCase.tsx
@@ -136,7 +136,7 @@ const UploadDataset: FC<{
         name="file"
         onChange={(event) => {
           const file = event.target.files![0];
-          var reader = new FileReader();
+          const reader = new FileReader();
           reader.onload = function (event) {
             const result = event.target!.result;
             const inlinedData = utils.simpleParse(result, []);
@@ -248,11 +248,11 @@ function VegaLiteExampleApp() {
                   return (
                     <button
                       key={file}
-                      onClick={() =>
-                        buildFileGet(file, currentCode).then((x) =>
-                          setCurrentCode(x)
-                        )
-                      }
+                      onClick={() => {
+                        buildFileGet(file, currentCode)
+                          .then((x) => setCurrentCode(x))
+                          .catch((e) => console.error(e));
+                      }}
                     >
                       {file}
                     </button>

diff --git a/sites/docs/src/examples/example-data.ts b/sites/docs/src/examples/example-data.ts
@@ -234,6 +234,7 @@ export const produceSchema: any = {
     veggie: {
       type: "object",
       required: ["veggieName", "veggieLike"],
+      additionalproperties: false,
       properties: {
         veggieName: {
           type: "string",

diff --git a/sites/docs/src/examples/example-utils.tsx b/sites/docs/src/examples/example-utils.tsx
@@ -35,7 +35,9 @@ export const usePersistedState = (name: string, defaultValue: any) => {
   useEffect(() => {
     try {
       localStorage.setItem(nameRef.current, value);
-    } catch {}
+    } catch (e) {
+      console.error(e);
+    }
   }, [value]);
 
   useEffect(() => {
@@ -45,7 +47,9 @@ export const usePersistedState = (name: string, defaultValue: any) => {
         localStorage.setItem(name, value);
         nameRef.current = name;
         localStorage.removeItem(lastName);
-      } catch {}
+      } catch (e) {
+        console.error(e);
+      }
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [name]);

diff --git a/sites/docs/src/examples/histograms.tsx b/sites/docs/src/examples/histograms.tsx
@@ -261,7 +261,7 @@ function buildHistogramProjection(
       pointerEvents: "none",
       x:
         xScale.bandwidth() / 2 +
-        (!!selectedBin ? xScale(selectedBin.x0 as any) || 0 : 0),
+        (selectedBin ? xScale(selectedBin.x0 as any) || 0 : 0),
     };
     const chartProps = {
       histogram,