Skip to content

Commit

Permalink
change(docs): use pnpm workspaces (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
enzonotario committed Jan 20, 2025
1 parent 298c933 commit 3471acc
Show file tree
Hide file tree
Showing 16 changed files with 498 additions and 59 deletions.
20 changes: 1 addition & 19 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { resolve } from 'node:path'
import { useSidebar } from 'vitepress-openapi'
import { defineConfigWithTheme } from 'vitepress'
import spec from '../public/openapi.json' assert { type: 'json' }
import { examplesPages } from '../pages'
import { defineConfigWithTheme } from 'vitepress'

const sidebar = useSidebar({
spec,
Expand Down Expand Up @@ -235,21 +234,4 @@ export default defineConfigWithTheme({
gtag('config', '${gaId}');`,
],
],
vite: {
resolve: {
...(process.env.NODE_ENV === 'production'
? {
alias: {
'vitepress-openapi/client': resolve(__dirname, '../../dist/client'),
'vitepress-openapi': resolve(__dirname, '../../dist/index'),
},
}
: {
alias: {
'vitepress-openapi/client': resolve(__dirname, '../../src/client'),
'vitepress-openapi': resolve(__dirname, '../../src/index'),
},
}),
},
},
})
2 changes: 1 addition & 1 deletion docs/.vitepress/theme/components/sandbox/Sandbox.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { provide, watch } from 'vue'
import { compressToURL, decompressFromURL } from '@amoutonbrady/lz-string'
import { useTheme } from 'vitepress-openapi/client'
import { useUrlSearchParams } from '@vueuse/core'
import { useData } from 'vitepress'
import { ResizableHandle, ResizablePanel, ResizablePanelGroup } from '../ui/resizable'
import { deepUnref } from '../../../../../src/lib/deepUnref'
import Toaster from '../ui/toast/Toaster.vue'
Expand All @@ -13,7 +14,6 @@ import SandboxPreview from './SandboxPreview.vue'
import SandboxNav from './SandboxNav.vue'
import SandboxEditor from './SandboxEditor.vue'
import SandboxRemoteFetch from './SandboxRemoteFetch.vue'
import { useData } from 'vitepress'
const { isDark, hash } = useData()
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/theme/components/sandbox/SandboxEditor.vue
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<script setup lang="ts">
import JsonEditorVue from 'json-editor-vue'
import { inject, nextTick, ref, watch, watchEffect } from 'vue'
import type { SandboxData } from '../../sandboxData'
import { useData } from 'vitepress'
import type { SandboxData } from '../../sandboxData'
const { isDark } = useData()
Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/theme/components/sandbox/SandboxPreview.vue
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<script setup lang="ts">
import { VPHomeContent } from 'vitepress/theme'
import { inject, onMounted, watch } from 'vue'
import { useData } from 'vitepress'
import { getHeaders } from 'vitepress/dist/client/theme-default/composables/outline.js'
import { scrollIntoOperationByOperationId } from '../../../../../src/lib/utils'
import VPDocAsideOutline from '../vitepress/VPDocAsideOutline.vue'
import type { SandboxData } from '../../sandboxData'
import SandboxPreviewSidebar from './SandboxPreviewSidebar.vue'
import { useData } from 'vitepress'
import { getHeaders } from 'vitepress/dist/client/theme-default/composables/outline.js'
const { isDark, theme, page } = useData()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<script setup lang="ts">
import { inject, onBeforeMount, onMounted, ref, watch } from 'vue'
import { useSidebar } from 'vitepress-openapi'
import type { SandboxData } from '../../sandboxData'
import { useData } from 'vitepress'
import VPSidebar from 'vitepress/dist/client/theme-default/components/VPSidebar.vue'
import { getHeaders } from 'vitepress/dist/client/theme-default/composables/outline.js'
import type { SandboxData } from '../../sandboxData'
const { theme } = useData()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<script setup lang="ts">
import { inject, ref, watch } from 'vue'
import type { SandboxData } from '../../sandboxData'
import { useData } from 'vitepress'
import {
getHeaders,
resolveTitle,
useActiveAnchor,
} from 'vitepress/dist/client/theme-default/composables/outline.js'
import VPDocOutlineItem from 'vitepress/dist/client/theme-default/components/VPDocOutlineItem.vue'
import type { SandboxData } from '../../sandboxData'
const { theme } = useData()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script lang="ts" setup>
import { inject, ref, watchPostEffect } from 'vue'
import VPSwitch from './VPSwitch.vue'
import { useData } from 'vitepress'
import VPSwitch from './VPSwitch.vue'
const { isDark, theme } = useData()
Expand Down
2 changes: 2 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import DefaultTheme from 'vitepress/theme'
import spec from '../../public/openapi.json' assert {type: 'json'}
import ExampleBlock from './components/ExampleBlock.vue'
import SandboxIframe from './components/sandbox/SandboxIframe.vue'
import 'vitepress-openapi/dist/style.css'
import './style.css'

export default {
extends: DefaultTheme,
Expand Down
3 changes: 3 additions & 0 deletions docs/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@tailwind base;
@tailwind components;
@tailwind utilities;
41 changes: 41 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "vitepress-openapi-docs",
"version": "0.0.0",
"type": "module",
"private": true,
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"serve": "vitepress serve"
},
"dependencies": {
"@vueuse/core": "^10.11.0",
"class-variance-authority": "^0.7.0",
"clsx": "^2.1.1",
"lucide-vue-next": "^0.411.0",
"radix-vue": "^1.9.1",
"tailwind-merge": "^2.4.0",
"tailwindcss-animate": "^1.0.7",
"vitepress-openapi": "workspace:*"
},
"devDependencies": {
"@amoutonbrady/lz-string": "^0.1.0",
"@antfu/eslint-config": "^2.27.1",
"@iconify/vue": "^4.2.0",
"@types/node": "^22.5.1",
"@vitejs/plugin-vue": "^5.1.3",
"autoprefixer": "^10.4.20",
"eslint": "^9.9.1",
"eslint-plugin-cypress": "^3.5.0",
"eslint-plugin-format": "^0.1.2",
"postcss": "^8.4.42",
"tailwindcss": "^3.4.10",
"vite": "^5.4.2",
"vitepress": "^1.4.1",
"vitest": "^2.0.5",
"vue": "^3.4.38"
},
"resolutions": {
"@typescript-eslint/utils": "^8.2.0"
}
}
10 changes: 5 additions & 5 deletions docs/pages.ts
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
export const testsPages = [
{
slug: 'response-types',
specPath: './docs/public/openapi-response-types.json',
specPath: './public/openapi-response-types.json',
themeConfig: {},
},
{
slug: 'response-statuses',
specPath: './docs/public/openapi-response-statuses.json',
specPath: './public/openapi-response-statuses.json',
themeConfig: {},
},
{
slug: 'schemas',
specPath: './docs/public/openapi-schemas.json',
specPath: './public/openapi-schemas.json',
themeConfig: {},
},
{
slug: 'parameters',
specPath: './docs/public/openapi-parameters.json',
specPath: './public/openapi-parameters.json',
themeConfig: {},
},
{
slug: 'security',
specPath: './docs/public/openapi-security.json',
specPath: './public/openapi-security.json',
themeConfig: {},
},
]
Expand Down
15 changes: 15 additions & 0 deletions docs/tailwind.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
const animate = require('tailwindcss-animate')
const base = require('../tailwind.config')

/** @type {import('tailwindcss').Config} */
module.exports = {
darkMode: ['class'],
safelist: ['dark'],
prefix: '',
content: [
'./.vitepress/theme/**/*.{vue,js,ts,jsx,tsx}',
'./sidebar/*.md',
],
theme: base.theme,
plugins: [animate],
}
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@
],
"exports": {
".": {
"types": "./dist/types/index.d.ts",
"import": "./dist/vitepress-openapi.node.es.js",
"require": "./dist/vitepress-openapi.node.umd.js"
},
"./client": {
"types": "./dist/types/client.d.ts",
"import": "./dist/vitepress-openapi.client.es.js",
"require": "./dist/vitepress-openapi.client.umd.js"
},
Expand All @@ -40,9 +42,8 @@
"prepublishOnly": "pnpm run build",
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"docs:dev": "VITE_DEBUG=1 IS_DOCS=1 vitepress dev docs",
"dev": "pnpm run docs:dev",
"docs:build": "IS_DOCS=1 pnpm run build && IS_DOCS=1 vitepress build docs",
"dev": "cd docs && pnpm run dev",
"docs:build": "pnpm run build && cd docs && pnpm run build",
"test": "vitest",
"test:run": "vitest --run",
"typecheck": "vue-tsc --noEmit"
Expand All @@ -61,9 +62,7 @@
"tailwindcss-animate": "^1.0.7"
},
"devDependencies": {
"@amoutonbrady/lz-string": "^0.1.0",
"@antfu/eslint-config": "^2.27.1",
"@iconify/vue": "^4.2.0",
"@scalar/openapi-types": "^0.1.5",
"@sindresorhus/slugify": "^2.2.1",
"@trojs/openapi-dereference": "^0.2.3",
Expand Down
Loading

0 comments on commit 3471acc

Please sign in to comment.