Skip to content

Commit 5bc1471

Browse files
committed
ws in markdown files
1 parent 1b2393a commit 5bc1471

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Contributing to Jison
33

44
Fork, make your changes, run tests and/or add tests then send a pull request.
55

6-
## Required tools for Development
6+
## Required tools for Development
77

88
- NodeJS
99
- NPM
1010
- GNU make (make sure you can run the `make` command from your (bash) shell command line)
1111

12-
When you are working on the Microsoft Windows OS, you can obtain the prerequisite tools
13-
by installing Git-for-Windows **and its Developer SDK**
12+
When you are working on the Microsoft Windows OS, you can obtain the prerequisite tools
13+
by installing Git-for-Windows **and its Developer SDK**
1414
(as only the latter includes *GNU make*, for example, at the time of writing: April 2017):
1515

1616
- [Git-for-Windows](https://git-for-windows.github.io/)
@@ -56,20 +56,20 @@ Then run tests with:
5656
To build the site, as well as the Browserified web version of Jison, run:
5757

5858
make site
59-
59+
6060
Then you can also preview the site by doing:
6161

6262
make preview
63-
63+
6464
Note that you will need `nanoc` and `adsf` in order to build/preview the site. `gem install` them if you haven't.
6565

6666
> ### Note
6767
>
68-
> The `make site` build command will print a WARNING message when `nanoc` is not available,
68+
> The `make site` build command will print a WARNING message when `nanoc` is not available,
6969
> but WILL NOT fail the `site` build task. This behaviour has been specifically chosen to
7070
> allow (pre)release build runs to complete and deliver a new jison revision when everything
7171
> but the web pages has compiled successfully.
72-
>
72+
>
7373
7474

7575
## Building a new (beta-)release
@@ -82,7 +82,7 @@ which will patch all `package.json` files.
8282

8383
You can now run
8484

85-
make
85+
make
8686
make site
8787

8888
to build all files, but when you want to be absolute sure and/or need to update some of the core files using your latest jison compiler, then push jison and all its submodules to github and run

README.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -64,55 +64,55 @@ lexfile file containing a lexical grammar
6464

6565
Where the available `options` are:
6666

67-
: -j, --json
67+
: -j, --json
6868
force jison to expect a grammar in JSON format \[false\]
6969

70-
: -o FILE, --outfile FILE
70+
: -o FILE, --outfile FILE
7171
Filepath and base module name of the generated parser; when terminated with a / \(dir separator\) it is treated as the destination directory where the generated output will be stored
7272

73-
: -t, --debug
73+
: -t, --debug
7474
Debug mode \[false\]
7575

76-
: -I, --info
76+
: -I, --info
7777
Report some statistics about the generated parser \[false\]
7878

79-
: -m TYPE, --module-type TYPE
79+
: -m TYPE, --module-type TYPE
8080
The type of module to generate \(commonjs, amd, es, js\) \[commonjs\]
8181

82-
: -n NAME, --module-name NAME
82+
: -n NAME, --module-name NAME
8383
The name of the generated parser object, namespace supported
8484

85-
: -p TYPE, --parser-type TYPE
85+
: -p TYPE, --parser-type TYPE
8686
The type of algorithm to use for the parser \(lr0, slr, lalr, lr, ll\) \[lalr\]
8787

88-
: -c, --compress-tables
88+
: -c, --compress-tables
8989
Output compressed parser tables in generated modules \(0 = no compression, 1 = default compression, 2 = deep compression\) \[2\]
9090

91-
: -T, --output-debug-tables
91+
: -T, --output-debug-tables
9292
Output extra parser tables \(rules list + look-ahead analysis\) in generated modules to assist debugging / diagnostics purposes \[false\]
9393

94-
: -X, --no-default-resolve
94+
: -X, --no-default-resolve
9595
Act another way when a conflict is found in the grammar \[false\]
9696

97-
: --no-default-action
97+
: --no-default-action
9898
Generate a parser which does NOT include the default "$$ = $1" action for every rule. This produces a slightly faster parser but now you are solely reponsible for propagating rule action "$$" results. \[false\]
9999

100-
: --no-try-catch
100+
: --no-try-catch
101101
Generate a parser which does NOT try/catch exceptions \(from the grammar action code or parseError error reporting calls. This produces a slightly faster parser at the cost of enhanced code safety. \[false\]
102102

103-
: -Q, --error-recovery-token-discard-count
103+
: -Q, --error-recovery-token-discard-count
104104
Set the number of lexed tokens that may be gobbled by an error recovery process before we cry wolf \(default: 3\) \[3\]
105105

106-
: -E, --export-all-tables
106+
: -E, --export-all-tables
107107
Next to producing a grammar source file, also export the symbols, terminals, grammar and parse tables to separate JSON files for further use by other tools. The files' names will be derived from the outputFile name by appending a suffix. \[false\]
108108

109-
: -x, --main
109+
: -x, --main
110110
Include .main\(\) entry point in generated commonjs module \[false\]
111111

112-
: -y NAME, --module-main NAME
112+
: -y NAME, --module-main NAME
113113
The main module function definition
114114

115-
: -V, --version
115+
: -V, --version
116116
print version and exit
117117

118118
## Usage from a CommonJS module
@@ -183,7 +183,7 @@ Here's a comprehensive list of features and fixes compared to the [original](htt
183183

184184
* EBNF LR/LALR/SLR/LR0 grammars are correctly rewritten to BNF grammars, allowing your action code blocks to access all elements of the grammar rule at hand. See also [the wiki section about EBNF](https://github.com/zaach/jison/wiki/Deviations-From-Flex-Bison#user-content-extended-bnf).
185185

186-
* **Parser engine optimization**: jison analyzes not just your grammar, but also your action code and will strip any feature you don't use \(such as [location tracking](https://github.com/zaach/jison/wiki/Deviations-From-Flex-Bison#user-content-accessing-values-and-location-information) via
186+
* **Parser engine optimization**: jison analyzes not just your grammar, but also your action code and will strip any feature you don't use \(such as [location tracking](https://github.com/zaach/jison/wiki/Deviations-From-Flex-Bison#user-content-accessing-values-and-location-information) via
187187
`@element` references and `yylloc`\) from the parser kernel, which will benefit your parser run-time performance. The fastest parsers are obtained when you do not include error recovery \(`error` tokens in your grammar\), nor any lexer location tracking: this can potentially result in run-time execution cost reductions of over 70% \(hence your parser executes more than 3 times as fast\)!
188188

189189
* generated grammar / lexer source files carry a full API and internals documentation in the code comments to help you to read and debug a grammar. For example, every grammar rule is printed above its action code so that stepping through the parser when debugging hard-to-find problems makes it quite obvious which rule the engine is currently 'reducing'.
@@ -228,28 +228,28 @@ Here's a comprehensive list of features and fixes compared to the [original](htt
228228

229229
> Copyright \(c\) 2009-2016 Zachary Carter
230230
>
231-
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without
232-
> limitation the rights to use, copy, modify, merge, publish, distribute,
233-
> sublicense, and/or sell copies of the
234-
> Software, and to permit persons to
235-
> whom the Software is furnished to do
236-
> so, subject to the following
231+
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files \(the "Software"\), to deal in the Software without restriction, including without
232+
> limitation the rights to use, copy, modify, merge, publish, distribute,
233+
> sublicense, and/or sell copies of the
234+
> Software, and to permit persons to
235+
> whom the Software is furnished to do
236+
> so, subject to the following
237237
> conditions:
238238
>
239-
> The above copyright notice and this
240-
> permission notice shall be included
241-
> in all copies or substantial portions
239+
> The above copyright notice and this
240+
> permission notice shall be included
241+
> in all copies or substantial portions
242242
> of the Software.
243243
>
244-
> THE SOFTWARE IS PROVIDED "AS IS",
245-
> WITHOUT WARRANTY OF ANY KIND, EXPRESS
246-
> OR IMPLIED, INCLUDING BUT NOT LIMITED
247-
> TO THE WARRANTIES OF MERCHANTABILITY,
248-
> FITNESS FOR A PARTICULAR PURPOSE AND
249-
> NONINFRINGEMENT. IN NO EVENT SHALL THE
250-
> AUTHORS OR COPYRIGHT HOLDERS BE
251-
> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
252-
> LIABILITY, WHETHER IN AN ACTION OF
244+
> THE SOFTWARE IS PROVIDED "AS IS",
245+
> WITHOUT WARRANTY OF ANY KIND, EXPRESS
246+
> OR IMPLIED, INCLUDING BUT NOT LIMITED
247+
> TO THE WARRANTIES OF MERCHANTABILITY,
248+
> FITNESS FOR A PARTICULAR PURPOSE AND
249+
> NONINFRINGEMENT. IN NO EVENT SHALL THE
250+
> AUTHORS OR COPYRIGHT HOLDERS BE
251+
> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
252+
> LIABILITY, WHETHER IN AN ACTION OF
253253
> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
254254
255255

0 commit comments

Comments
 (0)