Parse into Node objects (#2)

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+source=.
+omit=venv/*
+
+[report]
+fail_under=100

.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+.mypy_cache/
+
+# Coverage
+.coverage
+htmlcov/
+
+venv/

.travis.yml

@@ -0,0 +1,14 @@
+language: python
+cache: pip
+python: "3.6"
+notifications:
+  email: false
+install:
+  - pip3 install -r requirements.txt
+script:
+  - coverage run visitor_test.py
+  - coverage report  # Required coverage threshold in .coveragerc
+  - find . -name '*.py' -not -path './venv/*' -exec pylint '{}' +
+  - mypy .
+after_success:
+  - coveralls

README.md

@@ -1,6 +1,9 @@
 # Esprima AST Visitor
+[![Build Status](https://travis-ci.org/austinbyers/esprima-ast-visitor.svg?branch=master)](https://travis-ci.org/austinbyers/esprima-ast-visitor)
+[![Coverage Status](https://coveralls.io/repos/github/austinbyers/esprima-ast-visitor/badge.svg?branch=master)](https://coveralls.io/github/austinbyers/esprima-ast-visitor?branch=master)
 
-This provides a simple Python3 module for pre-order traversal of an Esprima AST.
+
+This is a Python3.5+ module for transforming an Esprima AST into a traversable Python object.
 
 ## JavaScript Parsing with Esprima
 [Esprima](http://esprima.org/) is a popular state-of-the-art JavaScript parser.
@@ -13,24 +16,46 @@ JSON.stringify(esprima.parse(js_string), null, 2);
 ```
 
 ## AST Format
-Esprima's AST follows a [standard format](https://github.com/estree/estree/blob/master/spec.md) specified by the [ESTree project](https://github.com/estree/estree).
+Esprima's AST follows a [standard format](https://github.com/estree/estree/blob/master/es5.md) specified by the [ESTree project](https://github.com/estree/estree).
 While there are other nodejs projects that provide Esprima AST traversal
 (e.g. [estraverse](https://github.com/estools/estraverse)), I was unable
 to find an equivalent Python tool. So I made one myself!
 
 ## Usage
 ```python
 import json
+
 import visitor
 
-for node in visitor.traverse(json.loads(esprima_ast_string)):
-    print(node['type'])
-    # Do other work with node...
+ast = json.loads(esprima_ast_string)
+program = visitor.objectify(ast)  # visitor.Node object
+
+for node in program.traverse():
+    print(node.type)
+    # Replace all return statements with 'return null'
+    if node.type == 'ReturnStatement':
+        node.argument = None
+
+# Save modified tree back to JSON format
+with open('modified_ast.json', 'w') as f:
+    f.write(json.dumps(node.dict(), indent=2))
 ```
 
+
 ## Testing
 The AST traversal has been tested with a dozen of the most complex real-world
 JavaScript samples, including popular libraries like JQuery and Sugar and code
 served by the Alexa top 10 sites.
 
-`python3 visitor_test.py`
+To run unit tests, test coverage, linting, and type-checking:
+
+```bash
+
+$ virtualenv -p python3 venv
+$ source venv/bin/activate
+$ pip3 install -r requirements.txt
+$ coverage run visitor_test.py  # Unit tests
+$ coverage report  # Should show 100%
+$ find . -name '*.py' -not -path './venv/*' -exec pylint '{}' +
+$ mypy .  # Static type-checking
+```

requirements.txt

@@ -0,0 +1,4 @@
+coveralls
+coverage
+mypy==0.521
+pylint==1.7.2