cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Work around broken Markdown implementation on github

Browse Source 
Not that I can blame anyone for making mistakes implementing a
poorly specified mess like markdown.
This commit is contained in:
Marijn Haverbeke 2013-11-04 16:52:34 +01:00
parent 5ec47cf80d
commit 6be7a84649
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -31,7 +31,7 @@ properties will be added to that.
This file contains the actual parser (and is what you get when you This file contains the actual parser (and is what you get when you
`require("acorn")` in node.js). `require("acorn")` in node.js).
**`parse`**`(input, options)` is used to parse a JavaScript program. **parse**(input, options)` is used to parse a JavaScript program.
The `input` parameter is a string, `options` can be undefined or an The `input` parameter is a string, `options` can be undefined or an
object setting some of the options listed below. The return value will object setting some of the options listed below. The return value will
be an abstract syntax tree object as specified by the be an abstract syntax tree object as specified by the
@ -45,26 +45,26 @@ object referring to that same position.
[mozapi]: https://developer.mozilla.org/en-US/docs/SpiderMonkey/Parser_API [mozapi]: https://developer.mozilla.org/en-US/docs/SpiderMonkey/Parser_API
- **`ecmaVersion`**: Indicates the ECMAScript version to parse. Must be - **ecmaVersion**: Indicates the ECMAScript version to parse. Must be
either 3 or 5. This influences support for strict mode, the set of either 3 or 5. This influences support for strict mode, the set of
reserved words, and support for getters and setter. Default is 5. reserved words, and support for getters and setter. Default is 5.
- **`strictSemicolons`**: If `true`, prevents the parser from doing - **strictSemicolons**: If `true`, prevents the parser from doing
automatic semicolon insertion, and statements that do not end with automatic semicolon insertion, and statements that do not end with
a semicolon will generate an error. Defaults to `false`. a semicolon will generate an error. Defaults to `false`.
- **`allowTrailingCommas`**: If `false`, the parser will not allow - **allowTrailingCommas**: If `false`, the parser will not allow
trailing commas in array and object literals. Default is `true`. trailing commas in array and object literals. Default is `true`.
- **`forbidReserved`**: If `true`, using a reserved word will generate - **forbidReserved**: If `true`, using a reserved word will generate
an error. Defaults to `false`. an error. Defaults to `false`.
- **`locations`**: When `true`, each node has a `loc` object attached - **locations**: When `true`, each node has a `loc` object attached
with `start` and `end` subobjects, each of which contains the with `start` and `end` subobjects, each of which contains the
one-based line and zero-based column numbers in `{line, column}` one-based line and zero-based column numbers in `{line, column}`
form. Default is `false`. form. Default is `false`.
- **`onComment`**: If a function is passed for this option, whenever a - **onComment**: If a function is passed for this option, whenever a
comment is encountered the function will be called with the comment is encountered the function will be called with the
following parameters: following parameters:
@ -78,34 +78,34 @@ object referring to that same position.
of the comment’s start and end are passed as two additional of the comment’s start and end are passed as two additional
parameters. parameters.
- **`ranges`**: Nodes have their start and end characters offsets - **ranges**: Nodes have their start and end characters offsets
recorded in `start` and `end` properties (directly on the node, recorded in `start` and `end` properties (directly on the node,
rather than the `loc` object, which holds line/column data. To also rather than the `loc` object, which holds line/column data. To also
add a [semi-standardized][range] "range" property holding a add a [semi-standardized][range] "range" property holding a
`[start, end]` array with the same numbers, set the `ranges` option `[start, end]` array with the same numbers, set the `ranges` option
to `true`. to `true`.
- **`program`**: It is possible to parse multiple files into a single - **program**: It is possible to parse multiple files into a single
AST by passing the tree produced by parsing the first file as the AST by passing the tree produced by parsing the first file as the
`program` option in subsequent parses. This will add the toplevel `program` option in subsequent parses. This will add the toplevel
forms of the parsed file to the "Program" (top) node of an existing forms of the parsed file to the "Program" (top) node of an existing
parse tree. parse tree.
- **`sourceFile`**: When the `locations` option is `true`, you can pass - **sourceFile**: When the `locations` option is `true`, you can pass
this option to add a `sourceFile` attribute in every node’s `loc` this option to add a `sourceFile` attribute in every node’s `loc`
object. Note that the contents of this option are not examined or object. Note that the contents of this option are not examined or
processed in any way; you are free to use whatever format you processed in any way; you are free to use whatever format you
choose. choose.
- **`directSourceFile`**: Like `sourceFile`, but the property will be - **directSourceFile**: Like `sourceFile`, but the property will be
added directly to the nodes, rather than to a `loc` object. added directly to the nodes, rather than to a `loc` object.
[range]: https://bugzilla.mozilla.org/show_bug.cgi?id=745678 [range]: https://bugzilla.mozilla.org/show_bug.cgi?id=745678
**`getLineInfo`**`(input, offset)` can be used to get a `{line, **getLineInfo**(input, offset)` can be used to get a `{line,
column}` object for a given program string and character offset. column}` object for a given program string and character offset.
**`tokenize`**`(input, options)` exports a primitive interface to **tokenize**(input, options)` exports a primitive interface to
Acorn's tokenizer. The function takes an input string and options Acorn's tokenizer. The function takes an input string and options
similar to `parse` (though only some options are meaningful here), and similar to `parse` (though only some options are meaningful here), and
returns a function that can be called repeatedly to read a single returns a function that can be called repeatedly to read a single
@ -114,7 +114,7 @@ token, and returns a `{start, end, type, value}` object (with added
enabled). This object will be reused (updated) for each token, so you enabled). This object will be reused (updated) for each token, so you
can't count on it staying stable. can't count on it staying stable.
**`tokTypes`** holds an object mapping names to the token type objects **tokTypes** holds an object mapping names to the token type objects
that end up in the `type` properties of tokens. that end up in the `type` properties of tokens.
### acorn_loose.js ### ### acorn_loose.js ###
@ -122,7 +122,7 @@ that end up in the `type` properties of tokens.
This file implements an error-tolerant parser. It exposes a single This file implements an error-tolerant parser. It exposes a single
function. function.
**`parse_dammit`**`(input, options)` takes the same arguments and **parse_dammit**(input, options)` takes the same arguments and
returns the same syntax tree as the `parse` function in `acorn.js`, returns the same syntax tree as the `parse` function in `acorn.js`,
but never raises an error, and will do its best to parse syntactically but never raises an error, and will do its best to parse syntactically
invalid code in as meaningful a way as it can. It'll insert identifier invalid code in as meaningful a way as it can. It'll insert identifier
@ -135,7 +135,7 @@ tokenizer.
Implements an abstract syntax tree walker. Will store its interface in Implements an abstract syntax tree walker. Will store its interface in
`acorn.walk` when used without a module system. `acorn.walk` when used without a module system.
**`simple`**`(node, visitors, base, state)` does a 'simple' walk over **simple**(node, visitors, base, state)` does a 'simple' walk over
a tree. `node` should be the AST node to walk, and `visitors` an a tree. `node` should be the AST node to walk, and `visitors` an
object with properties whose names correspond to node types in the object with properties whose names correspond to node types in the
[Mozilla Parser API][mozapi]. The properties should contain functions [Mozilla Parser API][mozapi]. The properties should contain functions
@ -146,7 +146,7 @@ simply visit all statements and expressions and not produce a
meaningful state. (An example of a use of state it to track scope at meaningful state. (An example of a use of state it to track scope at
each point in the tree.) each point in the tree.)
**`recursive`**`(node, state, functions, base)` does a 'recursive' **recursive**(node, state, functions, base)` does a 'recursive'
walk, where the walker functions are responsible for continuing the walk, where the walker functions are responsible for continuing the
walk on the child nodes of their target node. `state` is the start walk on the child nodes of their target node. `state` is the start
state, and `functions` should contain an object that maps node types state, and `functions` should contain an object that maps node types
@ -157,11 +157,11 @@ the `c` argument on it with `(node, state)` arguments. The optional
that aren't handled in the `functions` object. If not given, the that aren't handled in the `functions` object. If not given, the
default walkers will be used. default walkers will be used.
**`make`**`(functions, base)` builds a new walker object by using the **make**(functions, base)` builds a new walker object by using the
walker functions in `functions` and filling in the missing ones by walker functions in `functions` and filling in the missing ones by
taking defaults from `base`. taking defaults from `base`.
**`findNodeAt`**`(node, start, end, test, base, state)` tries to **findNodeAt**(node, start, end, test, base, state)` tries to
locate a node in a tree at the given start and/or end offsets, which locate a node in a tree at the given start and/or end offsets, which
satisfies the predicate `test`. `start` end `end` can be either `null` satisfies the predicate `test`. `start` end `end` can be either `null`
(as wildcard) or a number. `test` may be a string (indicating a node (as wildcard) or a number. `test` may be a string (indicating a node
@ -171,11 +171,11 @@ and `state` are optional, and can be used to specify a custom walker.
Nodes are tested from inner to outer, so if two nodes match the Nodes are tested from inner to outer, so if two nodes match the
boundaries, the inner one will be preferred. boundaries, the inner one will be preferred.
**`findNodeAround`**`(node, pos, test, base, state)` is a lot like **findNodeAround**(node, pos, test, base, state)` is a lot like
`findNodeAt`, but will match any node that exists 'around' (spanning) `findNodeAt`, but will match any node that exists 'around' (spanning)
the given position. the given position.
**`findNodeAfter`**`(node, pos, test, base, state)` is similar to **findNodeAfter**(node, pos, test, base, state)` is similar to
`findNodeAround`, but will match all nodes *after* the given position `findNodeAround`, but will match all nodes *after* the given position
(testing outer nodes before inner nodes). (testing outer nodes before inner nodes).