Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --inline-vue flag for build command to avoid externalization of Vue in lib & wc mode #4261

Merged
merged 5 commits into from
Aug 19, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat(docs): update docs for --inline-Vue flag
  • Loading branch information
romansp committed Aug 16, 2019
commit 08a8ed83d90a52ca25407258b9ad255908b71dd2
4 changes: 3 additions & 1 deletion docs/guide/build-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ App is the default build target. In this mode:
::: tip Note on Vue Dependency
In lib mode, Vue is *externalized*. This means the bundle will not bundle Vue even if your code imports Vue. If the lib is used via a bundler, it will attempt to load Vue as a dependency through the bundler; otherwise, it falls back to a global `Vue` variable.

You can avoid externalization of Vue by providing `--inline-vue` flag to `build` command.
To avoid this behavior provide `--inline-vue` flag to `build` command.

```
vue-cli-service build --target lib --inline-vue -name myLib [entry]
Expand Down Expand Up @@ -74,6 +74,8 @@ Web Component mode does not support IE11 and below. [More details](https://githu

::: tip Note on Vue Dependency
In web component mode, Vue is *externalized.* This means the bundle will not bundle Vue even if your code imports Vue. The bundle will assume `Vue` is available on the host page as a global variable.

To avoid this behavior provide `--inline-vue` flag to `build` command.
:::

You can build a single entry as a web component using
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/cli-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Options:
--modern build app targeting modern browsers with auto fallback
--target app | lib | wc | wc-async (default: app)
--formats list of output formats for library builds (default: commonjs,umd,umd-min)
--inline-vue disable externalization of Vue for lib mode
--inline-vue include the Vue module in the final bundle of library or web component target
--name name for lib or web-component mode (default: "name" in package.json or entry filename)
--no-clean do not remove the dist directory before building the project
--report generate report.html to help analyze bundle content
Expand Down
4 changes: 3 additions & 1 deletion docs/ru/guide/build-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
::: tip Примечание о зависимости Vue
В режиме библиотеки Vue *экстернализируется*. Это означает, что сборка не будет содержать Vue, даже если ваш код его импортирует. Если библиотека используется через сборщик, он должен попытаться загрузить Vue в качестве зависимости через сборщик; в противном случае, он должен вернуться к глобальной переменной `Vue`.

Чтобы избежать экстернализиции Vue можно установить флаг `--inline-vue` для команды `build`.
Чтобы избежать экстернализиции Vue установите флаг `--inline-vue` для команды `build`.

```
vue-cli-service build --target lib --inline-vue -name myLib [entry]
Expand Down Expand Up @@ -78,6 +78,8 @@ module.exports = {

::: tip Примечание зависимости Vue
В режиме веб-компонентов Vue *экстернализируется.* Это означает, что сборка не будет содержать Vue, даже если ваш код его импортирует. Сборка будет подразумевать, что `Vue` доступен на странице в качестве глобальной переменной.

Чтобы избежать экстернализиции Vue установите флаг `--inline-vue` для команды `build`.
:::

Вы можете запустить сборку одной точки входа в качестве веб-компонента с помощью:
Expand Down
2 changes: 1 addition & 1 deletion docs/ru/guide/cli-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ npx vue-cli-service serve
--dest определить каталог сборки (по умолчанию: dist)
--modern собирать приложение для современных браузеров с авто-фоллбэком для старых
--target app | lib | wc | wc-async (по умолчанию: app)
--inline-vue отключить экстернализицию Vue для lib сборки
--inline-vue включить Vue в содержимое сборки библиотеки или веб-компонента
--name имя библиотеки или режим веб-компонента (по умолчанию: "name" в package.json или имя файла точки входа)
--no-clean не удалять каталог dist перед сборкой проекта
--report сгенерировать report.html для анализа содержимого сборки
Expand Down