judicial-hy / 0.200103

Blame view

node_modules/regexpp/README.md 4.6 KB
Edit Raw Normal View History
ce4c83ff   wxy   εˆε§‹ζδΊ€ 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
  # regexpp
  
  [![npm version](https://img.shields.io/npm/v/regexpp.svg)](https://www.npmjs.com/package/regexpp)
  [![Downloads/month](https://img.shields.io/npm/dm/regexpp.svg)](http://www.npmtrends.com/regexpp)
  [![Build Status](https://travis-ci.org/mysticatea/regexpp.svg?branch=master)](https://travis-ci.org/mysticatea/regexpp)
  [![Dependency Status](https://david-dm.org/mysticatea/regexpp.svg)](https://david-dm.org/mysticatea/regexpp)
  
  The regular expression parser for ECMAScript.
  
  ## πŸ’Ώ Installation
  
  ```bash
  $ npm install regexpp
  ```
  
  - require Node.js 4.0.0 or newer.
  
  ## πŸ“– Usage
  
  ```ts
  import {
      AST,
      RegExpParser,
      RegExpValidator,
      parseRegExpLiteral,
      validateRegExpLiteral,
  } from "regexpp"
  ```
  
  ### 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`) 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.
  
  ### 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?, uFlag?)
  
  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`.
      - `uFlag?` (`boolean`) The flag to enable Unicode 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, uFlag)
  
  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`.
      - `uFlag?` (`boolean`) The flag to enable Unicode 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`.
  
  ## πŸ“° Changelog
  
  - [GitHub Releases](https://github.com/mysticatea/regexpp/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.
  
  [`RegExpParser.Options`]: src/parser.ts#L527
  [`RegExpValidator.Options`]: src/validator.ts#L127