chore: plugins should list @vue/cli-service in peerDependencies (#4365)

haoqunjiang · web-flow · commit fc3e0a30b5ac · 2019-07-29T10:45:12.000+08:00
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,8 @@`
`26`	`26`	`"@vue/cli-shared-utils": "^4.0.0-beta.1",`
`27`	`27`	`"cypress": "^3.3.1",`
`28`	`28`	`"eslint-plugin-cypress": "^2.2.1"`
	`29`	`+ },`
	`30`	`+ "peerDependencies": {`
	`31`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0"`
`29`	`32`	`}`
`30`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`"chromedriver": "^74.0.0"`
`34`	`34`	`},`
`35`	`35`	`"peerDependencies": {`
	`36`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0",`
`36`	`37`	`"chromedriver": "*"`
`37`	`38`	`}`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`"yorkie": "^2.0.0"`
`31`	`31`	`},`
`32`	`32`	`"peerDependencies": {`
	`33`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0",`
`33`	`34`	`"eslint": ">= 1.6.0"`
`34`	`35`	`}`
`35`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,5 +29,8 @@`
`29`	`29`	`},`
`30`	`30`	`"devDependencies": {`
`31`	`31`	`"register-service-worker": "^1.6.2"`
	`32`	`+ },`
	`33`	`+ "peerDependencies": {`
	`34`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0"`
`32`	`35`	`}`
`33`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,8 @@`
`27`	`27`	`},`
`28`	`28`	`"devDependencies": {`
`29`	`29`	`"@vue/cli-test-utils": "^4.0.0-beta.1"`
	`30`	`+ },`
	`31`	`+ "peerDependencies": {`
	`32`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0"`
`30`	`33`	`}`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,8 @@`
`37`	`37`	`"devDependencies": {`
`38`	`38`	`"@vue/test-utils": "1.0.0-beta.29",`
`39`	`39`	`"ts-jest": "^24.0.2"`
	`40`	`+ },`
	`41`	`+ "peerDependencies": {`
	`42`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0"`
`40`	`43`	`}`
`41`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,8 @@`
`24`	`24`	`},`
`25`	`25`	`"devDependencies": {`
`26`	`26`	`"@vue/cli-test-utils": "^4.0.0-beta.1"`
	`27`	`+ },`
	`28`	`+ "peerDependencies": {`
	`29`	`+ "@vue/cli-service": "^3.0.0 \|\| ^4.0.0-0"`
`27`	`30`	`}`
`28`	`31`	`}`