<commit_before># Ykit [![CircleCI](https://circleci.com/gh/YMFE/ykit.svg?style=shield)](https://circleci.com/gh/YMFE/ykit)

It's a pain to set webpack configs for various apps. Using plugins, ykit offers reliable encapsulated configuration and help you manage it. You can set up an app easily and customize your project through ykit's flexable config options.

## Quick Start

1. `npm install ykit -g`
2. `mkdir ykit-app && cd ykit-app`
3. `ykit init`
4. `cd .. && ykit server`
5. Check out `localhost/ykit-app/index.html`

After setting up your project, there will be the config file called `ykit.js` in your project root directory：

```javascript
module.exports = {
    plugins: [],
    config: {
        export: ['./scripts/index.js', './styles/index.css'],
        modifyWebpackConfig: function modifyWebpackConfig(baseConfig) {
            // edit webpack configs
            return baseConfig;
        }
    },
    hooks: {},
    commands: []
};
```

## Config Options

- **plugins** - To configure plugins inside of a configuration file, use the plugins key, which contains a list of plugin names. Every plugin encapsulates respective webpack configs.
- **config** - Config object:
    - **exports** - Asset entries.
    - **modifyWebpackConfig** - Callback function for editing ykit's Webpack configs.

## Document

Visit [http://ued.qunar.com/ykit/][1] for more doc.

[1]: http://ued.qunar.com/ykit/index.html<commit_msg>docs: update readme<commit_after># Ykit [![CircleCI](https://circleci.com/gh/YMFE/ykit.svg?style=shield)](https://circleci.com/gh/YMFE/ykit)

It's a pain to set webpack configs for various apps. Using plugins, ykit offers reliable encapsulated configuration and help you manage it. You can set up an app easily and customize your project through ykit's flexable config options.

## Quick Start

1. `npm install ykit -g`
2. `mkdir ykit-app && cd ykit-app`
3. `ykit init`
4. `cd .. && ykit server`
5. Check out `localhost/ykit-app/index.html`

After setting up your project, there will be the config file called `ykit.js` in your project root directory：

```javascript
module.exports = {
    plugins: [],
    config: {
        export: ['./scripts/index.js', './styles/index.css'],
        modifyWebpackConfig: function modifyWebpackConfig(baseConfig) {
            // edit webpack configs
            return baseConfig;
        }
    },
    hooks: {},
    commands: []
};
```

## Config Options

- **plugins** - To configure plugins inside of a configuration file, use the plugins key, which contains a list of plugin names. Every plugin encapsulates respective webpack configs.
- **config** - Config object:
    - **exports** - Asset entries.
    - **modifyWebpackConfig** - Callback function for editing ykit's webpack configs.

## Document

Visit [http://ued.qunar.com/ykit/][1] for more doc.

[1]: http://ued.qunar.com/ykit/index.html
{'fraction_non_alphanumeric': 0.12665736217725052, 'fraction_numerical': 0.004884856943475227, 'mean_word_length': 3.3505311077389983, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1929846', 'n_tokens_mistral': 893, 'n_tokens_neox': 866, 'n_words': 299}