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: generate vue.config.js with defineConfig wrapper #6817

Merged
merged 4 commits into from Nov 5, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/@vue/cli/__tests__/Generator.spec.js
Expand Up @@ -1012,7 +1012,9 @@ test('api: addConfigTransform transform vue warn', async () => {
extractConfigFiles: true
})

expect(fs.readFileSync('/vue.config.js', 'utf-8')).toMatch(`module.exports = {\n lintOnSave: 'default'\n}`)
expect(fs.readFileSync('/vue.config.js', 'utf-8')).toMatch(
`const { defineConfig } = require('@vue/cli-service')\nmodule.exports = defineConfig({\n lintOnSave: 'default'\n})\n`
)
expect(logs.warn.some(([msg]) => {
return msg.match(/Reserved config transform 'vue'/)
})).toBe(true)
Expand Down Expand Up @@ -1103,7 +1105,9 @@ test('extract config files', async () => {
})

const js = v => `module.exports = ${stringifyJS(v, null, 2)}`
expect(fs.readFileSync('/vue.config.js', 'utf-8')).toMatch(js(configs.vue))
expect(fs.readFileSync('/vue.config.js', 'utf-8')).toMatch(
`const { defineConfig } = require('@vue/cli-service')\nmodule.exports = defineConfig(${stringifyJS(configs.vue, null, 2)})`
)
expect(fs.readFileSync('/babel.config.js', 'utf-8')).toMatch(js(configs.babel))
expect(fs.readFileSync('/postcss.config.js', 'utf-8')).toMatch(js(configs.postcss))
expect(fs.readFileSync('/.eslintrc.js', 'utf-8')).toMatch(js(configs.eslintConfig))
Expand Down
26 changes: 26 additions & 0 deletions packages/@vue/cli/lib/util/__tests__/extendJSConfig.spec.js
Expand Up @@ -28,6 +28,32 @@ test(`basic`, () => {
)
})

test(`defineConfig`, () => {
const value = {
foo: true,
css: {
modules: true
}
}
const source =
`const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
foo: false,
css: {
modules: false
}
})`
expect(extend(value, source)).toMatch(
`const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
foo: true,
css: {
modules: true
}
})`
)
})

test(`adding new property`, () => {
const value = {
foo: true
Expand Down
7 changes: 6 additions & 1 deletion packages/@vue/cli/lib/util/configTransforms.js
Expand Up @@ -18,7 +18,7 @@ const transformJS = {
return null
}
},
write: ({ value, existing, source }) => {
write: ({ value, existing, source, filename }) => {
if (existing) {
// We merge only the modified keys
const changedData = {}
Expand All @@ -34,6 +34,11 @@ const transformJS = {
}
})
return extendJSConfig(changedData, source)
} else if (filename === 'vue.config.js') {
return (
`const { defineConfig } = require('@vue/cli-service')\n` +
`module.exports = defineConfig(${stringifyJS(value, null, 2)})`
)
} else {
return `module.exports = ${stringifyJS(value, null, 2)}`
}
Expand Down
18 changes: 14 additions & 4 deletions packages/@vue/cli/lib/util/extendJSConfig.js
Expand Up @@ -14,14 +14,24 @@ module.exports = function extendJSConfig (value, source) {
node.left.object.name === 'module' &&
node.left.property.name === 'exports'
) {
if (node.right.type === 'ObjectExpression') {
augmentExports(node.right)
} else if (node.right.type === 'Identifier') {
let theExports = node.right
if (
theExports.type === 'CallExpression' &&
theExports.callee.type === 'Identifier' &&
theExports.callee.name === 'defineConfig'
) {
theExports = theExports.arguments[0]
}

if (theExports.type === 'ObjectExpression') {
augmentExports(theExports)
} else if (theExports.type === 'Identifier') {
// do a second pass
exportsIdentifier = node.right.name
exportsIdentifier = theExports.name
}
return false
}

this.traverse(path)
}
})
Expand Down