textlint/regexp-string-matcherPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star8

Regexp-like string("/github/i") matcher library.

License

MIT license

8 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 37 Commits
.githooks		.githooks
.github/workflows		.github/workflows
src		src
test		test
.gitignore		.gitignore
.mocharc.json		.mocharc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

@textlint/regexp-string-matcher

Regexp-like string matcher library.

Install

Install withnpm:

npm install @textlint/regexp-string-matcher

Usage

Interface:

exportinterfacematchPatternResult{match:string;startIndex:number;endIndex:number;}/** * Match regExpLikeStrings and return matchPatternResults *@param text target text *@param regExpLikeStrings an array of pattern string */exportdeclareconstmatchPatterns:(text:string,regExpLikeStrings:string[])=>matchPatternResult[];

Example:

import{matchPatterns}from"@textlint/regexp-string-matcher";constinputText=`GitHub is a web-based hosting service for version control using git.It is mostly used for computer code.GitHub launched in 2018-04-10.`;// RegExp like stringsconstinputPatterns=["git",// => /git/g"/github/i",// => /github/ig"/(\\d{4})-(\\d{2})-(\\d{2})/"// => /\d{4}-\d{2}-\d{2}/g];constresults=matchPatterns(inputText,inputPatterns);assert.deepStrictEqual(results,[{match:"GitHub",startIndex:1,endIndex:7,captures:[]},{match:"git",startIndex:65,endIndex:68,captures:[]},{match:"GitHub",startIndex:107,endIndex:113,captures:[]},{match:"2018-04-10",startIndex:126,endIndex:136,captures:["2018","04","10"]}]);

RegExp-like String

This library aim to represent RegExp in JSON and use it for ignoring words.g(global) flag andu(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

⚠️ You should escape meta character like\d in RegExp-like string.

For example, If you want to write\w(any word) in RegExp-like string, you should escape\w to\\w.

Regular Expressions - JavaScript | MDN

Text:

This is a pen.

RegExp-like String:

["/a (\\w+)/"]

Results:

[ { match: 'a pen', startIndex: 8, endIndex: 13, captures: ["pen"] } ]

Examples

string

text:

GitHub is a web-based hosting service for version control using git.It is mostly used for computer code.GitHub launched in 2018-04-10.

pattern:

["GitHub"]

results: 2 hits

**GitHub** is a web-based hosting service for version control using git.It is mostly used for computer code.**GitHub** launched in 2018-04-10.

Ignore Case match

text:

GitHub is a web-based hosting service for version control using git.It is mostly used for computer code.GitHub launched in 2018-04-10.

pattern:

["/git/i"]

results:: 3 hits

**Git**Hub is a web-based hosting service for version control using**git**.It is mostly used for computer code.**Git**Hub launched in 2018-04-10.

Special character

You should escape special charactor like\d in RegExp-like string.

text:

GitHub is a web-based hosting service for version control using git.It is mostly used for computer code.GitHub launched in 2018-04-10.

pattern:

["/\\d{4}-\\d{2}-\\d{2}/"]

results:: 1 hit

GitHub is a web-based hosting service for version control using git.It is mostly used for computer code.GitHub launched in**2018-04-10**.

Multi-line

text:

===START===1st inline text.===END======START===2nd inline text.===END===

pattern:

["/===START===[\\s\\S]*?===END===/m"]

results:: 2 hits

**===START===1st inline text.===END===****===START===2nd inline text.===END===**

For more details, seetest/snapshots

Escape bracket

text:

TODO[Issue#1]: it will be fixed

patterns:

["/TODO\\[Issue #\\d+\\]:/i"]

📝 You should escape bracket both.\\[ and\\],

results:

**TODO [Issue #1]:** it will be fixed

Changelog

SeeReleases page.

Running tests

Install devDependencies and Runnpm test:

npm i -d && npm test

How to add snapshot tests?

Create new dir to./snapshots/<name>/
Addinput.txt andinput-patterns.json
Runnpm run test:updateSnapshot
You should verify the output results manually
Runnpm test and pass it
Commit it

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests,please create an issue.

Fork it!
Create your feature branch:git checkout -b my-new-feature
Commit your changes:git commit -am 'Add some feature'
Push to the branch:git push origin my-new-feature
Submit a pull request :D

Author

License

MIT © azu

About

Regexp-like string("/github/i") matcher library.

Releases7

v2.0.2 Latest

Jun 28, 2022

+ 6 releases

Sponsor this project

Learn more about GitHub Sponsors

Packages

No packages published

Movatterモバイル変換

Uh oh!

License

textlint/regexp-string-matcher

Folders and files

Latest commit

History

Repository files navigation

@textlint/regexp-string-matcher

Install

Usage

RegExp-like String

Examples

string

Ignore Case match

Special character

Multi-line

Escape bracket

Changelog

Running tests

How to add snapshot tests?

Contributing

Author

License

About

Topics

Resources

License

Security policy

Uh oh!

Stars

Watchers

Forks

Releases7

Sponsor this project

Uh oh!

Packages0

Uh oh!

Contributors2

Uh oh!

Languages

Packages