Nutritious Pumpkin Meal

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

    12.2.1 • Public • Published

    @textlint/kernel

    textlint kernel is core logic by pure JavaScript.

    This module is a low layer of textlint.

    No plugin, No rule, No filter rule by default.

    Install

    Install with npm:

    npm install @textlint/kernel
    

    Usage

    import { TextlintKernel } from "@textlint/kernel";
    const kernel = new TextlintKernel();
    const options = {
        filePath: "/path/to/file.md",
        ext: ".md",
        plugins: [
            {
                pluginId: "markdown",
                plugin: require("@textlint/textlint-plugin-markdown")
            }
        ],
        rules: [
            {
                ruleId: "no-todo",
                rule: require("textlint-rule-no-todo").default
            }
        ]
    };
    kernel.lintText("TODO: text", options).then(result => {
        assert.ok(typeof result.filePath === "string");
        assert.ok(result.messages.length === 1);
    });

    Notes: Preset is a collection of Rules. Currently, presets option does not exist.

    Type Interface

    @textlint/kernel export core types of textlint.

    If you use TypeScript, this types help you.

    // Types
    import {
        TextlintResult,
        TextlintFixResult,
        TextlintFixCommand,
        TextlintMessage,
        // Kernel rule/filter/plugin format
        TextlintKernelRule,
        TextlintKernelFilterRule,
        TextlintKernelPlugin,
        // textlint rule interface
        TextlintRuleCreator,
        TextlintRuleOptions,
        // textlint filter rule interface
        TextlintFilterRuleCreator,
        TextlintFilterRuleOptions,
        // textlint plugin interface
        TextlintPluginCreator,
        TextlintPluginOptions,
        TextlintPluginProcessor,
        TextlintPluginProcessorConstructor
    } from "@textlint/kernel";

    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

    Keywords

    Install

    npm i @textlint/kernel

    DownloadsWeekly Downloads

    26,910

    Version

    12.2.1

    License

    MIT

    Unpacked Size

    565 kB

    Total Files

    306

    Last publish

    Collaborators

    • azu
    • 0x6b