1.0.0 • Published 2 years ago

@devtea2028/cumque-quis-eum-pariatur

Licence

MIT

Version

1.0.0

Deps

Size

19 kB

Vulns

Weekly

Summary Dependency Versions

@devtea2028/cumque-quis-eum-pariatur

A regular expression parser for ECMAScript.

Installation

$ npm install @devtea2028/cumque-quis-eum-pariatur

require Node@^12.0.0 || ^14.0.0 || >=16.0.0.

Usage

import {
    AST,
    RegExpParser,
    RegExpValidator,
    RegExpVisitor,
    parseRegExpLiteral,
    validateRegExpLiteral,
    visitRegExpAST
} from "@devtea2028/cumque-quis-eum-pariatur"

parseRegExpLiteral(source, options?)

Parse a given regular expression literal then make AST object.

This is equivalent to new RegExpParser(options).parseLiteral(source).

Parameters:
- source (string | RegExp) The source code to parse.
- options? (RegExpParser.Options) The options to parse.
Return:
- The AST of the regular expression.

validateRegExpLiteral(source, options?)

Validate a given regular expression literal.

This is equivalent to new RegExpValidator(options).validateLiteral(source).

Parameters:
- source (string) The source code to validate.
- options? (RegExpValidator.Options) The options to validate.

visitRegExpAST(ast, handlers)

Visit each node of a given AST.

This is equivalent to new RegExpVisitor(handlers).visit(ast).

Parameters:
- ast (AST.Node) The AST to visit.
- handlers (RegExpVisitor.Handlers) The callbacks.

RegExpParser

new RegExpParser(options?)

Parameters:
- options? (RegExpParser.Options) The options to parse.

parser.parseLiteral(source, start?, end?)

Parse a regular expression literal.

Parameters:
- source (string) The source code to parse. E.g. "/abc/g".
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.
Return:
- The AST of the regular expression.

parser.parsePattern(source, start?, end?, flags?)

Parse a regular expression pattern.

Parameters:
- source (string) The source code to parse. E.g. "abc".
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.
- flags? ({ unicode?: boolean, unicodeSets?: boolean }) The flags to enable Unicode mode, and Unicode Set mode.
Return:
- The AST of the regular expression pattern.

parser.parseFlags(source, start?, end?)

Parse a regular expression flags.

Parameters:
- source (string) The source code to parse. E.g. "gim".
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.
Return:
- The AST of the regular expression flags.

RegExpValidator

new RegExpValidator(options)

Parameters:
- options (RegExpValidator.Options) The options to validate.

validator.validateLiteral(source, start, end)

Validate a regular expression literal.

Parameters:
- source (string) The source code to validate.
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.

validator.validatePattern(source, start, end, flags)

Validate a regular expression pattern.

Parameters:
- source (string) The source code to validate.
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.
- flags? ({ unicode?: boolean, unicodeSets?: boolean }) The flags to enable Unicode mode, and Unicode Set mode.

validator.validateFlags(source, start, end)

Validate a regular expression flags.

Parameters:
- source (string) The source code to validate.
- start? (number) The start index in the source code. Default is 0.
- end? (number) The end index in the source code. Default is source.length.

RegExpVisitor

new RegExpVisitor(handlers)

Parameters:
- handlers (RegExpVisitor.Handlers) The callbacks.

visitor.visit(ast)

Validate a regular expression literal.

Parameters:
- ast (AST.Node) The AST to visit.

Changelog

GitHub Releases

Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

npm test runs tests and measures coverage.
npm run build compiles TypeScript source code to index.js, index.js.map, and index.d.ts.
npm run clean removes the temporary files which are created by npm test and npm run build.
npm run lint runs ESLint.
npm run update:test updates test fixtures.
npm run update:ids updates src/unicode/ids.ts.
npm run watch runs tests with --watch option.

Keywords

