@textstat/kernel
TypeScript icon, indicating that this package has built-in type declarations

0.8.0 • Public • Published

@textstat/textstat

textstat kernel.

This kernel module is same position with @textlint/kernel.

Install

Install with npm:

npm install @textstat/kernel

Usage

const kernel = new TextstatKernel();
const result = await kernel.report(`# Header

This is example.
`, {
    rules: [{
        ruleId: "textstat-rule-example",
        rule: rule
    }],
    plugins: [{
        pluginId: "markdown",
        plugin: require("@textlint/textlint-plugin-markdown")
    }],
    filterRules: [],
    sharedDeps: {
        filePathList: ["/path/to/example.md", "/path/to/example.a.md"]
    },
    filePath: "/path/to/example.md",
    ext: ".md"
});

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

Readme

Keywords

Package Sidebar

Install

npm i @textstat/kernel

Weekly Downloads

111

Version

0.8.0

License

MIT

Unpacked Size

20.8 kB

Total Files

20

Last publish

Collaborators

  • azu