oniguruma-to-js

Covert Oniguruma-flavor Regexp to JavaScript native RegExp

Last updated 3 months ago by antfu .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ npm install oniguruma-to-js

SYNC missed versions from official npm registry.

oniguruma-to-js

Convert Oniguruma-flavor Regexp to JavaScript native RegExp.

Supported Oniguruma features:

[:alnum:], [:alpha:] etc. POSIX bracket expressions
(?x) extended, free-spacing mode
(?i:..) flags modifiers
(?>..) atomic group via regex
..*+ possessive quantifiers via regex
\h \H hex digit shorthands
\p{Blank} \p{Print} etc. Oniguruma-flavored unicode property escapes

Usage

npm i oniguruma-to-js

import { onigurumaToRegexp } from 'oniguruma-to-js'

const re = onigurumaToRegexp(`[[:alnum:]_]+`)
console.log(re) // /^[a-zA-Z0-9_]+$/

import { construct, syntaxLowering } from 'oniguruma-to-js'

const pattern = syntaxLowering(`(?x:
  \d+    # Match one or more digits
  \s*    # Match zero or more whitespace characters
  [A-Z]+ # Match one or more uppercase letters
)`)
console.log(pattern) // "\d+\s*[A-Z]+"

const re = construct(pattern)
console.log(re) // /\d+\s*[A-Z]+/

Additional Features

Lowering TextMate Grammar

Traverse all the regex patterns in a TextMate grammar, and apply syntaxLowering to lower the syntax.

import { loweringTextmateGrammar } from 'oniguruma-to-js/textmate'
import grammar from '../path/to/grammars/json.json'

const lowered = loweringTextmateGrammar(grammar)

Note this function will not guarantee the correctness of the result, you may need to verify the result manually.

Sponsors

License

MIT License © 2024-PRESENT Anthony Fu

Current Tags

0.4.3 ... latest (3 months ago)

17 Versions

Maintainers (1)

Downloads

Total 17

Today 0

This Week 0

This Month 17

Last Day 0

Last Week 17

Last Month 0

Dependencies (1)

regex ^4.3.2

Dev Dependencies (19)

@antfu/eslint-config ^3.6.0
@antfu/ni ^0.23.0
@antfu/utils ^0.7.10
@shikijs/core ^1.17.0
@shikijs/vscode-textmate ^9.2.2
@types/node ^22.5.4
bumpp ^9.5.2
eslint ^9.10.0
esno ^4.7.0
fast-glob ^3.3.2
lint-staged ^15.2.10
pnpm ^9.10.0
shiki ^1.17.0
simple-git-hooks ^2.11.1
taze ^0.16.8
typescript ^5.6.2
unbuild ^2.0.0
vite ^5.4.4
vitest ^2.1.0

Dependents (2)

© 2010 - cnpmjs.org x YWFE | Home | YWFE