Merge pull request #59 from css-modules/beta

Beta

Author: mightyaleksey

.babelrc

@@ -0,0 +1,5 @@
+{
+  "presets": [
+    "es2015"
+  ]
+}

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# cheat sheet: http://EditorConfig.org

.eslintignore

@@ -28,6 +28,3 @@ node_modules/*
 
 # added automatically by precommit-hook as defaults
 .jshint*
-
-dist/
-!node_modules/awesome-theme

.eslintrc

@@ -1,10 +1,7 @@
-# Generated by dmn (https://github.com/inikulin/dmn)
-
-.git*
+.babelrc
+.editorconfig
+.gitignore
 .npmignore
 .travis.yml
-generate-tests.js
-src/
-test/
-utils/
-webpack.config.js
+coverage
+demo

.gitignore

@@ -1,4 +1,3 @@
 language: node_js
 node_js:
-  - "4.1"
-  - "0.12"
+  - "4.3"

.npmignore

@@ -14,13 +14,7 @@ Compiling in runtime, [universal](https://medium.com/@mjackson/universal-javascr
 
 ## Requirements
 
-To use this tool we require [Node.js v0.12.x](https://github.com/nodejs/node) (or higher) and several modules to be installed.
-
-- [postcss](https://github.com/postcss/postcss) version 5 or higher
-- [postcss-modules-values](https://github.com/css-modules/postcss-modules-values)
-- [postcss-modules-extract-imports](https://github.com/css-modules/postcss-modules-extract-imports)
-- [postcss-modules-local-by-default](https://github.com/css-modules/postcss-modules-local-by-default)
-- [postcss-modules-scope](https://github.com/css-modules/postcss-modules-scope)
+To use this tool we require [Node.js v0.12.x](https://github.com/nodejs/node) (or higher).
 
 ## Installation
 
@@ -30,28 +24,45 @@ $ npm i css-modules-require-hook
 
 ## Usage
 
-In this section I've tried to cover the common cases of usage.
+Now, there are two ways to attach hook: manually or using preset file.
 
-### Development mode
+The first one allows you to pass options manually after module was required. Example:
 
-Usually, Node.js caches all the `require` calls by default. In order to invalidate cache for the purpose of development you should set the environment variable `NODE_ENV` to `development`. For example:
+```javascript
+const hook = require('css-modules-require-hook');
 
-```bash
-$ NODE_ENV=development node server.js
-```
+hook({
+  generateScopedName: '[name]__[local]___[hash:base64:5]',
+});
 
-Still you can use `devMode` option (see below) to override behavior which is imposed by environment variable.
+// const styles = require('./icon.css');
+```
 
-### Basic example
+The second one allows you to move options to the separate file `cmrh.conf.js`. Config file should be located in the same directory where executor is or in its ancestor directories. In that case hook will be attached right after the `css-modules-require-hook/preset` module will be required. Example:
 
-Basically to attach the require hook you need to require this module. If you need to adjust it see the tuning section below.
+```javascript
+// cmrh.conf.js
+module.exports = {
+  generateScopedName: '[name]__[local]___[hash:base64:5]',
+};
+```
 
 ```javascript
-require('css-modules-require-hook');
+require('css-modules-require-hook/preset');
 
-// var styles = require('./icon.css');
+// const styles = require('./icon.css');
 ```
 
+### Development mode
+
+Usually, Node.js caches all the `require` calls by default. In order to invalidate cache for the purpose of development you should set the environment variable `NODE_ENV` to `development`. For example:
+
+```bash
+$ NODE_ENV=development node server.js
+```
+
+Still you can use `devMode` option (see below) to override behavior which is imposed by environment variable.
+
 ### Adding custom PostCSS plugins
 
 ```javascript
@@ -166,6 +177,10 @@ hook({
 
 Attach the require hook to additional file extensions (for example `['.scss']`).
 
+### `ignore` function|regex|string
+
+Provides possibility to exclude particular files from processing. Supports glob and regular expressions syntax. Also you may provide custom function.
+
 ### `rootDir` string
 
 Provides absolute path to the project directory. Providing this will result in better generated class names. It can be obligatory, if you run require hook and build tools (like [css-modulesify](https://github.com/css-modules/css-modulesify)) from different working directories.
@@ -213,6 +228,7 @@ Short alias for the [postcss-modules-local-by-default](https://github.com/css-mo
 
 [debug](https://www.npmjs.com/package/debug) package is used for debugging. So to turn it on simply specify the **DEBUG** environment variable:
 - `DEBUG=css-modules:fetch` — to see resolved paths to the files.
+- `DEBUG=css-modules:preset` — to see whether config was found or not.
 - `DEBUG=css-modules:setup` — to see the new options list.
 - `DEBUG=css-modules:*` — to see everything.
 

.travis.yml

@@ -0,0 +1,7 @@
+{
+  "presets": [
+    "es2015",
+    "react",
+    "stage-0"
+  ]
+}