64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
|
Shift AST Constructors
|
||
|
|
======================
|
||
|
|
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
This project provides constructors for
|
||
|
|
[Shift format](https://github.com/shapesecurity/shift-spec) AST nodes.
|
||
|
|
|
||
|
|
The resulting objects are suitable for use with the rest of the [Shift suite](http://shift-ast.org/).
|
||
|
|
|
||
|
|
There is a version with typechecking available as `shift-ast/checked` for use during development.
|
||
|
|
|
||
|
|
## Status
|
||
|
|
|
||
|
|
[Stable](http://nodejs.org/api/documentation.html#documentation_stability_index).
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install shift-ast
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var AST = require("shift-ast"); // or "shift-ast/checked"
|
||
|
|
var myAstFragment = new AST.LabeledStatement({
|
||
|
|
label: "label",
|
||
|
|
body: new AST.EmptyStatement
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
* Open a Github issue with a description of your desired change. If one exists already, leave a message stating that you are working on it with the date you expect it to be complete.
|
||
|
|
* Fork this repo, and clone the forked repo.
|
||
|
|
* Install dependencies with `npm install`.
|
||
|
|
* Build and test in your environment with `npm run build && npm test`.
|
||
|
|
* Create a feature branch. Make your changes. Add tests.
|
||
|
|
* Build and test in your environment with `npm run build && npm test`.
|
||
|
|
* Make a commit that includes the text "fixes #*XX*" where *XX* is the Github issue.
|
||
|
|
* Open a Pull Request on Github.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Copyright 2014 Shape Security, Inc.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|