Skip to content

fix: fix css.loaderOptions.css.modules default values #4363

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 7 commits into from
Jul 29, 2019
Merged

fix: fix css.loaderOptions.css.modules default values #4363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
728612f
fix: load default `localIdentName` from `css.modules` option
haoqunjiang Jul 26, 2019
ded274f
chore: avoid variable shadowing
haoqunjiang Jul 27, 2019
61f4f18
fix: fix default value of loaderOptions.css.modules
haoqunjiang Jul 27, 2019
d35dd85
chore: remove unused references to localIdentName
haoqunjiang Jul 27, 2019
482506e
docs: update css modules documentations following the css-loader upgrade
haoqunjiang Jul 27, 2019
85b5a88
fix: rename `options` in outer scope to `rootOptions`, avoid shadowing
haoqunjiang Jul 27, 2019
7ccb717
fixup! fix: rename `options` in outer scope to `rootOptions`, avoid s…
haoqunjiang Jul 27, 2019
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
9 changes: 7 additions & 2 deletions docs/guide/css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,13 @@ module.exports = {
css: {
loaderOptions: {
css: {
localIdentName: '[name]-[hash]',
camelCase: 'only'
// Note: the following config format is different between Vue CLI v4 and v3
// For Vue CLI v3 users, please refer to css-loader v1 documentations
// https://github.com/webpack-contrib/css-loader/tree/v1.0.1
modules: {
localIdentName: '[name]-[hash]',
localsConvention: 'camelCaseOnly'
}
}
}
}
Expand Down
9 changes: 0 additions & 9 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 @@ -370,15 +370,6 @@ module.exports = class Service {
resolved.baseUrl = resolved.publicPath
removeSlash(resolved, 'outputDir')

// deprecation warning
// TODO remove in final release
if (resolved.css && resolved.css.localIdentName) {
warn(
`css.localIdentName has been deprecated. ` +
`All css-loader options (except "modules") are now supported via css.loaderOptions.css.`
)
}

// validate options
validate(resolved, msg => {
error(
Expand Down
32 changes: 14 additions & 18 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 @@ -9,7 +9,7 @@ const findExisting = (context, files) => {
}
}

module.exports = (api, options) => {
module.exports = (api, rootOptions) => {
api.chainWebpack(webpackConfig => {
const getAssetPath = require('../util/getAssetPath')
const shadowMode = !!process.env.VUE_CLI_CSS_SHADOW_MODE
Expand All @@ -22,16 +22,15 @@ module.exports = (api, options) => {
} catch (e) {}

const {
modules = false,
extract = isProd,
sourceMap = false,
loaderOptions = {}
} = options.css || {}
} = rootOptions.css || {}

const shouldExtract = extract !== false && !shadowMode
const filename = getAssetPath(
options,
`css/[name]${options.filenameHashing ? '.[contenthash:8]' : ''}.css`
rootOptions,
`css/[name]${rootOptions.filenameHashing ? '.[contenthash:8]' : ''}.css`
)
const extractOptions = Object.assign({
filename,
Expand Down Expand Up @@ -71,7 +70,7 @@ module.exports = (api, options) => {
cssDeclarationSorter: false
}]
}
if (options.productionSourceMap && sourceMap) {
if (rootOptions.productionSourceMap && sourceMap) {
cssnanoOptions.map = { inline: false }
}

Expand All @@ -92,9 +91,10 @@ module.exports = (api, options) => {

// rules for normal CSS imports
const normalRule = baseRule.oneOf('normal')
applyLoaders(normalRule, modules)
const treatAllAsModules = !!(rootOptions.css && rootOptions.css.modules)
applyLoaders(normalRule, treatAllAsModules)

function applyLoaders (rule, modules) {
function applyLoaders (rule, isCssModule) {
if (shouldExtract) {
rule
.use('extract-css-loader')
Expand Down Expand Up @@ -122,15 +122,11 @@ module.exports = (api, options) => {
)
}, loaderOptions.css)

if (modules) {
const {
localIdentName = '[name]_[local]_[hash:base64:5]'
} = loaderOptions.css || {}
Object.assign(cssLoaderOptions, {
modules: {
localIdentName
}
})
if (isCssModule) {
cssLoaderOptions.modules = {
localIdentName: '[name]_[local]_[hash:base64:5]',
...cssLoaderOptions.modules
}
}

rule
Expand Down Expand Up @@ -186,7 +182,7 @@ module.exports = (api, options) => {
webpackConfig
.plugin('optimize-css')
.use(require('@intervolga/optimize-cssnano-plugin'), [{
sourceMap: options.productionSourceMap && sourceMap,
sourceMap: rootOptions.productionSourceMap && sourceMap,
cssnanoOptions
}])
}
Expand Down
1 change: 0 additions & 1 deletion packages/@vue/cli-service/lib/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ exports.defaults = () => ({
css: {
// extract: true,
// modules: false,
// localIdentName: '[name]_[local]_[hash:base64:5]',
// sourceMap: false,
// loaderOptions: {}
},
Expand Down