broccoli-lint-remark

Broccoli wrapper for remark-lint.

Information

Installation

npm install --save-dev broccoli-lint-remark

API

• inputNode A Broccoli node

• options {Object}: Options to control how broccoli-markdown-test is run.

  • remark {Object}: Any option available for remark and unified-engine.

    Default:

    {
      "name": "remark",
      "pluginPrefix": "remark",
      "presetPrefix": "remark-preset",
      "packageField": "remarkConfig",
      "rcName": ".remarkrc",
      "ignoreName": ".remarkignore",
      "quiet": true,
      "color": true,
      "output": false,
      "detectConfig": true
    }

  • testGenerator (Accepts two different types of input)

    • String: The framework used to test the markdown. You can provide a string one of the predefined test generators is used. Currently supported are qunit and mocha.
    • {function(relativePath, results), returns test output string}: The function used to generate test modules. You can provide a custom function for your client side testing framework of choice.
      • relativePath {String}: The relative path to the file being tested.
      • asserts {Array}: List of assertions made from codeTransforms.

    Default: null.

    Example usage with a String:

    return  new MarkdownTest(inputNode, {
      testGenerator: 'qunit'
    });

    Example usage with a Function:

    return new MarkdownTest(inputNode, {
      testGenerator(relativePath, results) {
        // Do something to generate the test
      }
    });

  • persist {Boolean}: Persist the state of filter output across restarts

    Default: true.

Contribute

If you want to contribute to this addon, please read the CONTRIBUTING.md.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details