Commit 03fe610

authored

Merge pull request #78 from pascalduez/features/hashprefix-option

Add generic-names `hashPrefix` option

2 parents 22624ed + d2469ca commit 03fe610Copy full SHA for 03fe610

File tree

+48

-2

lines changed

+48

-2

lines changed

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ Provides the full list of PostCSS plugins to the pipeline. Providing this cancel`
`203`	`203`
`204`	`204`	Short alias for the [postcss-modules-extract-imports](https://github.com/css-modules/postcss-modules-extract-imports) plugin's `createImportedName` option.
`205`	`205`
`206`		-### `generateScopedName` function
	`206`	+### `generateScopedName` string\|function
`207`	`207`
`208`	`208`	`Short alias for the [postcss-modules-scope](https://github.com/css-modules/postcss-modules-scope) plugin's option. Helps you to specify the custom way to build generic names for the class selectors.`
`209`	`209`	`You may also use a string pattern similar to the webpack's [css-loader](https://github.com/webpack/css-loader#local-scope).`
`@@ -230,6 +230,11 @@ hook({`
`230`	`230`	`});`
`231`	`231`	```
`232`	`232`
	`233`	+### `hashPrefix` string
	`234`	`+`
	`235`	`+Short alias for the [generic-names](https://github.com/css-modules/generic-names) helper option.`
	`236`	`+Provides additional hash uniqueness. Might be useful for projects with several stylesheets sharing a same name.`
	`237`	`+`
`233`	`238`	### `mode` string
`234`	`239`
`235`	`240`	`Short alias for the [postcss-modules-local-by-default](https://github.com/css-modules/postcss-modules-local-by-default) plugin's option.`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ module.exports = function setupHook({`
`34`	`34`	`prepend = [],`
`35`	`35`	`createImportedName,`
`36`	`36`	`generateScopedName,`
	`37`	`+ hashPrefix,`
`37`	`38`	`mode,`
`38`	`39`	`use,`
`39`	`40`	`rootDir: context = process.cwd(),`
`@@ -51,7 +52,7 @@ module.exports = function setupHook({`
`51`	`52`	`let scopedName;`
`52`	`53`	`if (generateScopedName) {`
`53`	`54`	`scopedName = typeof generateScopedName !== 'function'`
`54`		`- ? genericNames(generateScopedName, {context}) // for example '[name]__[local]___[hash:base64:5]'`
	`55`	`+ ? genericNames(generateScopedName, {context, hashPrefix}) // for example '[name]__[local]___[hash:base64:5]'`
`55`	`56`	`: generateScopedName;`
`56`	`57`	`} else {`
`57`	`58`	`// small fallback`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ const rules = {`
`17`	`17`	`use: 'array',`
`18`	`18`	`createImportedName: 'function',`
`19`	`19`	`generateScopedName: 'function\|string',`
	`20`	`+ hashPrefix: 'string',`
`20`	`21`	`mode: 'string',`
`21`	`22`	`rootDir: 'string',`
`22`	`23`	`};`

Lines changed: 39 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,39 @@`
	`1`	`+const detachHook = require('../sugar').detachHook;`
	`2`	`+const dropCache = require('../sugar').dropCache;`
	`3`	`+`
	`4`	`+suite('api/hashPrefix', () => {`
	`5`	`+ let samples = [];`
	`6`	`+`
	`7`	`+ suite('using string pattern and hashPrefix', () => {`
	`8`	`+ let tokens;`
	`9`	`+`
	`10`	`+ test('should return tokens with prefixed id', () => assert.deepEqual(tokens, {`
	`11`	`+ color: 'oceanic__color___3xlBZ',`
	`12`	`+ }));`
	`13`	`+`
	`14`	`+ setup(() => {`
	`15`	`+ hook({generateScopedName: '[name]__[local]___[hash:base64:5]', hashPrefix: 'test'});`
	`16`	`+ tokens = require('./fixture/oceanic.css');`
	`17`	`+ samples.push(tokens);`
	`18`	`+ });`
	`19`	`+ });`
	`20`	`+`
	`21`	`+ suite('using string pattern', () => {`
	`22`	`+ let tokens;`
	`23`	`+`
	`24`	`+ test('should return tokens with different hashes', () => assert.notDeepEqual(`
	`25`	`+ samples`
	`26`	`+ ));`
	`27`	`+`
	`28`	`+ setup(() => {`
	`29`	`+ hook({generateScopedName: '[name]__[local]___[hash:base64:5]'});`
	`30`	`+ tokens = require('./fixture/oceanic.css');`
	`31`	`+ samples.push(tokens);`
	`32`	`+ });`
	`33`	`+ });`
	`34`	`+`
	`35`	`+ teardown(() => {`
	`36`	`+ detachHook('.css');`
	`37`	`+ dropCache('./api/fixture/oceanic.css');`
	`38`	`+ });`
	`39`	`+});`

Comments

(0)