diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 6e214637b2..2123014a51 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -11,7 +11,7 @@ module.exports = { themeConfig: { repo: 'vuejs/vue-cli', docsDir: 'docs', - docsBranch: 'dev', + docsBranch: 'docs', editLinks: true, sidebarDepth: 3, locales: { diff --git a/docs/config/README.md b/docs/config/README.md index 8bafdfda91..7a6e0f9d61 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -8,7 +8,7 @@ sidebar: auto ## Global CLI Config -Some global configurations for `@vue/cli`, such as your preferred package manager and your locally saved presets, are stored in a JSON file named `.vuerc` in your home directory. You can edit this file directory with your editor of choice to change the saved options. +Some global configurations for `@vue/cli`, such as your preferred package manager and your locally saved presets, are stored in a JSON file named `.vuerc` in your home directory. You can edit this file directly with your editor of choice to change the saved options. You can also use the `vue config` command to inspect or modify the global CLI config. diff --git a/docs/guide/README.md b/docs/guide/README.md index 5469501744..eb8bfeb3cd 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -20,7 +20,7 @@ Vue CLI is a full system for rapid Vue.js development, providing: - Configurable via in-project config file; - Extensible via plugins - A rich collection of official plugins integrating the best tools in the frontend ecosystem. -- A full graphical user intefrace to create and manage Vue.js projects. +- A full graphical user interface to create and manage Vue.js projects. Vue CLI aims to be the standard tooling baseline for the Vue ecosystem. It ensures the various build tools work smoothly together with sensible defaults so you can focus on writing your app instead of spending days wrangling with configurations. At the same time, it still offers the flexibility to tweak the config of each tool without the need for ejecting. diff --git a/docs/guide/html-and-static-assets.md b/docs/guide/html-and-static-assets.md index 38979cb03d..d054f25aa0 100644 --- a/docs/guide/html-and-static-assets.md +++ b/docs/guide/html-and-static-assets.md @@ -108,9 +108,9 @@ Internally, we use `file-loader` to determine the final file location with versi ### The `public` Folder -Any static assets placed in the `public` folder will simply be copied and not go through webpack. You need to reference to them using absolute paths. +Any static assets placed in the `public` folder will simply be copied and not go through webpack. You need to reference them using absolute paths. -Note we recommended importing assets as part of your module dependency graph so that they will go through webpack with the following benefits: +Note we recommend importing assets as part of your module dependency graph so that they will go through webpack with the following benefits: - Scripts and stylesheets get minified and bundled together to avoid extra network requests. - Missing files cause compilation errors instead of 404 errors for your users. diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 9b3eb1047f..e837abb412 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -9,7 +9,7 @@ If you have the previous `vue-cli` (1.x or 2.x) package installed globally, you Vue CLI requires [Node.js](https://nodejs.org/) version 8.9 or above (8.11.0+ recommended). You can manage multiple versions of Node on the same machine with [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows). ::: -To install the new package, use on of those commands: +To install the new package, use one of those commands: ``` bash npm install -g @vue/cli diff --git a/packages/@vue/eslint-config-airbnb/README.md b/packages/@vue/eslint-config-airbnb/README.md index 595582e5c1..e22287a86f 100644 --- a/packages/@vue/eslint-config-airbnb/README.md +++ b/packages/@vue/eslint-config-airbnb/README.md @@ -1,3 +1,11 @@ # @vue/eslint-config-airbnb > eslint-config-airbnb for vue-cli + +This config is specifically designed to be used by `vue-cli` setups +and is not meant for outside use (it can be used but some adaptations +on the user side might be needed - for details see the config file). + +A part of its design is that this config may implicitly depend on +other parts of `vue-cli` setups, such as `eslint-plugin-vue` being +extended in the same resulting config. diff --git a/packages/@vue/eslint-config-prettier/README.md b/packages/@vue/eslint-config-prettier/README.md index e83fedceae..e2d532eb71 100644 --- a/packages/@vue/eslint-config-prettier/README.md +++ b/packages/@vue/eslint-config-prettier/README.md @@ -1,3 +1,11 @@ # @vue/eslint-config-prettier > eslint-config-prettier for vue-cli + +This config is specifically designed to be used by `vue-cli` setups +and is not meant for outside use (it can be used but some adaptations +on the user side might be needed - for details see the config file). + +A part of its design is that this config may implicitly depend on +other parts of `vue-cli` setups, such as `eslint-plugin-vue` being +extended in the same resulting config. diff --git a/packages/@vue/eslint-config-standard/README.md b/packages/@vue/eslint-config-standard/README.md index ccf8fe7628..99c2e6e7dc 100644 --- a/packages/@vue/eslint-config-standard/README.md +++ b/packages/@vue/eslint-config-standard/README.md @@ -1,3 +1,11 @@ # @vue/eslint-config-standard > eslint-config-standard for vue-cli + +This config is specifically designed to be used by `vue-cli` setups +and is not meant for outside use (it can be used but some adaptations +on the user side might be needed - for details see the config file). + +A part of its design is that this config may implicitly depend on +other parts of `vue-cli` setups, such as `eslint-plugin-vue` being +extended in the same resulting config. diff --git a/packages/@vue/eslint-config-typescript/README.md b/packages/@vue/eslint-config-typescript/README.md index 96d95718c5..8d61bbf254 100644 --- a/packages/@vue/eslint-config-typescript/README.md +++ b/packages/@vue/eslint-config-typescript/README.md @@ -1,3 +1,11 @@ # @vue/eslint-config-typescript -> eslint-config-typescript for vue-cli \ No newline at end of file +> eslint-config-typescript for vue-cli + +This config is specifically designed to be used by `vue-cli` setups +and is not meant for outside use (it can be used but some adaptations +on the user side might be needed - for details see the config file). + +A part of its design is that this config may implicitly depend on +other parts of `vue-cli` setups, such as `eslint-plugin-vue` being +extended in the same resulting config. diff --git a/packages/@vue/eslint-config-typescript/index.js b/packages/@vue/eslint-config-typescript/index.js index e013e87c5d..e8ef6c05d2 100644 --- a/packages/@vue/eslint-config-typescript/index.js +++ b/packages/@vue/eslint-config-typescript/index.js @@ -1,5 +1,9 @@ module.exports = { plugins: ['typescript'], + // Prerequisite `eslint-plugin-vue`, being extended, sets + // root property `parser` to `'vue-eslint-parser'`, which, for code parsing, + // in turn delegates to the parser, specified in `parserOptions.parser`: + // https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error parserOptions: { parser: require.resolve('typescript-eslint-parser') },