Skip to content

feat(cli-service): support plugin to inject process-env before load config file #6159

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

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
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
20 changes: 20 additions & 0 deletions packages/@vue/cli-service/__tests__/Service.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,26 @@ test('api: defaultModes', () => {
}

createMockService([plugin2], false /* init */).run('test')

delete process.env.NODE_ENV
delete process.env.BABEL_ENV

const plugin3 = {
id: 'test-defaultModes',
apply: api => {
expect(process.env.NODE_ENV).toBe('test')
expect(process.env.BABEL_ENV).toBe('test')
expect(process.env.TEST_ENV).toBe('test-env')
api.registerCommand('bar', () => {})
}
}
plugin3.apply.defaultModes = {
bar: ['test', {
TEST_ENV: 'test-env'
}]
}

createMockService([plugin3], false /* init */).run('bar')
})

test('api: chainWebpack', () => {
Expand Down
15 changes: 14 additions & 1 deletion packages/@vue/cli-service/lib/Service.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const fs = require('fs')
const path = require('path')
const debug = require('debug')
const arrify = require('arrify')
const { merge } = require('webpack-merge')
const Config = require('webpack-chain')
const PluginAPI = require('./PluginAPI')
Expand Down Expand Up @@ -39,7 +40,19 @@ module.exports = class Service {
// this is provided by plugins as module.exports.defaultModes
// so we can get the information without actually applying the plugin.
this.modes = this.plugins.reduce((modes, { apply: { defaultModes } }) => {
return Object.assign(modes, defaultModes)
Object.keys(defaultModes || {}).forEach((cmd) => {
const [mode, extendEnv] = arrify(defaultModes[cmd])
Object.assign(modes, {
[cmd]: mode
})
// allow plugin to set addtional process.env
if (extendEnv) {
Object.keys(extendEnv).forEach((envKey) => {
process.env[envKey] = extendEnv[envKey]
})
}
})
return modes
}, {})
}

Expand Down
1 change: 1 addition & 0 deletions packages/@vue/cli-service/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"acorn": "^8.0.1",
"acorn-walk": "^8.0.0",
"address": "^1.1.2",
"arrify": "^2.0.1",
"autoprefixer": "^10.1.0",
"browserslist": "^4.16.0",
"cache-loader": "^4.1.0",
Expand Down