Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discretetom/tmlb
TmLanguage builder.
https://github.com/discretetom/tmlb
javascript r-compose regex regexp syntax syntax-highlighting tmlanguage typescript vscode vscode-extension
Last synced: 14 days ago
JSON representation
TmLanguage builder.
- Host: GitHub
- URL: https://github.com/discretetom/tmlb
- Owner: DiscreteTom
- License: mit
- Created: 2023-11-10T00:53:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-28T00:57:01.000Z (about 1 year ago)
- Last Synced: 2024-12-13T05:37:49.414Z (22 days ago)
- Topics: javascript, r-compose, regex, regexp, syntax, syntax-highlighting, tmlanguage, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 151 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tmlb
[](https://www.npmjs.com/package/tmlb)
TmLanguage builder.
Generate TmLanguage JSON files from TypeScript. Type hint. Avoid escape hell.
Try it online in the [playground](https://dttk.discretetom.com/js-playground?crushed=%28%27dependencieZ%27Atmlb%25400.1Rtmlbx%7EA%2540discretetom%252Fr-cL%25400.2Rr-cLx%255D%7EcellZMPrepareEt%2520IcLWHrCLqconst%2520IkWHtmlbUtrue%7Eid%21V684787179%29%252CMConstructEt%2520zHnew%2520k%257BIscopeNameGFsource.testF*repo%257BFQsFKInameGFQ.line.testFKmatchG__%252F%252F.source*append%257BIincludeGF%2523QsF*build%257BIvalidateGtrueW%257D%253BDX%29%252CMOutputEole.log%257BJSON.stringify%257BzKnullK2%257D%257DDY%29%255D%7EpanelZVX%252CVY%255D%29*W%257Dq%2520%2520%2520%2520.Ahttps%253A%252F%252Fcdn.jsdelivr.net%252Fnpm%252FDUfalse%7Eid%21VE%27%7Ecode%21%27consF%255C%27G%253A%2520H%2520%253D%2520I%28%2520K%252C%2520LomposeM%28%27name%21%27QcommentR.2%252Fdist%252FU%27%7Ereadonly%21V1703W%2520%29X684847765Y724729746Zs%21%255B_%252F%255C%255CkTmBuilderq%255Cr%255Cnx.min.js%27zlanguage%2501zxqk_ZYXWVURQMLKIHGFEDA*_).
## Install
```bash
yarn add tmlb
```
## Basic Usage
```ts
const language = new TmBuilder({ scopeName: "source.test" })
.repo("comments", { name: "comment.line.test", match: /\/\//.source })
.append({ include: "#comments" })
.build({ validate: true });
```
will yield:
```json
{
"$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
"scopeName": "source.test",
"patterns": [
{
"include": "#comments"
}
],
"repository": {
"comments": {
"name": "comment.line.test",
"match": "\\/\\/"
}
}
}
```
> See: [examples/hello-world](./examples/hello-world).
## Advanced
With [r-compose](https://github.com/DiscreteTom/r-compose), construct readable and maintainable `RegExp`.
Click to Expand
```ts
const language = new TmBuilder({ scopeName: "source.test" })
.append({
name: "comment.line.double-slash.test",
match: compose(({ concat, escape, select }) =>
concat(
escape("//"),
/.*/, // in non-multiline mode, the /./ doesn't match the /\n/
select(/\n/, /$/),
),
).source,
})
.append({
name: "comment.block.test",
begin: compose(({ escape }) => escape("/*")).source,
end: compose(({ escape, select }) => select(escape("*/"), /$/)).source,
})
.append({
name: "keyword.other.test",
match: compose(({ concat, select }) =>
concat(/\b/, select("if", "else", "while"), /\b/),
).source,
})
.append({
name: "string.quoted.double.test",
match: compose(({ concat, any, select, not }) =>
concat(
/"/,
any(
select(
/\\./, // any escaped character
not(concat(/\\/, /"/)), // any char except a backslash or the close quote
),
),
select(/"/, /$/),
),
).source,
})
.build({ validate: true });
```
> See [examples/r-compose](./examples/r-compose).
## [CHANGELOG](./CHANGELOG.md)