textlint

The pluggable natural language linter for text and markdown.

MIT License

Downloads
7.4M
Stars
2.8K
Committers
83
View Code on GitHub Visit Website
Ecosystems: JavaScript, Markdown

Bot releases are visible (Hide)

textlint - v14.2.1

Published by github-actions[bot] 15 days ago

What's Changed

Documentation

Refactoring

Dependency Updates

Other Changes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v14.2.0...v14.2.1

textlint - v14.2.0 Latest Release

Published by github-actions[bot] 2 months ago

What's Changed

Features

This release will reduce audit warning.

Full Changelog: https://github.com/textlint/textlint/compare/v14.1.0...v14.2.0

textlint - v14.1.0

Published by github-actions[bot] 2 months ago

What's Changed

Features

Change Details

linter.scanFilePath API Usage

If you want to know the file path is lintable or not, please use scanFilePath API.

import { createLinter, loadTextlintrc } from "textlint";
const textlintrcDescriptor = await loadTextlintrc();
const linter = createLinter({
    descriptor: textlintrcDescriptor
});
const result = await linter.scanFilePath("README.md");
// result.status is "ok" or "ignored" or "error"
if (result.status === "ok") {
    const lintResult = await linter.lintText("README content", "README.md");
    console.log(lintResult);
}

linter.scanFilePath is for combinating with lintText API because lintText API does not ignore any file.

Dependency Updates

Other Changes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.5...v14.1.0

textlint - v14.0.5

Published by github-actions[bot] 2 months ago

What's Changed

Documentation

Refactoring

Dependency Updates

Other Changes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.4...v14.0.5

textlint - v14.0.4

Published by github-actions[bot] 7 months ago

What's Changed

Bug Fixes

Dependency Updates

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.3...v14.0.4

textlint - v14.0.3

Published by github-actions[bot] 8 months ago

What's Changed

Bug Fixes

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.2...v14.0.3

textlint - v14.0.2

Published by github-actions[bot] 8 months ago

What's Changed

Bug Fixes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.1...v14.0.2

textlint - v14.0.1

Published by github-actions[bot] 9 months ago

What's Changed

Bug Fixes

Full Changelog: https://github.com/textlint/textlint/compare/v14.0.0...v14.0.1

textlint - v14.0.0

Published by github-actions[bot] 9 months ago

What's Changed

We published a blog as a release note.
For more information, please read the following article.

Breaking Changes

Features

Refactoring

CI

Dependency Updates

Other Changes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v13.4.1...v14.0.0

textlint - v13.4.1

Published by github-actions[bot] 11 months ago

What's Changed

Bug Fixes

This PR fixed types of textlint.
It does not change the behavior of textlint.

For plugin developer:

You may be necessary to change the type that returns preProcess as follows

-            preProcess(_text: string, _filePath: string): TxtNode {
+            preProcess(_text: string, _filePath: string): TxtDocumentNode {

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.4.0...13.4.1

textlint - v13.4.0

Published by github-actions[bot] 12 months ago

SUMMARY

textlint-scripts allow a rule to use native import().
It will help the rule to import ESM modules from CJS.

For example, alex is pure ESM package.
CJS package can not load via require("alex"), but it can load await import("alex")

What's Changed

Features

Documentation

Refactoring

Testing

Maintenance

Dependency Updates

Other Changes

New Contributors

Full Changelog: https://github.com/textlint/textlint/compare/v13.3.3...13.4.0

textlint - v13.3.3

Published by github-actions[bot] over 1 year ago

What's Changed

Refactoring

It reduces dependencies.

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.3.2...13.3.3

textlint - v13.3.2

Published by github-actions[bot] over 1 year ago

What's Changed

Bug Fixes

Documentation

Refactoring

Dependency Updates

Other Changes

Full Changelog: https://github.com/textlint/textlint/compare/v13.3.1...13.3.2

textlint - v13.3.1

Published by github-actions[bot] over 1 year ago

What's Changed

Bug Fixes

Documentation

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.3.0...13.3.1

textlint - v13.3.0

Published by github-actions[bot] over 1 year ago

What's Changed

Features

Dependency Updates

Other Changes

Full Changelog: https://github.com/textlint/textlint/compare/v13.2.0...13.3.0

textlint - v13.2.0

Published by github-actions[bot] over 1 year ago

What's Changed

Features

import TextLintTester from "textlint-tester";
import rule from "textlint-rule-no-todo";
const tester = new TextLintTester();
tester.run("rule name", rule, {
    valid: [
        { text: "This is ok", description: "It is normal text" }
    ],
    invalid: [
        {
            text: "- [ ] string",
            description: "It todo test",
            errors: [
                {
                    message: "Found TODO: '- [ ] string'",
                    range: [2, 6]
                }
            ]
        }
    ]
});

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.1.4...13.2.0

textlint - v13.1.4

Published by github-actions[bot] over 1 year ago

What's Changed

Bug Fixes

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.1.3...13.1.4

textlint - v13.1.3

Published by github-actions[bot] over 1 year ago

What's Changed

Bug Fixes

Full Changelog: https://github.com/textlint/textlint/compare/v13.1.2...13.1.3

textlint - v13.1.2

Published by github-actions[bot] over 1 year ago

What's Changed

Refactoring

Testing

Dependency Updates

Full Changelog: https://github.com/textlint/textlint/compare/v13.1.1...13.1.2

textlint - v13.1.1

Published by github-actions[bot] over 1 year ago

What's Changed

Bug Fixes

Refactoring

Full Changelog: https://github.com/textlint/textlint/compare/v13.1.0...13.1.1

Package Rankings
Top 0.96% on Npmjs.org
Badges
Extracted from project README
GitHub Actions Build Status textlint rule npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm
Related Projects
markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.

15 Mar 2015 4,509
markdown

Lint JavaScript code blocks in Markdown documents

01 Jul 2015 392
stylelint

A mighty CSS linter that helps you avoid errors and enforce conventions.

04 Dec 2014 11,000
remark-lint

plugins to check (lint) markdown code style

05 May 2015 942
textmarked

Enable Markdown editing in HTML <textarea />

03 Mar 2024 0