Natural Language pattern matching library for JavaScript.
This library based on NLCST that is Natural Language Concrete Syntax Tree format.
You can write pattern match syntax using Part-of-speech(POS) tagging, Morphological Analysis(形態素解析).
This repository is monorepo. This repository includes following packages.
| Package | npm |
|---|---|
| nlcst-parse-english |  |
| nlcst-parse-japanese |  |
| nlcst-pattern-match |  |
| match-test-replace |  |
| nlcst-types |  |
| unist-types |  |
Support English and Japanese. In other words, We have the above language parser for NLCST.
If you want to add language, Welcome to Pull Request.
NLCST Parser and Pattern match.
You write Pattern of NLCST object in patternMatcher.tag${object}`.
nlcst-pattern-match aim to provide that match strict pattern.
For more details, See nlcst-pattern-match document.
import { PatternMatcher } from "nlcst-pattern-match";
import { EnglishParser } from "nlcst-parse-english";
const englishParser = new EnglishParser();
const patternMatcher = new PatternMatcher({
parser: englishParser
});
const pattern = patternMatcher.tag`This is a ${{
type: "WordNode",
children: [
{
type: "TextNode",
value: /\w+/
}
]
}}.`;
let text = "Hello, This is a pen.";
const results = patternMatcher.match(text, pattern);
const result = results[0];
assert.strictEqual(
text.slice(result.position.start.offset, result.position.end.offset),
"This is a pen."
);match-test-replace aim to provide match, test and replace easily.
import { replaceAll, matchTestReplace } from "match-test-replace";
const text = "webkit is matched,but node-webkit is not match";
const res = matchTestReplace(text, {
pattern: /(\S*?)webkit/g,
replace: () => "WebKit",
test: ({ captures }) => {
return captures[0] !== "node-";
}
});
assert.ok(res.ok === true, "should be ok: false");
assert.strictEqual(res.results.length, 1, "no replace");
assert.strictEqual(replaceAll(text, res.results).output, "WebKit is matched,but node-webkit is not match");Easy match and replace, but test strictly.
import * as assert from "assert";
import { replaceAll, matchTestReplace } from "match-test-replace";
import { PatternMatcher } from "nlcst-pattern-match";
import { EnglishParser } from "nlcst-parse-english";
const englishParser = new EnglishParser();
const matcher = new PatternMatcher({ parser: englishParser });
// https://developers.google.com/style/clause-order
// NG: Click Delete if you want to delete the entire document.
// OK: To delete the entire document, click Delete.
const text = 'Click Delete if you want to delete the entire document.';
const res = matchTestReplace(text, {
pattern: /Click (\w+) if you want to (.+)./,
replace: ({ captures }) => {
console.log(captures);
return `To ${captures[1]}, click ${captures[0]}.`
},
test: ({ all }) => {
const pattern = matcher.tag`Click ${{
type: "WordNode",
data: {
// Verb
pos: /^VB/
}
}}`;
return matcher.test(all, pattern);
}
});
assert.ok(res.ok === true, "should be ok: true");
const output = replaceAll(text, res.results).output;
assert.strictEqual(output, "To delete the entire document, click Delete.");See Releases page.
yarn
# setup pacakges
yarn bootstrap
# test
yarn test
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
MIT © azu