Skip to content

feat: a defineConfig API from @vue/cli-service for better typing support in vue.config.js #6355

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 24, 2021
Merged

feat: a defineConfig API from @vue/cli-service for better typing support in vue.config.js #6355

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20fc721
feat: a `defineConfig` API from `@vue/cli-service` for better type su…
haoqunjiang Mar 15, 2021
e2cf7cd
chore: simplify the type annotation
haoqunjiang Mar 16, 2021
628c1ff
docs: mention `defineConfig` helper in the documentation
haoqunjiang Mar 17, 2021
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
11 changes: 11 additions & 0 deletions packages/@vue/cli-service/lib/Service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,3 +436,14 @@ function cloneRuleNames (to, from) {
}
})
}

/**
* @typedef {import('../types/index').ConfigFunction} ConfigFunction
* @typedef {import('../types/index').ProjectOptions} ProjectOptions
* @typedef {ProjectOptions|ConfigFunction} UserConfig
* @param {UserConfig} config
* @returns UserConfig
*/
module.exports.defineConfig = function defineConfig (config) {
return config
}
5 changes: 3 additions & 2 deletions packages/@vue/cli-service/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import ChainableConfig = require('webpack-chain')
import webpack = require('webpack')
import WebpackDevServer = require('webpack-dev-server')
import express = require('express') // @types/webpack-dev-server depends on @types/express
import { ProjectOptions } from './ProjectOptions'
import { ProjectOptions, ConfigFunction } from './ProjectOptions'

type RegisterCommandFn = (args: minimist.ParsedArgs, rawArgv: string[]) => any

Expand Down Expand Up @@ -134,4 +134,5 @@ type ServicePlugin = (
) => any

export { ProjectOptions, ServicePlugin, PluginAPI }
export { ConfigFunction } from './ProjectOptions'
type UserConfig = ProjectOptions | ConfigFunction
export function defineConfig(config: UserConfig): UserConfig