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

feat: add .version field and assertVersion helper to plugin api #3861

Merged
merged 1 commit into from
Apr 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
19 changes: 19 additions & 0 deletions docs/dev-guide/plugin-api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Plugin API

## version

Type: `string`

The version string for the `@vue/cli-service` version that is loading the plugin.


## assertVersion(range)

- **Arguments**
- `{integer | string} range` - a semver range that `@vue/cli-service` needs to satisfy

- **Usage**

While api.version can be useful in general, it's sometimes nice to just declare your version.
This API exposes a simple way to do that.

Nothing happens if the provided version is satified. Otherwise, an error will be thrown.

## getCwd

- **Usage**:
Expand Down
15 changes: 15 additions & 0 deletions packages/@vue/cli-service/__tests__/Service.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,21 @@ test('load project options from vue.config.js', () => {
expect(service.projectOptions.lintOnSave).toBe(false)
})

test('api: assertVersion', () => {
const plugin = {
id: 'test-assertVersion',
apply: api => {
expect(() => api.assertVersion(3)).not.toThrow()
expect(() => api.assertVersion('3')).not.toThrow()
expect(() => api.assertVersion('>= 3')).not.toThrow()

expect(() => api.assertVersion(3.1)).toThrow('Expected string or integer value')
expect(() => api.assertVersion('^100')).toThrow('Require @vue/cli-service "^100"')
}
}
createMockService([plugin], true /* init */)
})

test('api: registerCommand', () => {
let args
const service = createMockService([{
Expand Down
24 changes: 24 additions & 0 deletions packages/@vue/cli-service/lib/PluginAPI.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const path = require('path')
const hash = require('hash-sum')
const semver = require('semver')
const { matchesPluginId } = require('@vue/cli-shared-utils')

// Note: if a plugin-registered command needs to run in a specific default mode,
Expand All @@ -17,6 +18,29 @@ class PluginAPI {
this.service = service
}

get version () {
return require('../package.json').version
}

assertVersion (range) {
if (typeof range === 'number') {
console.log(range, Number.isInteger(range))
if (!Number.isInteger(range)) {
throw new Error('Expected string or integer value.')
}
range = `^${range}.0.0-0`
}
if (typeof range !== 'string') {
throw new Error('Expected string or integer value.')
}

if (semver.satisfies(this.version, range)) return

throw new Error(
`Require @vue/cli-service "${range}", but was loaded with "${this.version}".`
)
}

/**
* Current working directory.
*/
Expand Down