From fc3e0a30b5ac323fdeb407c2925c8c33f33cdae3 Mon Sep 17 00:00:00 2001 From: Haoqun Jiang Date: Mon, 29 Jul 2019 10:45:12 +0800 Subject: [PATCH] chore: plugins should list @vue/cli-service in peerDependencies (#4365) --- docs/dev-guide/generator-api.md | 2 ++ docs/dev-guide/plugin-api.md | 2 ++ packages/@vue/cli-plugin-babel/package.json | 3 +++ packages/@vue/cli-plugin-e2e-cypress/package.json | 3 +++ packages/@vue/cli-plugin-e2e-nightwatch/package.json | 1 + packages/@vue/cli-plugin-eslint/package.json | 1 + packages/@vue/cli-plugin-pwa/package.json | 3 +++ packages/@vue/cli-plugin-router/package.json | 3 +++ packages/@vue/cli-plugin-typescript/package.json | 1 + packages/@vue/cli-plugin-unit-jest/package.json | 3 +++ packages/@vue/cli-plugin-unit-mocha/package.json | 3 +++ packages/@vue/cli-plugin-vuex/package.json | 3 +++ 12 files changed, 28 insertions(+) diff --git a/docs/dev-guide/generator-api.md b/docs/dev-guide/generator-api.md index 4dfa51cc6..886cfb1d3 100644 --- a/docs/dev-guide/generator-api.md +++ b/docs/dev-guide/generator-api.md @@ -38,6 +38,8 @@ The version string for the **project local** `@vue/cli-service` version that is Nothing happens if the provided version is satisfied. Otherwise, an error will be thrown. + Note: It's recommended to use [the `peerDependencies` field in `package.json`](https://docs.npmjs.com/files/package.json#peerdependencies) under most circumstances. + ## resolve diff --git a/docs/dev-guide/plugin-api.md b/docs/dev-guide/plugin-api.md index 255925302..25ab93e2b 100644 --- a/docs/dev-guide/plugin-api.md +++ b/docs/dev-guide/plugin-api.md @@ -19,6 +19,8 @@ The version string for the `@vue/cli-service` version that is loading the plugin Nothing happens if the provided version is satisfied. Otherwise, an error will be thrown. + Note: It's recommended to use [the `peerDependencies` field in `package.json`](https://docs.npmjs.com/files/package.json#peerdependencies) under most circumstances. + ## getCwd - **Usage**: diff --git a/packages/@vue/cli-plugin-babel/package.json b/packages/@vue/cli-plugin-babel/package.json index 1a568b6ed..4522f7283 100644 --- a/packages/@vue/cli-plugin-babel/package.json +++ b/packages/@vue/cli-plugin-babel/package.json @@ -26,6 +26,9 @@ "babel-loader": "^8.0.6", "webpack": ">=4 < 4.29" }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" + }, "publishConfig": { "access": "public" } diff --git a/packages/@vue/cli-plugin-e2e-cypress/package.json b/packages/@vue/cli-plugin-e2e-cypress/package.json index 0b46de772..2eed22caa 100644 --- a/packages/@vue/cli-plugin-e2e-cypress/package.json +++ b/packages/@vue/cli-plugin-e2e-cypress/package.json @@ -26,5 +26,8 @@ "@vue/cli-shared-utils": "^4.0.0-beta.1", "cypress": "^3.3.1", "eslint-plugin-cypress": "^2.2.1" + }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" } } diff --git a/packages/@vue/cli-plugin-e2e-nightwatch/package.json b/packages/@vue/cli-plugin-e2e-nightwatch/package.json index 19c156b8e..ebf6674e0 100644 --- a/packages/@vue/cli-plugin-e2e-nightwatch/package.json +++ b/packages/@vue/cli-plugin-e2e-nightwatch/package.json @@ -33,6 +33,7 @@ "chromedriver": "^74.0.0" }, "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0", "chromedriver": "*" } } diff --git a/packages/@vue/cli-plugin-eslint/package.json b/packages/@vue/cli-plugin-eslint/package.json index bc403662f..bededeefb 100644 --- a/packages/@vue/cli-plugin-eslint/package.json +++ b/packages/@vue/cli-plugin-eslint/package.json @@ -30,6 +30,7 @@ "yorkie": "^2.0.0" }, "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0", "eslint": ">= 1.6.0" } } diff --git a/packages/@vue/cli-plugin-pwa/package.json b/packages/@vue/cli-plugin-pwa/package.json index cdcc7db9b..6d15b6353 100644 --- a/packages/@vue/cli-plugin-pwa/package.json +++ b/packages/@vue/cli-plugin-pwa/package.json @@ -29,5 +29,8 @@ }, "devDependencies": { "register-service-worker": "^1.6.2" + }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" } } diff --git a/packages/@vue/cli-plugin-router/package.json b/packages/@vue/cli-plugin-router/package.json index 45ff307ef..88e3613a5 100644 --- a/packages/@vue/cli-plugin-router/package.json +++ b/packages/@vue/cli-plugin-router/package.json @@ -27,5 +27,8 @@ }, "devDependencies": { "@vue/cli-test-utils": "^4.0.0-beta.1" + }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" } } diff --git a/packages/@vue/cli-plugin-typescript/package.json b/packages/@vue/cli-plugin-typescript/package.json index de6599544..c12b30ff8 100644 --- a/packages/@vue/cli-plugin-typescript/package.json +++ b/packages/@vue/cli-plugin-typescript/package.json @@ -33,6 +33,7 @@ "yorkie": "^2.0.0" }, "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0", "typescript": ">=2" }, "devDependencies": { diff --git a/packages/@vue/cli-plugin-unit-jest/package.json b/packages/@vue/cli-plugin-unit-jest/package.json index fa800b3a5..7feffef4f 100644 --- a/packages/@vue/cli-plugin-unit-jest/package.json +++ b/packages/@vue/cli-plugin-unit-jest/package.json @@ -37,5 +37,8 @@ "devDependencies": { "@vue/test-utils": "1.0.0-beta.29", "ts-jest": "^24.0.2" + }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" } } diff --git a/packages/@vue/cli-plugin-unit-mocha/package.json b/packages/@vue/cli-plugin-unit-mocha/package.json index f67bd60e1..6d4128411 100644 --- a/packages/@vue/cli-plugin-unit-mocha/package.json +++ b/packages/@vue/cli-plugin-unit-mocha/package.json @@ -32,6 +32,9 @@ "@vue/test-utils": "1.0.0-beta.29", "chai": "^4.1.2" }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" + }, "publishConfig": { "access": "public" } diff --git a/packages/@vue/cli-plugin-vuex/package.json b/packages/@vue/cli-plugin-vuex/package.json index 0910c5ce5..3c28fc303 100644 --- a/packages/@vue/cli-plugin-vuex/package.json +++ b/packages/@vue/cli-plugin-vuex/package.json @@ -24,5 +24,8 @@ }, "devDependencies": { "@vue/cli-test-utils": "^4.0.0-beta.1" + }, + "peerDependencies": { + "@vue/cli-service": "^3.0.0 || ^4.0.0-0" } }