Run formating/linting, added to CI (zuplo#159)

ntotten · web-flow · commit d7bf49de8ce8 · 2024-09-04T10:48:03.000-04:00
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged
+npx lint-staged
diff --git a/.prettierignore b/.prettierignore
@@ -8,4 +8,5 @@ packages/zudoku/standalone/
 /.nx/workspace-data
 pnpm-lock.yaml
 .next/
-stats.html
+stats.html
+.vercel/
diff --git a/.prettierrc b/.prettierrc
@@ -1 +1,11 @@
-{ "plugins": ["prettier-plugin-organize-imports"] }
+{
+  "plugins": ["prettier-plugin-organize-imports"],
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "proseWrap": "always"
+      }
+    }
+  ]
+}
diff --git a/LICENSE.md b/LICENSE.md
@@ -2,20 +2,8 @@ The MIT License (MIT)
 
 Copyright (c) Zuplo, Inc.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -9,11 +9,7 @@
 
 ## API documentation should always be free.
 
-[![MIT License](https://img.shields.io/badge/license-mit-green?style=for-the-badge&labelColor=000000)](https://github.com/zuplo/zudoku/license.md)
-[![Zudoku Version](https://img.shields.io/npm/v/zudoku.svg?style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/zudoku)
-[![Create Zudoku App Version](https://img.shields.io/npm/v/create-zudoku-app?label=cli&style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/create-zudoku-app)
-[![Made with love by Zuplo](https://img.shields.io/badge/MADE%20BY%20Zuplo-FF00BD.svg?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCAzNyAzMiIgYXJpYS1oaWRkZW49InRydWUiPgogIDxwYXRoIGZpbGw9IiNGRjAwQkQiIGQ9Ik0yNy4xNDIgMTkuOTc4SDE2LjYyTDI3LjgzIDguNzQ2YS43NTguNzU4IDAgMDAtLjUzNC0xLjI5M0g5LjQ4OFYwaDE5LjUzNGE3LjU3MyA3LjU3MyAwIDAxNC4wNjUgMS4xMjUgNy41OTEgNy41OTEgMCAwMTIuODM2IDMuMTI2IDcuNDAyIDcuNDAyIDAgMDEtMS40NjEgOC4zOThsLTcuMzIgNy4zMjh6Ii8+CiAgPHBhdGggZmlsbD0iI0ZGMDBCRCIgZD0iTTkuNDg5IDExLjA0MmgxMC41MjRsLTExLjE5IDExLjIxYS43NzIuNzcyIDAgMDAuNTQzIDEuMzE2aDE3Ljc1OXY3LjQ1Mkg3LjYxYTcuNTc0IDcuNTc0IDAgMDEtNC4wNjUtMS4xMjVBNy41OTMgNy41OTMgMCAwMS43MSAyNi43NjhhNy40MDMgNy40MDMgMCAwMTEuNDYyLTguMzk3bDcuMzE4LTcuMzI5eiIvPgo8L3N2Zz4K&labelColor=000)](https://zuplo.com)
-[![Join the community on Discord](https://img.shields.io/badge/Chat%20on%20discord-5865F2.svg?style=for-the-badge&logo=discord&labelColor=000000&logoWidth=20)](https://discord.com/channels/848913990360629268/1235294876778627246)
+[![MIT License](https://img.shields.io/badge/license-mit-green?style=for-the-badge&labelColor=000000)](https://github.com/zuplo/zudoku/license.md) [![Zudoku Version](https://img.shields.io/npm/v/zudoku.svg?style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/zudoku) [![Create Zudoku App Version](https://img.shields.io/npm/v/create-zudoku-app?label=cli&style=for-the-badge&labelColor=000000)](https://www.npmjs.com/package/create-zudoku-app) [![Made with love by Zuplo](https://img.shields.io/badge/MADE%20BY%20Zuplo-FF00BD.svg?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCAzNyAzMiIgYXJpYS1oaWRkZW49InRydWUiPgogIDxwYXRoIGZpbGw9IiNGRjAwQkQiIGQ9Ik0yNy4xNDIgMTkuOTc4SDE2LjYyTDI3LjgzIDguNzQ2YS43NTguNzU4IDAgMDAtLjUzNC0xLjI5M0g5LjQ4OFYwaDE5LjUzNGE3LjU3MyA3LjU3MyAwIDAxNC4wNjUgMS4xMjUgNy41OTEgNy41OTEgMCAwMTIuODM2IDMuMTI2IDcuNDAyIDcuNDAyIDAgMDEtMS40NjEgOC4zOThsLTcuMzIgNy4zMjh6Ii8+CiAgPHBhdGggZmlsbD0iI0ZGMDBCRCIgZD0iTTkuNDg5IDExLjA0MmgxMC41MjRsLTExLjE5IDExLjIxYS43NzIuNzcyIDAgMDAuNTQzIDEuMzE2aDE3Ljc1OXY3LjQ1Mkg3LjYxYTcuNTc0IDcuNTc0IDAgMDEtNC4wNjUtMS4xMjVBNy41OTMgNy41OTMgMCAwMS43MSAyNi43NjhhNy40MDMgNy40MDMgMCAwMTEuNDYyLTguMzk3bDcuMzE4LTcuMzI5eiIvPgo8L3N2Zz4K&labelColor=000)](https://zuplo.com) [![Join the community on Discord](https://img.shields.io/badge/Chat%20on%20discord-5865F2.svg?style=for-the-badge&logo=discord&labelColor=000000&logoWidth=20)](https://discord.com/channels/848913990360629268/1235294876778627246)
 
 </div>
 
@@ -36,11 +32,7 @@
 
 Because great API documentation frameworks should always be:
 
-✅ Free<br />
-✅ OpenAPI powered<br />
-✅ Extensible<br />
-✅ Low barrier to entry<br />
-✅ Easy to maintain
+✅ Free<br /> ✅ OpenAPI powered<br /> ✅ Extensible<br /> ✅ Low barrier to entry<br /> ✅ Easy to maintain
 
 ## 🤩 Try it, right now!
 
diff --git a/docs/pages/docs/markdown/admonitions.md b/docs/pages/docs/markdown/admonitions.md
@@ -83,9 +83,7 @@ Hello world
 
 <!-- Prettier changes this -->
 
-:::note
-Hello world
-:::
+:::note Hello world :::
 
 <!-- to this -->
 
diff --git a/docs/pages/docs/plugins.md b/docs/pages/docs/plugins.md
@@ -2,4 +2,4 @@
 title: Zudoku Plugins
 ---
 
-Zudoku can be extended using plugins.
+Zudoku can be extended using plugins.
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "zudoku-root",
+  "name": "root",
   "private": true,
   "version": "0.0.0",
   "type": "module",
@@ -10,7 +10,7 @@
     "format": "prettier --write .",
     "format:ci": "prettier --check .",
     "clean": "git clean -Xfde !.env",
-    "prepare": "husky prepare",
+    "prepare": "husky",
     "release:pre": "gh workflow run release.yaml -f releaseType=prerelease",
     "release:minor": "gh workflow run release.yaml -f releaseType=minor"
   },
diff --git a/packages/create-zudoku-app/LICENSE.md b/packages/create-zudoku-app/LICENSE.md
@@ -1,22 +1,9 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Vercel, Inc.
-Copyright (c) 2024 Zuplo, Inc.
+Copyright (c) 2024 Vercel, Inc. Copyright (c) 2024 Zuplo, Inc.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/create-zudoku-app/README.md b/packages/create-zudoku-app/README.md
@@ -16,8 +16,7 @@ pnpm create zudoku-app
 bunx create-zudoku-app
 ```
 
-You will be asked for the name of your project, and then whether you want to
-create a TypeScript project:
+You will be asked for the name of your project, and then whether you want to create a TypeScript project:
 
 ```bash
 ✔ Would you like to use TypeScript? … No / Yes
@@ -27,8 +26,7 @@ Select **Yes** to install the necessary types/dependencies and create a new TS p
 
 ### Non-interactive
 
-You can also pass command line arguments to set up a new project
-non-interactively. See `create-zudoku-app --help`:
+You can also pass command line arguments to set up a new project non-interactively. See `create-zudoku-app --help`:
 
 ```bash
 Usage: create-zudoku-app [project-directory] [options]
diff --git a/packages/create-zudoku-app/templates/default/js/pages/documentation/example.mdx b/packages/create-zudoku-app/templates/default/js/pages/documentation/example.mdx
@@ -1,4 +1,4 @@
 ---
 title: Example 1
 description: This is what the description would look like, for example.
----
+---
diff --git a/packages/create-zudoku-app/templates/default/js/pages/documentation/other-example.mdx b/packages/create-zudoku-app/templates/default/js/pages/documentation/other-example.mdx
@@ -2,4 +2,4 @@
 title: Another example
 ---
 
-Add your MDX power, right here!
+Add your MDX power, right here!
diff --git a/packages/zudoku/src/lib/components/context/ZudokuContext.ts b/packages/zudoku/src/lib/components/context/ZudokuContext.ts
@@ -39,7 +39,7 @@ export const useNavigation = () => {
   const { getPluginSidebar, sidebars } = useZudoku();
   const navItem = useTopNavigationItem();
   const path = navItem?.id;
-  const currentSidebar = path ? sidebars[path] ?? [] : [];
+  const currentSidebar = path ? (sidebars[path] ?? []) : [];
   const location = useLocation();
 
   return useSuspenseQuery({
diff --git a/packages/zudoku/src/lib/plugins/api-keys/SettingsApiKeys.tsx b/packages/zudoku/src/lib/plugins/api-keys/SettingsApiKeys.tsx
@@ -171,7 +171,7 @@ const RevealApiKey = ({ apiKey }: { apiKey: string }) => {
       <Button
         variant="outline"
         onClick={() => {
-          navigator.clipboard.writeText(apiKey).then(() => {
+          void navigator.clipboard.writeText(apiKey).then(() => {
             setCopied(true);
             setTimeout(() => setCopied(false), 2000);
           });
diff --git a/packages/zudoku/src/lib/plugins/openapi/playground/UrlDisplay.tsx b/packages/zudoku/src/lib/plugins/openapi/playground/UrlDisplay.tsx
@@ -10,8 +10,8 @@ export const UrlDisplay = ({ host, path }: { host: string; path: string }) => {
         .split("/")
         .map((v) =>
           v.startsWith("{") && v.endsWith("}")
-            ? data.pathParams.find((part) => part.name === v.slice(1, -1))
-                ?.value ?? v
+            ? (data.pathParams.find((part) => part.name === v.slice(1, -1))
+                ?.value ?? v)
             : v,
         )
         .join("/"),
diff --git a/packages/zudoku/src/lib/plugins/openapi/schema/SchemaComponents.tsx b/packages/zudoku/src/lib/plugins/openapi/schema/SchemaComponents.tsx
@@ -62,7 +62,7 @@ export const SchemaPropertyItem = ({
         <div className="flex gap-2 items-center">
           <code>{name}</code>
           <span className="text-muted-foreground">
-            {schema.type === "array" && schema.items?.type ? (
+            {schema.type === "array" && schema.items.type ? (
               <span>{schema.items.type}[]</span>
             ) : Array.isArray(schema.type) ? (
               <span>{schema.type.join(" | ")}</span>
diff --git a/website/public/asana.oas.yml b/website/public/asana.oas.yml
diff --git a/website/public/rick-and-morty.oas.json b/website/public/rick-and-morty.oas.json
