Merge pull request #41 from jpap/banner-option

Banner support for generated type definitions

Author: timse

README.md

@@ -65,6 +65,13 @@ e.g.:
   { test: /\.css$/, loader: 'typings-for-css-modules?silent' }
 ```
 
+### `banner`-option
+To add a "banner" prefix to each generated `*.d.ts` file, you can pass a string to this option as shown below. The prefix is quite literally prefixed into the generated file, so please ensure it conforms to the type definition syntax.
+
+```js
+  { test: /\.css$/, loader: 'typings-for-css-modules?banner="// This file is automatically generated by typings-for-css-modules.\n// Please do not change this file!"' }
+```
+
 ## Usage
 
 Keep your `webpack.config` as is just instead of using `css-loader` use `typings-for-css-modules-loader`

src/index.js

@@ -63,6 +63,10 @@ ${skippedDefinitions.map(sd => ` - "${sd}"`).join('\n').red}
       }
       cssModuleDefinition = generateNamedExports(cleanedDefinitions);
     }
+    if (query.banner) {
+      // Prefix banner to CSS module
+      cssModuleDefinition = query.banner + '\n' + cssModuleDefinition;
+    }
     persist.writeToFileIfChanged(cssModuleInterfaceFilename, cssModuleDefinition);
     // mock async step 3 - make `async` return the actual callback again before calling the 'real' css-loader
     delegateToCssLoader(this, input, callback);