obj-gen-9/README.zh_CN.md

Generate objects based on generator and JSON

# obj-gen-9

![node version][node-image]
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![npm download][download-image]][download-url]

[node-image]: https://img.shields.io/badge/node-%3E%3D8-blue.svg
[npm-image]: https://img.shields.io/npm/v/obj-gen-9.svg?style=flat-square
[npm-url]: https://npmjs.org/package/obj-gen-9
[travis-image]: https://img.shields.io/travis/985ch/obj-gen-9.svg?style=flat-square
[travis-url]: https://travis-ci.org/985ch/obj-gen-9
[codecov-image]: https://img.shields.io/codecov/c/github/985ch/obj-gen-9.svg?style=flat-square
[codecov-url]: https://codecov.io/github/985ch/obj-gen-9?branch=master
[david-image]: https://img.shields.io/david/985ch/obj-gen-9.svg?style=flat-square
[david-url]: https://david-dm.org/985ch/obj-gen-9
[download-image]: https://img.shields.io/npm/dm/obj-gen-9.svg?style=flat-square
[download-url]: https://npmjs.org/package/obj-gen-9

这个模块允许你根据生成器和JSON来生成对象

## 安装

```bash
$ npm i obj-gen-9 --save
```

## 使用方法
```js
'use strict';

const generate = require('obj-gen-9');

const config = {
  $generator: text => {
    return function(name) {
      console.log(text + ' ' + name + '!');
    };
  },
  $members: [ 'hello', 'hi' ],
};

const greet = generate(config);

greet.hello('sachiko');
greet.hi('momoka');
```
```js
'use strict';

const generate = require('obj-gen-9');

const config = {
  project: {
    $generator: (obj, config) => {
      if (obj.cmd) {
        return function() {
          console.log(config.projectName);
          console.log('cd ' + this.path);
          console.log(obj.cmd);
        };
      }
      return obj.value;
    },
    $members: [
      {
        $key: 'run',
        cmd: 'node index.js',
      }, {
        $key: 'test',
        cmd: 'node test.js',
      }, {
        $key: 'path',
        value: './',
      },
    ],
    projectName: 'TestProject',
  },
};

const work = generate(config);

work.project.test();
work.project.run();
work.project.path = './obj-gen';
work.project.test();
```
在[test.js](./test.js)中可以看到更多用法

## 属性说明
| 属性 | 格式 | 描述 |
|:-----|:----|:-----|
| $generator | (member, config)=>{} | 对象成员生成器，在任意对象下只要有这个属性就会根据$members数组生成对象 |
| $keygen | (obj)=>{} | 对象属性键值获取函数，当member是对象时，根据member获取键值，默认是(obj)=>obj.$key |
| $members | Array | 数组中的每个对象都会作为member参数传给$generator | 
| $key | String | 在没有指定$keygen的时候，默认使用$key作为键值 |

## 测试

```sh
npm test
```

## License

[MIT](LICENSE)