valid handlers internal setPrototypeOf start debugger properties drop rest lazy log beanstalk efficient CSSStyleDeclaration promise require syntax diff _.extend sqs es6 emr shared fast-deep-copy parent folder make dir Symbol.toStringTag dom buffers ECMAScript 2022 recursive forEach css less sorted nested css figlet tester uuid nodejs testing command-line phone Object.is eventEmitter ES8 typedarray mobile tools in take validation env toolkit jasmine dir jsx arrays is value computed-types classname picomatch symbol ender reuse s3 css nesting proxy airbnb findLast argv urls JSON nope dataView autoscaling vpc type encryption gdpr ES2018 signal bcrypt prop colour style loading glob arguments moment package postcss less.js zero bdd monorepo reducer javascript term remove trimStart AsyncIterator curl full rgb has generics ECMAScript 2015 Array.prototype.flat form glacier weakset consume core jQuery which input flatten coercible formatting operating-system less css typedarrays Observable watching toStringTag columns Array.prototype.contains spawn rmdir censor opens code points irq dotenv redux-toolkit string typeof Object.assign optimizer queueMicrotask scheme-validation iterator fast-copy sequence resolve omit Int16Array Microsoft npm ECMAScript 2018 expression isConcatSpreadable ECMAScript 2023 inference slot compare ES5 yaml ES7 Stream website logging variables in css time description stringify object callbind tty importexport filter datastructure stringifier command fetch global look-up function keys sigint array walking password wordwrap rm -fr Object.getPrototypeOf fastify idle ratelimit watch exe length findup regexp Symbol concatMap aws typed array packages optimist language structuredClone ES2016 swf Iterator prefix full-width macos router last shim Push trimEnd readablestream Object cloudtrail once es2015 Array.prototype.findLast duplex launch argparse Array.prototype.findLastIndex fast-deep-clone mru some performance ECMAScript 6 deepclone move sns descriptor trim util Streams ECMAScript 5 https check assign ast safe buffer indicator ReactiveX byte hash text cors mocha exit es-shim API lru async fast flatMap option throttle ReactiveExtensions less mixins accessibility logger Object.keys promises json child __proto__tap contains regular expression stable Function.prototype.name stdlib typanion ES2017 map regular expressions lockfile listeners ECMAScript 7 walk file system flux autoprefixer japanese dynamodb bundling wait css-in-js zod tostringtag traverse validate eslintplugin toSorted deep-clone has-own minimal preserve-symlinks directory collection middleware Array.prototype.flatten touch read browserslist arraybuffer byteLength Reflect.getPrototypeOf ES2023 globals ES2020 styled-components sharedarraybuffer jsdom state mkdirp queue trimLeft [[Prototype]]ebs entries merge es2016 chai cloudformation pipe readable ArrayBuffer escape es5 east-asian-width channel .env browser cmd parsing character internal slot loadbalancing crypto linux view rm includes busy Array terminal args flat hasOwnProperty functions names syntaxerror slice windows key shrinkwrap ECMAScript 2016 fs path exec Array.prototype.includes RxJS console cloudfront redux dom-testing-library auth stream immutable groupBy hasOwn make 256 0 parents flags open symlinks ArrayBuffer.prototype.slice extend hot estree telephone http Uint32Array shebang ECMAScript 2021 eslint debug a11y getintrinsic vest starter Float32Array assertion Uint16Array up intrinsic ajv bound mime-db width gradients css negative default ES2019 typed offset util.inspect querystring lint jsonpath framework asserts $.extend es property Uint8Array dayjs RegExp.prototype.flags private postcss-plugin whatwg sort dependency manager xhr xterm CSS signals clone Object.fromEntries elb group ajax RFC-6455 push less deep fixed-width chromium extension react mapreduce StyleSheet eventDispatcher art url tslib iam colors BigInt64Array quote karma get editor warning Int32Array own concurrency spinners JSON-Schema interrupts Underscore package.json String.prototype.matchAll typescript setter awesomesauce crypt vars ES2022 browserlist WebSocket xdg native byteOffset installer URLSearchParams elasticache hookform class-validator redact query persistent private data js Map define column sameValueZero agent styleguide Object.values api functional search immer performant mime bluebird RegExp#flags ArrayBuffer#slice toobject spinner authentication bundler linewrap write create ses prototype bootstrap less ava flag connect modules Array.prototype.filter unicode streams serialize circular libphonenumber ECMAScript 3 streams2 fsevents limit commander parser stylesheet form-validation sigterm defineProperty name wrap delete trimRight YAML i18n l10n reduce fullwidth preprocessor restful app jsdiff mkdirs getOwnPropertyDescriptor core-js electron watchFile await sham ES2021 Uint8ClampedArray settings descriptors bind color ES callbound storagegateway match serializer spec Float64Array positive eslint-plugin extra amazon regex collection.es6 fastcopy real-time fast-clone opener prune compiler less compiler korean accessor route53 css variable BigUint64Array enumerable writable runtime joi pretty test rangeerror jest assert predictable configurable symlink compile less styles dataview data es7 environments utility utilities endpoint ecmascript callback patch environment deepcopy es8 ECMAScript 2019 react-hooks -0 parse fps gradients css3 HyBi kinesis banner error ECMAScript 2020 xdg-open Object.entries toArray error-handling format polyfill matchAll protocol-buffers classnames superagent getopt call-bind number ie limited web mixins plugin ES6 styling module types rate cjk ES2015 symbols setImmediate WeakSet URL emoji date ECMAScript 2017 cache react-hook-form look random set throat call call-bound TypedArray proto emit status ansi helpers lesscss process chinese config cloudwatch equality cloudsearch typeerror bootstrap css events Object.defineProperty mkdir copy superstruct visual pyyaml progress rm -rf fastclone invariant yup String.prototype.trim find css every jwt live iterate ESnext characters serialization higher-order multi-package Array.prototype.flatMap rds equal waf io-ts weakmap ponyfill guid iteration jshint express WeakMap sinatra eslintconfig classes tdd negative zero tape ec2 Int8Array arktype id es2018 simpledb es2017 es-shims hooks matches elm inspect argument Observables mimetypes rfc4122 ascii replay getter codes task side shell exit-code dependencies wordbreak es-abstract metadata watcher wget findLastIndex TypeBox scheme identifiers link import package manager tc39 ES3 install qs TypeScript values request