diff --git a/package.json b/package.json index 1ccdced2..9bd3eebc 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "scripts": { "dev": "vocs dev", "build": "vocs build", - "preview": "vocs preview" + "preview": "vocs preview", + "format": "prettier --write README.md \"docs/**/*.{js,jsx,ts,tsx,json,md}\"" }, "dependencies": { "@radix-ui/react-tabs": "^1.0.4", @@ -15,5 +16,17 @@ "typescript": "latest", "vocs": "1.0.0-alpha.47" }, + "devDependencies": { + "@homer0/prettier-plugin-jsdoc": "^9.0.0", + "prettier": "^3.2.5" + }, + "prettier": { + "printWidth": 80, + "semi": false, + "trailingComma": "all", + "plugins": [ + "@homer0/prettier-plugin-jsdoc" + ] + }, "packageManager": "pnpm@9.1.0+sha256.22e36fba7f4880ecf749a5ca128b8435da085ecd49575e7fb9e64d6bf4fad394" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c89d9d52..b466528e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -26,6 +26,13 @@ importers: vocs: specifier: 1.0.0-alpha.47 version: 1.0.0-alpha.47(@types/node@20.12.10)(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(rollup@4.17.2)(typescript@5.4.5) + devDependencies: + '@homer0/prettier-plugin-jsdoc': + specifier: ^9.0.0 + version: 9.0.0 + prettier: + specifier: ^3.2.5 + version: 3.2.5 packages: @@ -458,6 +465,10 @@ packages: '@floating-ui/utils@0.2.2': resolution: {integrity: sha512-J4yDIIthosAsRZ5CPYP/jQvUAQtlZTTD/4suA08/FEnlxqW3sKS9iAhgsa9VYLZ6vDHn/ixJgIqRQPotoBjxIw==} + '@homer0/prettier-plugin-jsdoc@9.0.0': + resolution: {integrity: sha512-MZwkVlvtiUjLjtpH7QLw1q0DijzFph5nMZ8z8altH/NDgQD+moiicES6oY2A8+1MhrayIqfOcJ58z/BDrrUXJQ==} + engines: {node: '>=18.17 <21'} + '@hono/node-server@1.11.1': resolution: {integrity: sha512-GW1Iomhmm1o4Z+X57xGby8A35Cu9UZLL7pSMdqDBkD99U5cywff8F+8hLk5aBTzNubnsFAvWQ/fZjNwPsEn9lA==} engines: {node: '>=18.14.1'} @@ -1234,6 +1245,10 @@ packages: resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==} engines: {node: '>= 6'} + comment-parser@1.4.1: + resolution: {integrity: sha512-buhp5kePrmda3vhc5B9t7pUQXAb2Tnd0qgpkIhPhkHXxJpiPJ11H0ZEU0oBpJ2QztSbzG/ZxMj/CHsYJqRHmyg==} + engines: {node: '>= 12.0.0'} + compressible@2.0.18: resolution: {integrity: sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==} engines: {node: '>= 0.6'} @@ -2099,6 +2114,11 @@ packages: resolution: {integrity: sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==} engines: {node: ^10 || ^12 || >=14} + prettier@3.2.5: + resolution: {integrity: sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==} + engines: {node: '>=14'} + hasBin: true + prop-types@15.8.1: resolution: {integrity: sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==} @@ -2108,6 +2128,9 @@ packages: queue-microtask@1.2.3: resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} + ramda@0.29.1: + resolution: {integrity: sha512-OfxIeWzd4xdUNxlWhgFazxsA/nl3mS4/jGZI5n00uWOoSSFRhC1b6gl6xvmzUamgmqELraWp0J/qqVlXYPDPyA==} + range-parser@1.2.1: resolution: {integrity: sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==} engines: {node: '>= 0.6'} @@ -2923,6 +2946,12 @@ snapshots: '@floating-ui/utils@0.2.2': {} + '@homer0/prettier-plugin-jsdoc@9.0.0': + dependencies: + comment-parser: 1.4.1 + prettier: 3.2.5 + ramda: 0.29.1 + '@hono/node-server@1.11.1': {} '@isaacs/cliui@8.0.2': @@ -3754,6 +3783,8 @@ snapshots: commander@4.1.1: {} + comment-parser@1.4.1: {} + compressible@2.0.18: dependencies: mime-db: 1.52.0 @@ -4945,6 +4976,8 @@ snapshots: picocolors: 1.0.0 source-map-js: 1.2.0 + prettier@3.2.5: {} + prop-types@15.8.1: dependencies: loose-envify: 1.4.0 @@ -4955,6 +4988,8 @@ snapshots: queue-microtask@1.2.3: {} + ramda@0.29.1: {} + range-parser@1.2.1: {} react-dom@18.3.1(react@18.3.1): diff --git a/tailwind.config.cjs b/tailwind.config.cjs index 18b644b4..fe2b8643 100644 --- a/tailwind.config.cjs +++ b/tailwind.config.cjs @@ -1,8 +1,10 @@ -/** @type {import('tailwindcss').Config} */ +/** + * @type {import("tailwindcss").Config} + */ module.exports = { content: ["./docs/**/*.{html,md,mdx,tsx,js,jsx}"], theme: { extend: {}, }, plugins: [], -}; +} diff --git a/vocs.config.tsx b/vocs.config.tsx index e18c2726..9fe78d1f 100644 --- a/vocs.config.tsx +++ b/vocs.config.tsx @@ -1,4 +1,4 @@ -import { defineConfig } from "vocs"; +import { defineConfig } from "vocs" export default defineConfig({ title: "Polkadot-API", @@ -56,4 +56,4 @@ export default defineConfig({ link: "https://github.com/polkadot-api/polkadot-api", }, ], -}); +})