3.5.73 • Published 1 year ago

@dramaorg/aperiam-corporis v3.5.73

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@dramaorg/aperiam-corporis

npm version Downloads/month Build Status codecov

A regular expression parser for ECMAScript.

💿 Installation

$ npm install @dramaorg/aperiam-corporis
  • require Node@^12.0.0 || ^14.0.0 || >=16.0.0.

📖 Usage

import {
    AST,
    RegExpParser,
    RegExpValidator,
    RegExpVisitor,
    parseRegExpLiteral,
    validateRegExpLiteral,
    visitRegExpAST
} from "@dramaorg/aperiam-corporis"

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).

visitRegExpAST(ast, handlers)

Visit each node of a given AST.

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

RegExpParser

new RegExpParser(options?)

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)

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)

visitor.visit(ast)

Validate a regular expression literal.

  • Parameters:

📰 Changelog

🍻 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.
importprotobufredirectinstallxmlterminaliamcallboundtypeerrorreadparentsdescriptorswarningagentstreamkeyswgetworkspace:*ES3fastcloneString.prototype.matchAllObservableinstallerfind-upbinariesfile systemmockRxlocaltraversetypeofeventspostcss-pluginpostcssmetadatalookzodECMAScript 6Mapchaiio-tscoveragewebdependenciesvpcutil.inspectenvironmentArray.prototype.findLastIndexequalitystringifierbyteOffsetiteratepnpm9expressionisparentajvperformancereversedguidECMAScript 2019filterprotocol-buffersfsschemacode pointshookformflatMapES2019syntaxacornregular expressionsttyeventEmitterbannerunicodecacheprototypeentriesReflect.getPrototypeOffpcallObject.assignfast-deep-clonezxreal-timeeast-asian-widthpackage managerSymbolbines2016validationserverdependency managerwalkingkoreansnstouchFloat32Arraystyleguidebabelform-validationdescriptionURLproxyrm -frtrimbufferefficientBigInt64ArrayTypeBoxaccessibilityspeedArray.prototype.flattenloggertrimStartcallbinddropclientspecjson-schema-validatorrssIteratorYAMLlibphonenumbercontainscompiler.envpurecolumntoSortedramdachecksharedarraybufferfiglettranspilerenumerablerecursivesuperagentprogressflagscomparehigher-ordercjkgetPrototypeOfsearchautoprefixerrgbES2017full-widtheveryconsumekinesispropertiesclinpmReactiveExtensionsECMAScript 2022jsxobjes8spawnprunequeueMicrotaskES2020dotenvfindLastIndexObject.valuesuuidtimecss-in-jsimmutableWebSocketses-shim APIforEachwalkchromiummakeelectronStreamletObject.entriesbuffersjsonschema_.extendcomputed-typesES7diffasciiframeworksettingsUint8ClampedArraycommandertostringtagcodes.gitignorearttypedarraysmodulearraysReactiveXinferencePromisedeleteRegExp.prototype.flagsfromObservablesRxJSfastcopyfindupclassestypesbrowserslistwritereadablesuperstructwritableajaxposeflattenArraywhatwgfastifymkdirsnumberoptimizerslotbyteLengthreduxcensorqueueString.prototype.trimtypedarrayjson-schema-validationfantasy-landreduceoptimisttextES2023immerviewstabletapeassignpoint-freeatomvarcall-bindmomentgetoptlinkfixed-widthlastdeepconfiglrurm -rfhelperqscurriedsubprocessintrinsicES5tstrimRightamazonprettypackageconfigurableformattingreact posewaapishimdefinetransportpositiverequestnegative zerojavascriptWeakMapec2awesomesaucefast-copy[[Prototype]]robustmerge
3.5.73

1 year ago

3.5.72

1 year ago

3.5.71

1 year ago

3.5.70

1 year ago

3.4.70

1 year ago

3.4.69

1 year ago

3.4.68

1 year ago

3.4.67

1 year ago

3.4.66

1 year ago

3.4.65

1 year ago

3.4.64

1 year ago

3.4.63

1 year ago

3.4.62

1 year ago

3.4.61

1 year ago

3.4.60

1 year ago

2.4.60

1 year ago

2.3.60

1 year ago

2.3.59

1 year ago

2.3.58

1 year ago

2.3.57

1 year ago

2.3.56

1 year ago

2.3.55

1 year ago

2.3.54

1 year ago

2.3.53

1 year ago

2.3.52

1 year ago

2.3.51

1 year ago

2.3.50

1 year ago

2.3.49

1 year ago

2.3.48

1 year ago

2.3.47

1 year ago

2.3.46

1 year ago

2.2.46

1 year ago

2.2.45

1 year ago

2.2.44

1 year ago

2.2.43

1 year ago

2.2.42

1 year ago

2.2.41

1 year ago

2.2.40

1 year ago

2.1.40

1 year ago

2.1.39

1 year ago

2.1.38

1 year ago

2.1.37

1 year ago

2.1.36

1 year ago

2.1.35

1 year ago

2.1.34

1 year ago

2.1.33

1 year ago

2.1.32

1 year ago

2.1.31

1 year ago

2.1.30

1 year ago

2.1.29

1 year ago

2.1.28

1 year ago

2.1.27

1 year ago

2.1.26

1 year ago

2.1.25

1 year ago

2.1.24

1 year ago

2.1.23

1 year ago

2.1.22

1 year ago

2.1.21

1 year ago

2.1.20

1 year ago

2.1.19

1 year ago

2.1.18

1 year ago

1.1.18

1 year ago

1.1.17

1 year ago

1.1.16

1 year ago

1.1.15

1 year ago

1.1.14

1 year ago

1.1.13

1 year ago

1.1.12

1 year ago

1.1.11

1 year ago

1.1.10

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago