@hishprorg/molestias-consequuntur
Advanced tools
The pluggable linting tool for text and markdown.
textlint is similar to ESLint, but it's for use with natural language.
Visit https://textlint.github.io/.
npm install textlint-rule-xxx.For a quick tour of textlint, checkout our Getting Started guide :squirrel:
You can install the textlint command using npm:
$ npm install textlint --save-dev
Requirements:
If you're not sure what version of Node you're running, you can run node -v in your console to find out.
:warning: Warning:
textlint globally you must install each reference rule globally as well.textlint locally you must install each rule locally as well.We recommend installing textlint locally.
If you've never used Node.js and npm, please see the following:
textlint has no default rules!!
You can run textlint with .textlintrc.json config file.
# Install textlint and rules into local directory
npm install --save-dev textlint textlint-rule-no-todo
npx textlint --init command create .textlintrc.json file from installed rules.
npx textlint --init
.textlintrc.json will be created like this:
{
"rules": {
"no-todo": true
}
}
Lint files via textlint:
npx textlint ./README.md
textlint load .textlintrc.json from current directory and lint README.md.
Run npx textlint -h for information on how to use the CLI.
$ textlint [options] file.md [file|dir|glob*]
Options:
-h, --help Show help.
-c, --config path::String Use configuration from this file or sharable config.
--ignore-path path::String Specify path to a file containing patterns that describes files to ignore. - default: .textlintignore
--init Create the config file if not existed. - default: false
--fix Automatically fix problems
--dry-run Enable dry-run mode for --fix. Only show result, don't change the file.
--debug Outputs debugging information
--print-config Print the config object to stdout
-v, --version Outputs the version number.
Using stdin:
--stdin Lint text provided on <STDIN>. - default: false
--stdin-filename String Specify filename to process STDIN as
Output:
-o, --output-file path::String Enable report to be written to a file.
-f, --format String Use a specific output format.
Available formatter : checkstyle, compact, jslint-xml, json, junit, pretty-error, stylish, table, tap, unix
Available formatter for --fix: compats, diff, fixed-result, json, stylish - default: stylish
--no-color Disable color in piped output.
--quiet Report errors only. - default: false
Specifying rules and plugins:
--no-textlintrc Disable .textlintrc
--plugin [String] Set plugin package name
--rule [String] Set rule package name
--preset [String] Set preset package name and load rules from preset package.
--rulesdir [path::String] Use additional rules from this directory
Caching:
--cache Only check changed files - default: false
--cache-location path::String Path to the cache file or directory - default: .textlintcache
Experimental:
--experimental Enable experimental flag.Some feature use on experimental.
--rules-base-directory path::String Set module base directory. textlint load modules(rules/presets/plugins) from the base directory.
When running textlint, you can target files to lint using the glob patterns. Make sure that you enclose any glob parameter you pass in quotes.
$ npx textlint "docs/**"
For more details, see CLI documentation.
Example:
.textlintrc is config file that is loaded as JSON, YAML or JS via azu/rc-config-loader.
Running textlint with the following arguments
$ npx textlint --rule no-todo --rule very-nice-rule README.md
is equivalent to running textlint README.md in a directory with a .textlintrc.json containing the following json
{
"rules": {
"no-todo": true,
"very-nice-rule": true
}
}
You can also configure options for specific rules in your .textlintrc.json file.
{
"rules": {
"no-todo": false, // disable
"very-nice-rule": {
"key": "value"
}
}
}
For example here we pass the options ("key": "value") to very-nice-rule.
Options can be specified in your .textlintrc.json file as follows:
{
// Allow to comment in JSON
"rules": {
"<rule-name>": true | false | object
}
}
:information_source: for more details see
A textlint plugin is a set of rules and rulesConfig or customize parser.
To enable plugin, put the "plugin-name" into .textlintrc.json.
// `.textlintrc.json`
{
"plugins": [
"plugin-name"
],
// overwrite-plugins rules config
// <plugin>/<rule>
"rules": {
"plugin-name/rule-name" : false
}
}
:information_source: See docs/plugin.md
textlint supports Markdown and plain text by default.
Install Processor Plugin and add new file format support.
For example, if you want to lint HTML, use textlint-plugin-html as a plugin.
npm install textlint-plugin-html --save-dev
Add "html" to .textlintrc.json
{
"plugins": [
"html"
]
}
Run textlint on .html files:
textlint index.html
Optional supported file types:
See Processor Plugin List for details.
textlint has not built-in rules, but there are 100+ pluggable rules:
See A Collection of textlint rule · hishprorg/molestias-consequuntur Wiki for more details.
If you create a new rule, and add it to the wiki :)
Some rules are fixable using the --fix command line flag.
$ npx textlint --fix README.md
# As a possible, textlint fix the content.
Also, support dry run mode.
$ npx textlint --fix --dry-run --format diff README.md
# show the difference between fixed content and original content.
You can copy and paste to your README.
[](https://textlint.github.io/)
Use the following formatters:
e.g. use pretty-error formatter:
$ npx textlint -f pretty-error file.md
More details in @textlint/linter-formatter.
You can use textlint as node module.
$ npm install textlint --save-dev
Minimal usage:
import { createLinter, loadTextlintrc, loadLinterFormatter } from "textlint";
const descriptor = await loadTextlintrc();
const linter = createLinter({ descriptor });
const results = await linter.lintFiles(["*.md"]);
// textlint has two types formatter sets for linter and fixer
const formatter = await loadLinterFormatter({ formatterName: "stylish" });
const output = formatter.format(results);
console.log(output);
More details info, please read the following documents:
@textlint/kernel is a low level API for textlint. It is useful for the browser or non-Node.js environments.
import { TextlintKernel } from "@textlint/kernel";
const kernel = new TextlintKernel();
const options = {
filePath: "/path/to/file.md",
ext: ".md",
plugins: [
{
pluginId: "markdown",
plugin: require("@hishprorg/molestias-consequuntur-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);
});
textlint has four extensible points:
Please see docs/
no-todo rule.<!-- textlint-disable -->?You can use filter rule like textlint-filter-rule-comments.
Please see Ignoring Text · textlint for more details.
For more details, see integrations document.
This repository is a monorepo that we manage using Lerna. That means that we actually publish several packages to npm from the same codebase, including:
These modules are parts of textlint.
| Package | Version | Description |
|---|---|---|
textlint |  | textlint command line tool itself |
@textlint/kernel |  | textlint main logic module. It is universal JavaScript. |
@textlint/linter-formatter |  | textlint output formatter |
@textlint/fixer-formatter |  | textlint output formatter for fixer |
@hishprorg/molestias-consequuntur-plugin-markdown |  | markdown support for textlint |
@hishprorg/molestias-consequuntur-plugin-text |  | plain text support for textlint |
@hishprorg/molestias-consequuntur |  | Compliance tests for textlint's AST |
@textlint/markdown-to-ast |  | markdown parser |
@textlint/ast-traverse |  | TxtNode traverse library |
@textlint/text-to-ast |  | plain text parser |
@textlint/config-loader |  | Load .textlintrc config file |
These modules are useful for textlint rule/plugin author.
| Package | Version | Description |
|---|---|---|
@textlint/ast-node-types |  | textlint AST(Abstract Syntax Tree) type definition |
textlint-tester |  | textlint rule testing tools |
textlint-scripts |  | textlint rule npm run-scripts |
create-textlint-rule |  | create textlint rule with no build configuration |
These modules are useful integration with textlint.
| Package | Version | Description |
|---|---|---|
gulp-textlint |  | gulp plugin for textlint |
These modules are internal usage in the monorepo.
| Package | Version | Description |
|---|---|---|
@textlint/feature-flag |  | feature flag manager |
textlint project follow Semantic Versioning. However, textlint is not different with most semver project.
.d.ts)For bugs and feature requests, please create an issue.
Pull requests is always welcome.
For more details, see Contributing Guide.
MIT © azu
Copy some code from ESLint.
ESLint
Copyright (c) 2013 Nicholas C. Zakas. All rights reserved.
https://github.com/eslint/eslint/blob/master/LICENSE
Download from textlint/media.
Thanks to ESLint.
textlint website is powered by Netlify.
FAQs
Unknown package
We found that @hishprorg/molestias-consequuntur demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.