Skip to content
This repository was archived by the owner on Oct 30, 2020. It is now read-only.

Add 'noSemicolons' option #31

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ e.g.:
{ test: /\.css$/, loader: 'typings-for-css-modules?silent' }
```

### `noSemicolons`-option
Prevents outputted lines from having semicolons at the end. This is useful when you want to enforce no semicolons with a linter. The default is to add semicolons.

## Usage

Keep your `webpack.config` as is just instead of using `css-loader` use `typings-for-css-modules-loader`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "typings-for-css-modules-loader",
"version": "1.5.0",
"version": "1.6.0",
"description": "Drop-in replacement for css-loader to generate typings for your CSS-Modules on the fly in webpack",
"main": "lib/index.js",
"scripts": {
Expand Down
18 changes: 9 additions & 9 deletions src/cssModuleToInterface.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ const filenameToInterfaceName = (filename) => {
.replace(/\W+(\w)/g, (_, c) => c.toUpperCase());
};

const cssModuleToTypescriptInterfaceProperties = (cssModuleKeys, indent = ' ') => {
const cssModuleToTypescriptInterfaceProperties = (cssModuleKeys, indent = ' ', useSemicolons = true) => {
return cssModuleKeys
.map((key) => `${indent}'${key}': string;`)
.map((key) => `${indent}'${key}': string${useSemicolons ? ';' : ''}`)
.join('\n');
};

const cssModuleToNamedExports = (cssModuleKeys) => {
const cssModuleToNamedExports = (cssModuleKeys, useSemicolons) => {
return cssModuleKeys
.map((key) => `export const ${key}: string;`)
.map((key) => `export const ${key}: string${useSemicolons ? ';' : ''}`)
.join('\n');
};

Expand All @@ -34,20 +34,20 @@ export const filenameToTypingsFilename = (filename) => {
return path.join(dirName, `${baseName}.d.ts`);
};

export const generateNamedExports = (cssModuleKeys) => {
const namedExports = cssModuleToNamedExports(cssModuleKeys);
export const generateNamedExports = (cssModuleKeys, useSemicolons = true) => {
const namedExports = cssModuleToNamedExports(cssModuleKeys, useSemicolons);
return (`${namedExports}
`);
};

export const generateGenericExportInterface = (cssModuleKeys, filename, indent) => {
export const generateGenericExportInterface = (cssModuleKeys, filename, indent, useSemicolons = true) => {
const interfaceName = filenameToInterfaceName(filename);
const interfaceProperties = cssModuleToTypescriptInterfaceProperties(cssModuleKeys, indent);
const interfaceProperties = cssModuleToTypescriptInterfaceProperties(cssModuleKeys, indent, useSemicolons);
return (
`export interface ${interfaceName} {
${interfaceProperties}
}

export const locals: ${interfaceName};
export const locals: ${interfaceName}${useSemicolons ? ';' : ''}
`);
};
9 changes: 6 additions & 3 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ module.exports = function(input) {
return delegateToCssLoader(this, input, callback);
}

// default to using semiColons
query.noSemicolons = query.noSemicolons? true : false;

// mock async step 2 - offer css loader a "fake" callback
this.async = () => (err, content) => {
if (err) {
Expand All @@ -44,15 +47,15 @@ module.exports = function(input) {
let match;
const cssModuleKeys = [];

while (match = keyRegex.exec(content)) {
while ((match = keyRegex.exec(content))) {
if (cssModuleKeys.indexOf(match[1]) < 0) {
cssModuleKeys.push(match[1]);
}
}

let cssModuleDefinition;
if (!query.namedExport) {
cssModuleDefinition = generateGenericExportInterface(cssModuleKeys, filename);
cssModuleDefinition = generateGenericExportInterface(cssModuleKeys, filename, ' ', query.noSemicolons);
} else {
const [cleanedDefinitions, skippedDefinitions,] = filterNonWordClasses(cssModuleKeys);
if (skippedDefinitions.length > 0 && !query.camelCase) {
Expand All @@ -61,7 +64,7 @@ The following classes will not be available as named exports:
${skippedDefinitions.map(sd => ` - "${sd}"`).join('\n').red}
`.yellow);
}
cssModuleDefinition = generateNamedExports(cleanedDefinitions);
cssModuleDefinition = generateNamedExports(cleanedDefinitions, query.noSemicolons);
}
persist.writeToFileIfChanged(cssModuleInterfaceFilename, cssModuleDefinition);
// mock async step 3 - make `async` return the actual callback again before calling the 'real' css-loader
Expand Down
20 changes: 10 additions & 10 deletions test/webpack.config.babel.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ module.exports = {
entry: './test/entry.ts',
output: {
path: __dirname,
filename: 'bundle.js'
filename: 'bundle.js',
},
module: {
loaders: [
{ test: /\.ts$/, loaders: ['babel', 'ts'] },
{ test: /example\.css$/, loader: '../src/index.js?modules' },
{ test: /example-camelcase\.css$/, loader: '../src/index.js?modules&camelCase' },
{ test: /example-namedexport\.css$/, loader: '../src/index.js?modules&namedExport' },
{ test: /example-camelcase-namedexport\.css$/, loader: '../src/index.js?modules&camelCase&namedExport' },
{ test: /example-no-css-modules\.css$/, loader: '../src/index.js' },
{ test: /example-compose\.css$/, loader: '../src/index.js?modules&camelCase&namedExport' }
]
}
{ test: /\.ts$/, loaders: ['babel', 'ts',], },
{ test: /example\.css$/, loader: '../src/index.js?modules', },
{ test: /example-camelcase\.css$/, loader: '../src/index.js?modules&camelCase', },
{ test: /example-namedexport\.css$/, loader: '../src/index.js?modules&namedExport', },
{ test: /example-camelcase-namedexport\.css$/, loader: '../src/index.js?modules&camelCase&namedExport', },
{ test: /example-no-css-modules\.css$/, loader: '../src/index.js', },
{ test: /example-compose\.css$/, loader: '../src/index.js?modules&camelCase&namedExport', },
],
},
};