Merge pull request #17 from Jimdo/allow-to-silence-logger

Allow to silence logger

Author: timse

README.md

@@ -57,6 +57,14 @@ export const barBaz: string;
 
  `css-loader` exports mappings to `exports.locals` which is incompatible with the `namedExport`-option unless paired with `extract-text-webpack-plugin` or `style-loader`. They move the exported properties from `exports.locals` to `exports` making them reuired for `namedExport` to work, and `namedExport` required for them to work. *Always combine usage of `extract-text-webpack-plugin` or `style-loader` with the `namedExport`-option.*
 
+### `silent`-option
+To silence the loader because you get annoyed by its warnings or for other reasons, you can simply pass the "silent" query to the loader and it will shut up.
+e.g.:
+
+```js
+  { test: /\.css$/, loader: 'typings-for-css-modules?silent' }
+```
+
 ## Usage
 
 Keep your `webpack.config` as is just instead of using `css-loader` use `typings-for-css-modules-loader`

package.json

@@ -8,8 +8,9 @@
     "prepublish": "npm run build",
     "pretest": "rm -f ./test/example*.css.d.ts",
     "test:diff": "(cd test; set -e; for f in example*css.d.ts; do diff $f expected-$f; done;)",
-    "test:run": "babel-node ./node_modules/webpack/bin/webpack --config ./test/webpack.config.babel.js && npm run test:diff",
-    "test": "npm run test:run > /dev/null 2>&1 && npm run test:run"
+    "test:run": "babel-node ./node_modules/webpack/bin/webpack --config ./test/webpack.config.babel.js",
+    "test:run-twice" : "npm run test:run > /dev/null 2>&1 && npm run test:run",
+    "test": "npm run test:run-twice && npm run test:diff"
   },
   "author": "Tim Sebastian <[email protected]>",
   "license": "MIT",

src/index.js

@@ -10,6 +10,7 @@ import {
   filenameToTypingsFilename,
 } from './cssModuleToInterface';
 import * as persist from './persist';
+import loggerCreator from './logger';
 
 function delegateToCssLoader(ctx, input, callback) {
   ctx.async = () => callback;
@@ -23,9 +24,11 @@ module.exports = function(input) {
   const callback = this.async();
 
   const query = loaderUtils.parseQuery(this.query);
+  const logger = loggerCreator(query.silent);
+
   const moduleMode = query.modules || query.module;
   if (!moduleMode) {
-    console.warn('Typings for CSS-Modules: option `modules` is not active - skipping extraction work...'.red);
+    logger('warn','Typings for CSS-Modules: option `modules` is not active - skipping extraction work...'.red);
     return delegateToCssLoader(this, input, callback);
   }
 
@@ -45,7 +48,7 @@ module.exports = function(input) {
     } else {
       const [cleanedDefinitions, skippedDefinitions,] = filterNonWordClasses(cssModuleKeys);
       if (skippedDefinitions.length > 0 && !query.camelCase) {
-        console.warn(`Typings for CSS-Modules: option 'namedExport' was set but 'camelCase' for the css-loader not.
+        logger('warn', `Typings for CSS-Modules: option 'namedExport' was set but 'camelCase' for the css-loader not.
 The following classes will not be available as named exports:
 ${skippedDefinitions.map(sd => ` - "${sd}"`).join('\n').red}
 `.yellow);

src/logger.js

@@ -0,0 +1,6 @@
+export default (silent) => {
+  if (silent) {
+    return () => {};
+  }
+  return (level, ...args) => console[level](...args);
+};

test/entry.ts

@@ -2,6 +2,7 @@ import {locals as stylesBase} from './example.css';
 import {locals as stylesCamelCase} from './example-camelcase.css';
 import * as stylesNamedExport from './example-namedexport.css';
 import * as stylesCamelCasedNamedExport from './example-camelcase-namedexport.css';
+import './example-no-css-modules.css';
 
 const foo = stylesBase.foo;
 const barBaz = stylesBase['bar-baz'];

test/example-no-css-modules.css

@@ -0,0 +1,7 @@
+.foo {
+  color: white;
+}
+
+.bar-baz {
+  color: green;
+}

test/webpack.config.babel.js

@@ -10,7 +10,8 @@ module.exports = {
       { 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-camelcase-namedexport.css$/, loader: '../src/index.js?modules&camelCase&namedExport' },
+      { test: /example-no-css-modules.css$/, loader: '../src/index.js' },
     ]
   }
 };