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

14.3.0 • Public • Published

@textlint/legacy-textlint-core

This package provides legacy TextLintCore compatible API.

[!WARNING] THIS PACKAGE IS DEPRECATED.

This compat package is deprecated. You should use @textlint/kernel or new APIs instead of it.

Install

Install with npm:

npm install @textlint/legacy-textlint-core

Usage

This package provided a procedural API.

import { TextLintCore } from "@textlint/legacy-textlint-core";
// example packages
import rule from "textlint-rule-example";
import plugin from "textlint-plugin-example";

const textlintCore = new TextLintCore();
textlintCore.setupRules({ "example-rule": rule });
textlintCore.setupPlugins({ "example-plugin": rule });
const results = await textlintCore.lintText("test", ".example");
textlintCore.resetRules(); // reset setup

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

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

Package Sidebar

Install

npm i @textlint/legacy-textlint-core

Weekly Downloads

40

Version

14.3.0

License

MIT

Unpacked Size

70.9 kB

Total Files

9

Last publish

Collaborators

  • textlint-user
  • azu
  • 0x6b