| 1 | Shift AST Constructors
|
| 2 | ======================
|
| 3 |
|
| 4 |
|
| 5 | ## About
|
| 6 |
|
| 7 | This project provides constructors for
|
| 8 | [Shift format](https://github.com/shapesecurity/shift-spec) AST nodes.
|
| 9 |
|
| 10 |
|
| 11 | ## Status
|
| 12 |
|
| 13 | [Stable](http://nodejs.org/api/documentation.html#documentation_stability_index).
|
| 14 |
|
| 15 |
|
| 16 | ## Installation
|
| 17 |
|
| 18 | ```sh
|
| 19 | npm install shift-ast
|
| 20 | ```
|
| 21 |
|
| 22 |
|
| 23 | ## Usage
|
| 24 |
|
| 25 | ```js
|
| 26 | var AST = require("shift-ast");
|
| 27 | var myAstFragment = new AST.LabeledStatement(
|
| 28 | new AST.Identifier("label"),
|
| 29 | new AST.EmptyStatement
|
| 30 | );
|
| 31 | ```
|
| 32 |
|
| 33 |
|
| 34 | ## Contributing
|
| 35 |
|
| 36 | * 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.
|
| 37 | * Fork this repo, and clone the forked repo.
|
| 38 | * Install dependencies with `npm install`.
|
| 39 | * Build and test in your environment with `npm run build && npm test`.
|
| 40 | * Create a feature branch. Make your changes. Add tests.
|
| 41 | * Build and test in your environment with `npm run build && npm test`.
|
| 42 | * Make a commit that includes the text "fixes #*XX*" where *XX* is the Github issue.
|
| 43 | * Open a Pull Request on Github.
|
| 44 |
|
| 45 |
|
| 46 | ## License
|
| 47 |
|
| 48 | Copyright 2014 Shape Security, Inc.
|
| 49 |
|
| 50 | Licensed under the Apache License, Version 2.0 (the "License");
|
| 51 | you may not use this file except in compliance with the License.
|
| 52 | You may obtain a copy of the License at
|
| 53 |
|
| 54 | http://www.apache.org/licenses/LICENSE-2.0
|
| 55 |
|
| 56 | Unless required by applicable law or agreed to in writing, software
|
| 57 | distributed under the License is distributed on an "AS IS" BASIS,
|
| 58 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 59 | See the License for the specific language governing permissions and
|
| 60 | limitations under the License.
|