From e6fa562d8270872d9f4c47c18c93586a381b9dd9 Mon Sep 17 00:00:00 2001 From: Haoqun Jiang Date: Wed, 11 Aug 2021 17:26:15 +0800 Subject: [PATCH] chore: regenerate all template snapshots with the new readme --- playground/default/README.md | 24 ++++++++----- .../jsx-router-vuex-with-tests/README.md | 36 ++++++++++++++----- playground/jsx-router-vuex/README.md | 24 ++++++++----- playground/jsx-router/README.md | 24 ++++++++----- playground/jsx/README.md | 24 ++++++++----- playground/router-vuex-with-tests/README.md | 36 ++++++++++++++----- playground/router-vuex/README.md | 24 ++++++++----- playground/router/README.md | 24 ++++++++----- .../README.md | 32 +++++++++++++++-- .../typescript-jsx-router-vuex/README.md | 20 +++++++++-- playground/typescript-jsx-router/README.md | 20 +++++++++-- playground/typescript-jsx/README.md | 20 +++++++++-- playground/typescript/README.md | 20 +++++++++-- playground/vuex-with-tests/README.md | 36 ++++++++++++++----- playground/vuex/README.md | 24 ++++++++----- playground/with-tests/README.md | 36 ++++++++++++++----- 16 files changed, 321 insertions(+), 103 deletions(-) diff --git a/playground/default/README.md b/playground/default/README.md index c3a42c19..134a494c 100644 --- a/playground/default/README.md +++ b/playground/default/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# default This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/jsx-router-vuex-with-tests/README.md b/playground/jsx-router-vuex-with-tests/README.md index c3a42c19..3a1af2bc 100644 --- a/playground/jsx-router-vuex-with-tests/README.md +++ b/playground/jsx-router-vuex-with-tests/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# jsx-router-vuex-with-tests This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,36 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) + +```sh +npm run test:unit # or `npm run test:unit:ci` for headless testing +``` -## Usage +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - +```sh +npm run test:e2e # or `npm run test:e2e:ci` for headless testing +``` diff --git a/playground/jsx-router-vuex/README.md b/playground/jsx-router-vuex/README.md index c3a42c19..981dd4be 100644 --- a/playground/jsx-router-vuex/README.md +++ b/playground/jsx-router-vuex/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# jsx-router-vuex This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/jsx-router/README.md b/playground/jsx-router/README.md index c3a42c19..c9db8b37 100644 --- a/playground/jsx-router/README.md +++ b/playground/jsx-router/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# jsx-router This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/jsx/README.md b/playground/jsx/README.md index c3a42c19..1c565bea 100644 --- a/playground/jsx/README.md +++ b/playground/jsx/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# jsx This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/router-vuex-with-tests/README.md b/playground/router-vuex-with-tests/README.md index c3a42c19..31cca85b 100644 --- a/playground/router-vuex-with-tests/README.md +++ b/playground/router-vuex-with-tests/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# router-vuex-with-tests This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,36 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) + +```sh +npm run test:unit # or `npm run test:unit:ci` for headless testing +``` -## Usage +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - +```sh +npm run test:e2e # or `npm run test:e2e:ci` for headless testing +``` diff --git a/playground/router-vuex/README.md b/playground/router-vuex/README.md index c3a42c19..1370c292 100644 --- a/playground/router-vuex/README.md +++ b/playground/router-vuex/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# router-vuex This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/router/README.md b/playground/router/README.md index c3a42c19..0c65c96d 100644 --- a/playground/router/README.md +++ b/playground/router/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# router This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/typescript-jsx-router-vuex-with-tests/README.md b/playground/typescript-jsx-router-vuex-with-tests/README.md index c3a42c19..50634e8e 100644 --- a/playground/typescript-jsx-router-vuex-with-tests/README.md +++ b/playground/typescript-jsx-router-vuex-with-tests/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# typescript-jsx-router-vuex-with-tests This template should help get you started developing with Vue 3 in Vite. @@ -16,6 +16,32 @@ However, if you wish to get actual prop types in `.vue` imports (for example to See [Vite Configuration Reference](https://vitejs.dev/config/). -## Usage +## Project Setup - +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) + +```sh +npm run test:unit # or `npm run test:unit:ci` for headless testing +``` + +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) + +```sh +npm run test:e2e # or `npm run test:e2e:ci` for headless testing +``` diff --git a/playground/typescript-jsx-router-vuex/README.md b/playground/typescript-jsx-router-vuex/README.md index c3a42c19..288a9df2 100644 --- a/playground/typescript-jsx-router-vuex/README.md +++ b/playground/typescript-jsx-router-vuex/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# typescript-jsx-router-vuex This template should help get you started developing with Vue 3 in Vite. @@ -16,6 +16,20 @@ However, if you wish to get actual prop types in `.vue` imports (for example to See [Vite Configuration Reference](https://vitejs.dev/config/). -## Usage +## Project Setup - +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` diff --git a/playground/typescript-jsx-router/README.md b/playground/typescript-jsx-router/README.md index c3a42c19..037a49fa 100644 --- a/playground/typescript-jsx-router/README.md +++ b/playground/typescript-jsx-router/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# typescript-jsx-router This template should help get you started developing with Vue 3 in Vite. @@ -16,6 +16,20 @@ However, if you wish to get actual prop types in `.vue` imports (for example to See [Vite Configuration Reference](https://vitejs.dev/config/). -## Usage +## Project Setup - +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` diff --git a/playground/typescript-jsx/README.md b/playground/typescript-jsx/README.md index c3a42c19..800c86ff 100644 --- a/playground/typescript-jsx/README.md +++ b/playground/typescript-jsx/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# typescript-jsx This template should help get you started developing with Vue 3 in Vite. @@ -16,6 +16,20 @@ However, if you wish to get actual prop types in `.vue` imports (for example to See [Vite Configuration Reference](https://vitejs.dev/config/). -## Usage +## Project Setup - +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` diff --git a/playground/typescript/README.md b/playground/typescript/README.md index c3a42c19..8f766e02 100644 --- a/playground/typescript/README.md +++ b/playground/typescript/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# typescript This template should help get you started developing with Vue 3 in Vite. @@ -16,6 +16,20 @@ However, if you wish to get actual prop types in `.vue` imports (for example to See [Vite Configuration Reference](https://vitejs.dev/config/). -## Usage +## Project Setup - +```sh +npm install +``` + +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Type-Check, Compile and Minify for Production + +```sh +npm run build +``` diff --git a/playground/vuex-with-tests/README.md b/playground/vuex-with-tests/README.md index c3a42c19..6977da3b 100644 --- a/playground/vuex-with-tests/README.md +++ b/playground/vuex-with-tests/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# vuex-with-tests This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,36 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) + +```sh +npm run test:unit # or `npm run test:unit:ci` for headless testing +``` -## Usage +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - +```sh +npm run test:e2e # or `npm run test:e2e:ci` for headless testing +``` diff --git a/playground/vuex/README.md b/playground/vuex/README.md index c3a42c19..a087c53e 100644 --- a/playground/vuex/README.md +++ b/playground/vuex/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# vuex This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,24 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` -## Usage +### Compile and Minify for Production - +```sh +npm run build +``` diff --git a/playground/with-tests/README.md b/playground/with-tests/README.md index c3a42c19..95bb761e 100644 --- a/playground/with-tests/README.md +++ b/playground/with-tests/README.md @@ -1,4 +1,4 @@ -# Vue 3 + Vite +# with-tests This template should help get you started developing with Vue 3 in Vite. @@ -6,16 +6,36 @@ This template should help get you started developing with Vue 3 in Vite. [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). -## Type Support for `.vue` Imports in TS +## Customize configuration -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. +See [Vite Configuration Reference](https://vitejs.dev/config/). -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. +## Project Setup -## Customize configuration +```sh +npm install +``` -See [Vite Configuration Reference](https://vitejs.dev/config/). +### Compile and Hot-Reload for Development + +```sh +npm run dev +``` + +### Compile and Minify for Production + +```sh +npm run build +``` + +### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) + +```sh +npm run test:unit # or `npm run test:unit:ci` for headless testing +``` -## Usage +### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - +```sh +npm run test:e2e # or `npm run test:e2e:ci` for headless testing +``` -- 2.39.5