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.

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

Jump to bottom

feat(cli-service): Add CSS Module localIdentName to vue config #915

Merged
merged 1 commit into from
Mar 1, 2018
Merged

feat(cli-service): Add CSS Module localIdentName to vue config #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ As for standalone style files, any files ending with `.module.(css|sass|scss|les

If you wish to be able to use CSS modules without the `.module` postfix, you can set `css: { modules: true }` in `vue.config.js`. This option does not affect `*.vue` files.

If you wish to customize the CSS modules class name output you can set the `css: { localIdentName: [name]__[local]--[hash:base64:5]}` in `vue.config.js`.

### Pre-Processors

You can select pre-processors (Sass/Less/Stylus) when creating the project. If you did not do so, you can also just manually install the corresponding webpack loaders. The loaders are pre-configured and will automatically be picked up. For example, to add Sass to an existing project, simply run:
Expand Down
15 changes: 15 additions & 0 deletions packages/@vue/cli-service/__tests__/css.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,21 @@ test('css.sourceMap', () => {
})
})

test('css.localIdentName', () => {
const localIdentName = '[name]__[local]--[hash:base64:5]'
const config = genConfig({
vue: {
css: {
modules: true,
localIdentName: localIdentName
}
}
})
LANGS.forEach(lang => {
expect(findOptions(config, lang, 'css').localIdentName).toBe(localIdentName)
})
})

test('css.loaderOptions', () => {
const data = '$env: production;'
const config = genConfig({
Expand Down
5 changes: 3 additions & 2 deletions packages/@vue/cli-service/lib/config/css.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ module.exports = (api, options) => {
extract: true,
modules: false,
sourceMap: false,
loaderOptions: {}
loaderOptions: {},
localIdentName: '[name]_[local]__[hash:base64:5]'
}
const userOptions = Object.assign(defaultOptions, options.css || {})
const extract = isProd && userOptions.extract !== false
Expand Down Expand Up @@ -52,7 +53,7 @@ module.exports = (api, options) => {
options.loaders = Object.assign(resolver.vue(), options.loaders)
options.cssSourceMap = !!userOptions.cssSourceMap
options.cssModules = Object.assign({
localIdentName: '[name]_[local]__[hash:base64:5]'
localIdentName: baseOptions.localIdentName
}, options.cssModules)
return options
})
Expand Down
2 changes: 2 additions & 0 deletions packages/@vue/cli-service/lib/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const schema = createSchema(joi => joi.object({
css: joi.object({
modules: joi.boolean(),
extract: joi.boolean(),
localIdentName: joi.string(),
sourceMap: joi.boolean(),
loaderOptions: joi.object({
sass: joi.object(),
Expand Down Expand Up @@ -77,6 +78,7 @@ exports.defaults = () => ({
css: {
// extract: true,
// modules: false,
// localIdentName: '[name]_[local]_[hash:base64:5]',
// sourceMap: false,
// loaderOptions: {}
},
Expand Down
5 changes: 4 additions & 1 deletion packages/@vue/cli-service/lib/webpack/CSSLoaderResolver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ module.exports = class CSSLoaderResolver {
* @param {Object} options
* @param {boolean} [options.sourceMap=undefined] Enable sourcemaps.
* @param {boolean} [options.modules=undefined] Enable CSS modules.
* @param {string} [options.localIdentName='[name]_[local]__[hash:base64:5]'] Customizes CSS modules localIdentName.
* @param {boolean} [options.extract=undefined] Extract CSS.
* @param {boolean} [options.minimize=undefined] Minimize CSS.
* @param {boolean} [options.postcss=undefined] Enable postcss-loader.
Expand All @@ -21,6 +22,7 @@ module.exports = class CSSLoaderResolver {
constructor ({
sourceMap,
modules,
localIdentName,
extract,
minimize,
postcss,
Expand All @@ -32,6 +34,7 @@ module.exports = class CSSLoaderResolver {
this.extract = extract && !process.env.VUE_CLI_CSS_SHADOW_MODE
this.minimize = minimize
this.modules = modules
this.localIdentName = localIdentName
this.postcss = postcss
this.loaderOptions = loaderOptions || {}
}
Expand All @@ -45,7 +48,7 @@ module.exports = class CSSLoaderResolver {
if (this.modules) {
cssLoaderOptions.modules = true
cssLoaderOptions.importLoaders = 1
cssLoaderOptions.localIdentName = '[name]_[local]__[hash:base64:5]'
cssLoaderOptions.localIdentName = this.localIdentName
}

if (loader === 'css') {
Expand Down