https://github.com/tyler36/textlint-demo
https://github.com/tyler36/textlint-demo
github-workflow gitlab-pipeline linting textlint
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tyler36/textlint-demo
- Owner: tyler36
- Created: 2024-05-31T08:18:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-27T01:40:23.000Z (6 months ago)
- Last Synced: 2025-11-29T19:44:14.295Z (6 months ago)
- Topics: github-workflow, gitlab-pipeline, linting, textlint
- Language: HTML
- Homepage:
- Size: 438 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Textlint
- [Overview](#overview)
- [Usage](#usage)
- [Configuration](#configuration)
- [Rules](#rules)
- [@textlint-rule/textlint-rule-no-unmatched-pair](#textlint-ruletextlint-rule-no-unmatched-pair)
- [Textlint-rule-alive-link](#textlint-rule-alive-link)
- [Textlint-rule-common-misspellings](#textlint-rule-common-misspellings)
- [Textlint-rule-en-capitalization](#textlint-rule-en-capitalization)
- [Textlint-rule-date-weekday-mismatch](#textlint-rule-date-weekday-mismatch)
- [Textlint-rule-doubled-spaces](#textlint-rule-doubled-spaces)
- [Textlint-rule-no-todo](#textlint-rule-no-todo)
- [Textlint-rule-stop-words](#textlint-rule-stop-words)
- [Textlint-rule-terminology](#textlint-rule-terminology)
- [Textlint-rule-unexpanded-acronym](#textlint-rule-unexpanded-acronym)
- [Textlint-rule-write-good](#textlint-rule-write-good)
- [Addons](#addons)
- [Filters](#filters)
- [Textlint-filter-rule-comments](#textlint-filter-rule-comments)
- [Plugins](#plugins)
- [Textlint-plugin-HTML](#textlint-plugin-html)
- [Visual Studio Code](#vscode)
## Overview
[Textlint](https://github.com/textlint/textlint) is a plug-able linting tool for text and Markdown.
Supports: `.txt`, `.md`
Required:
- Node.js 16+
Homepage:
Online playground:
## Usage
- To install:
```shell
npm install --save-dev textlint
```
When installed global, also install addons globally.
## Configuration
Valid configuration files are:
- `.textlintrc`
- `.textlintrc.json`
- `.textlintrc.yaml`
- `.textlintrc.js`
To create a configuration file:
```shell
npx textlint --init
```
```jsonc
{
// .textlintrc.json
"plugins": {},
"filters": {},
"rules": {}
}
```
## Rules
No defaults rules.
- [Global](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule#rules-global)
- [日本語](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule#rules-japanese)
Preset:
- [textlint-rule-preset-japanese](https://github.com/textlint-ja/textlint-rule-preset-japanese)
### @textlint-rule/textlint-rule-no-unmatched-pair
Textlint rule that check unmatched pairs like `（` and `]`.
```txt
❌ これは（秘密)です。
❌ John said "Hello World!'.
```
-
### Textlint-rule-alive-link
Textlint rule to make sure every link in a document is available.
```txt
❌ https://www.goooogle.com
```
-
### Textlint-rule-common-misspellings
Textlint rule to find common misspellings from Wikipedia: Lists of common misspellings.
```txt
❌ unsuccesful
✅ unsuccessful
```
-
### Textlint-rule-en-capitalization
Textlint rule that check capitalization in english text.
```txt
❌ text should be capitalized in sentences.
✅ Text should be capitalized in sentences.
```
-
### Textlint-rule-date-weekday-mismatch
Textlint rule that found mismatch between date and weekday.
```txt
❌ 2016-12-29(Friday)
✅ 2016-12-29(Thursday)
❌ 2016年12月29日(金曜日)
✅ 2016年12月29日(木曜日)
```
-
### Textlint-rule-doubled-spaces
Textlint rule for check doubled spaces in sentence.
```txt
❌ Pen Pineapple Apple Pen
✅ Pen Pineapple Apple Pen
```
-
### Textlint-rule-no-todo
This textlint rule check todo mark.
```txt
❌ TODO: this is TODO
❌ - [ ] TODO
```
-
### Textlint-rule-stop-words
Textlint rule to find filler words, buzzwords and clichés — 1600+ words and phrases in English.
```txt
❌ You can not use allowlist anymore.
```
-
### Textlint-rule-terminology
Textlint rule to check and fix terms, brands and technologies spelling in your tech writing in English.
```txt
❌ Javascript
✅ JavaScript
❌ front-end
✅ frontend
```
-
### Textlint-rule-unexpanded-acronym
Textlint rule that found Unexpanded Acronym.
```txt
❌ I like ABC.
(What does ABC stand for ???)
```
-
### Textlint-rule-write-good
Textlint rule to check your English writing styles with btford/write-good.
@see
```txt
❌ This is very good. // weasel word.
```
-
## Addons
### Filters
#### Textlint-filter-rule-comments
Textlint rule that ignore error using comments directive.
```txt
This is ignored text by rule.
Disables all rules between comments
```
-
### Plugins
#### Textlint-plugin-HTML
Add HTML support for textlint.
-
### Visual Studio Code
- Homepage: [taichi.vscode-textlint](https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint)
```json
"[markdown]": {
"editor.defaultFormatter": "taichi.vscode-textlint"
},
"textlint.nodePath": "./node_modules/.bin",
"textlint.configPath": "./.textlintrc",
"textlint.autoFixOnSave": true,
```