https://github.com/textlint-rule/textlint-rule-pattern
A textlint rule that checks by RegExp patterns.
https://github.com/textlint-rule/textlint-rule-pattern
dictionary regexp textlint textlint-rule
Last synced: 10 days ago
JSON representation
A textlint rule that checks by RegExp patterns.
- Host: GitHub
- URL: https://github.com/textlint-rule/textlint-rule-pattern
- Owner: textlint-rule
- License: mit
- Created: 2022-05-18T01:00:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T01:28:23.000Z (over 2 years ago)
- Last Synced: 2025-03-29T20:44:13.141Z (3 months ago)
- Topics: dictionary, regexp, textlint, textlint-rule
- Language: TypeScript
- Homepage:
- Size: 118 KB
- Stars: 7
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @textlint-rule/textlint-rule-pattern
A textlint rule that checks by RegExp patterns.
## Features
- Support User Defined Patterns
- Support RegExp patterns
- Support Replacement texts
## Install
Install with [npm](https://www.npmjs.com/):
npm install @textlint-rule/textlint-rule-pattern
## Usage
Via `.textlintrc`(Recommended)
```json
{
"rules": {
"@textlint-rule/pattern": {
"patterns": [
{
"message": "No todo",
"pattern": "/TODO:/i"
},
{
"message": "Must to use YYYY-MM-DD instead of YYYY/MM/DD",
"pattern": "/(\\d{4})/(\\d{2})/(\\d{2})/i",
"replace": "$1-$2-$3",
"allows": ["/1000/01/01/"],
"allowNodeTypes": ["BlockQuote"]
}
]
}
}
}
```
## Options
- **patterns**: an array of pattern object
```json5
{
"rules": {
"@textlint-rule/pattern": {
"patterns": [
/* Your rules is here! */
]
}
}
}
```
### Pattern
The pattern object has the following properties.
```ts
export type Pattern = {
/**
* This error message will be shown when match the pattern
*/
message: string;
/**
* Match pattern string.
* You can use RegExp-like string.
* https://github.com/textlint/regexp-string-matcher#regexp-like-string
*/
pattern: string;
/**
* Replace string
* You can use capture pattern like $1, $2. ($0 will be ignored)
*/
replace?: string;
/**
* An array of excludes pattern.
* If the text is matched this pattern, suppress the error.
* You can use RegExp-like string
* https://github.com/textlint/regexp-string-matcher#regexp-like-string
*/
allows?: string[];
/**
* An array for excludes node type.
* If the text is in the node type, suppress the error.
* https://github.com/textlint/textlint/blob/master/docs/txtnode.md#type
* For example, if you want to ignore the text in block quote and link
* "allowNodeTypes": ["Link", "BlockQuote"]
*/
allowNodeTypes?: string[];
/**
* This rule ignore Code and CodeBlock by default.
* If you want to check the code, please put this true
*/
forceCode?: boolean;
};
```
### RegExp-like String
This textlint rule use RegExp-like string for option value.
:memo: `g`(global) flag and `u`(unicode) is added by default.
| Input | Ouput | Note |
|--------------|---------|----------------------------------------------------|
| `"str"` | `/str/gu` | convert string to regexp with global |
| `"/str/"` | `/str/gu` | |
| `"/str/g"` | `/str/gu` | Duplicated `g` is just ignored |
| `"/str/i"` | `/str/igu` | |
| `"/str/u"` | `/str/ug` | |
| `"/str/m"` | `/str/mgu` | |
| `"/str/y"` | `/str/ygu` | |
| --- | --- | --- |
| `"/\\d+/"` | `/\d+/gu` | You should escape meta character like `\d` |
| `"/(\\d+)/"` | `/\d+/gu` | You can use capture. replace `$1` with the capture |
For more information, please see [textlint/regexp-string-matcher README](https://github.com/textlint/regexp-string-matcher#regexp-like-string).
### Examples
### Match by RegExp
If you want to found `TODO:` text, you can write following:
```json
{
"rules": {
"@textlint-rule/pattern": {
"patterns": [
{
"message": "No todo",
"pattern": "/TODO:/i"
}
]
}
}
}
```
### Replace the match
If you want to replace `YYYY/DD/MM` to `YYYY-DD-MM` format, you can write following:
e.g. `2000/01/01` will be `2000-01-01` by `textlint --fix`.
:memo: replace mark is starts with `$1`.
```json
{
"rules": {
"@textlint-rule/pattern": {
"patterns": [
{
"message": "Must to use YYYY-MM-DD instead of YYYY/MM/DD",
"pattern": "/(\\d{4})/(\\d{2})/(\\d{2})/i",
"replace": "$1-$2-$3"
}
]
}
}
}
```
### Check code texts
If you want to check text in a CodeBlock, you need to enable `forceCode` flag.
```json
{
"rules": {
"@textlint-rule/pattern": {
"patterns": [
{
"message": "No todo in code",
"pattern": "/TODO \\[Issue #\\d+\\]:/i",
"forceCode": true
}
]
}
}
}
```
## Changelog
See [Releases page](https://github.com/textlint-rule/textlint-rule-pattern/releases).
## Related
- [textlint-rule-prh](https://github.com/textlint-rule/textlint-rule-prh)
- textlint rule for [proofreading-helper](https://github.com/prh/prh)
- [@textlint-ja/textlint-rule-morpheme-match](https://github.com/textlint-ja/textlint-rule-morpheme-match)
- textlint rule based on tokenized text(It is for japanesse)
## 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](https://github.com/textlint-rule/textlint-rule-pattern/issues).
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
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu