Have ideas to improve npm?Join in the discussion! ¬Ľ

    create-textlint-rule-example

    1.1.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    create-textlint-rule-example Build Status

    Create textlint rule example from test codes(textlint-tester).

    Install

    Install with npm:

    npm install create-textlint-rule-example
    

    Usage

    CLI

    A argument is the test file for textlint that use textlint-tester.

    $ create-textlint-rule-example path/to/rule-test.js
    # OR
    $ cat path/to/rule-test.js | create-textlint-rule-example

    Example Output:

    **OK**:
    
    ```
    text
    TODOS:
    [TODO: this is todo](http://example.com)
    ![TODO: this is todo](http://example.com/img)
    > TODO: this is todo
    ```
    
    **NG**:
    
    ```
    TODO: this is TODO
    TODO: this is TODO
                
    - [ ] TODO
    TODO: A TODO: B
    THIS IS TODO:
    ```
    

    Changelog

    See Releases page.

    Running tests

    Install devDependencies and Run npm test:

    npm i -d && npm test
    

    Contributing

    Pull requests and stars are always welcome.

    For bugs and feature requests, please create an issue.

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    Author

    License

    MIT © azu

    Install

    npm i create-textlint-rule-example

    DownloadsWeekly Downloads

    2

    Version

    1.1.0

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar