From d7bdff0642cb7631bba1ca6b9e24002157f568c9 Mon Sep 17 00:00:00 2001 From: arlo Date: Fri, 29 Dec 2023 15:17:56 +0800 Subject: [PATCH 1/3] docs: add package readme --- packages/devtools-api/README.md | 7 +++++++ packages/devtools/README.md | 7 +++++++ packages/vite/README.md | 31 +++++++++++++++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 packages/devtools-api/README.md create mode 100644 packages/devtools/README.md create mode 100644 packages/vite/README.md diff --git a/packages/devtools-api/README.md b/packages/devtools-api/README.md new file mode 100644 index 000000000..b10b735e3 --- /dev/null +++ b/packages/devtools-api/README.md @@ -0,0 +1,7 @@ +# @vue/devtools-api + +> Plugins API for easier DevTools integrations. + +## Getting Started + +Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/plugins/api). diff --git a/packages/devtools/README.md b/packages/devtools/README.md new file mode 100644 index 000000000..32ea945ea --- /dev/null +++ b/packages/devtools/README.md @@ -0,0 +1,7 @@ +# @vue/devtools + +> This package provides a standalone vue-devtools application, that can be used to debug any Vue app regardless of the environment. Now you can debug your app opened in mobile browser, safari, native script etc. not just desktop chrome or firefox. + +## Getting Started + +Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/guide/standalone). diff --git a/packages/vite/README.md b/packages/vite/README.md new file mode 100644 index 000000000..d43b8395c --- /dev/null +++ b/packages/vite/README.md @@ -0,0 +1,31 @@ +# vite-plugin-vue-devtools + +> `vite-plugin-vue-devtools` is a `Vite` plugin designed to enhance the `Vue` developer experience. + +## Installation + +```sh + +npm add -D vite-plugin-vue-devtools + +``` + +## Usage + +### Configuration Vite + +```ts +import { defineConfig } from 'vite' +import VueDevTools from 'vite-plugin-vue-devtools' + +export default defineConfig({ + plugins: [ + VueDevTools(), + vue(), + ], +}) +``` + +## Documentation + +Check out all the DevTools details at [devtools-next.vuejs.org](https://devtools-next.vuejs.org). From bfa6795034ce86f5586f9649e5122086a79085af Mon Sep 17 00:00:00 2001 From: arlo Date: Fri, 29 Dec 2023 15:49:13 +0800 Subject: [PATCH 2/3] chore: update --- docs/guide/contributing.md | 33 ++++++++++++++++++++-------- packages/browser-extension/README.md | 3 +++ packages/client/README.md | 3 +++ packages/core/README.md | 3 +++ packages/devtools-kit/README.md | 3 +++ packages/electron/README.md | 3 +++ packages/schema/README.md | 3 +++ packages/shared/README.md | 3 +++ packages/ui/README.md | 3 +++ 9 files changed, 48 insertions(+), 9 deletions(-) create mode 100644 packages/browser-extension/README.md create mode 100644 packages/client/README.md create mode 100644 packages/core/README.md create mode 100644 packages/devtools-kit/README.md create mode 100644 packages/electron/README.md create mode 100644 packages/schema/README.md create mode 100644 packages/shared/README.md create mode 100644 packages/ui/README.md diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md index a2388764b..dd9453468 100644 --- a/docs/guide/contributing.md +++ b/docs/guide/contributing.md @@ -2,26 +2,41 @@ > Hi! We're really excited that you're interested in contributing to Vue DevTools! Before submitting your contribution, please read through the following guide. -## Monorepo +## Development Setup -The Vue DevTools repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/). -After cloning the repo, run in the root folder. +You will need [Node.js](https://nodejs.org) **version 18.12+**, and [PNPM](https://pnpm.io) **version 8+**. -```sh -pnpm i +We also recommend installing [@antfu/ni](https://github.com/antfu/ni) to help switching between repos using different package managers. `ni` also provides the handy `nr` command which running npm scripts easier. + +After cloning the repo, run: + +```bash +$ pnpm i # install the dependencies of the project ``` -## Development +## Git Hooks + +The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit: + +- Automatically format changed files using ESLint -### Setup +## Development -Build the project by +Build the project with watch mode: ```sh pnpm dev ``` -And then run the playground +OR + +Build the project with: + +```sh +pnpm build +``` + +And then run the playground: ```sh pnpm play diff --git a/packages/browser-extension/README.md b/packages/browser-extension/README.md new file mode 100644 index 000000000..801e8cce7 --- /dev/null +++ b/packages/browser-extension/README.md @@ -0,0 +1,3 @@ +# Browser extension + +> DevTools Browser extension, coming soon... diff --git a/packages/client/README.md b/packages/client/README.md new file mode 100644 index 000000000..63a01946b --- /dev/null +++ b/packages/client/README.md @@ -0,0 +1,3 @@ +# DevTools Client + +> Client for the DevTools. diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 000000000..ece64eb54 --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,3 @@ +# @vue/devtools-core + +> Internal core functions shared across @vue/devtools packages. diff --git a/packages/devtools-kit/README.md b/packages/devtools-kit/README.md new file mode 100644 index 000000000..dcc524181 --- /dev/null +++ b/packages/devtools-kit/README.md @@ -0,0 +1,3 @@ +# @vue/devtools-kit + +> Utility kit for DevTools. diff --git a/packages/electron/README.md b/packages/electron/README.md new file mode 100644 index 000000000..6df029c8b --- /dev/null +++ b/packages/electron/README.md @@ -0,0 +1,3 @@ +# Electron + +> DevTools Electron App, used in [@vue/devtools](../devtools/README.md). diff --git a/packages/schema/README.md b/packages/schema/README.md new file mode 100644 index 000000000..6e9cf2f37 --- /dev/null +++ b/packages/schema/README.md @@ -0,0 +1,3 @@ +# @vue/devtools-ui + +> UI kit for DevTools. diff --git a/packages/shared/README.md b/packages/shared/README.md new file mode 100644 index 000000000..cd09af6b1 --- /dev/null +++ b/packages/shared/README.md @@ -0,0 +1,3 @@ +# @vue/devtools-shared + +> Internal utility types shared across @vue/devtools packages. diff --git a/packages/ui/README.md b/packages/ui/README.md new file mode 100644 index 000000000..6e9cf2f37 --- /dev/null +++ b/packages/ui/README.md @@ -0,0 +1,3 @@ +# @vue/devtools-ui + +> UI kit for DevTools. From 4d26f12a226d4a3a5b2319c04e6272013c60b389 Mon Sep 17 00:00:00 2001 From: arlo Date: Fri, 29 Dec 2023 16:02:41 +0800 Subject: [PATCH 3/3] chore: update --- packages/client/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/client/README.md b/packages/client/README.md index 63a01946b..f3a216db9 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -1,3 +1,3 @@ # DevTools Client -> Client for the DevTools. +> Client for DevTools.