New: Automatically generate TS-specific nodes (#40)

* New: Automatically generate TS-specific nodes (fixes #41)

* Fix no use before define, changed typescript src files to .ts for better development experience (#42)

Author: nzakas

README.md

@@ -1,6 +1,6 @@
 # TypeScript ESLint Parser (Experimental)
 
-An parser that converts TypeScript into an [ESTree](https://github.com/estree/estree)-compatible form so it can be used in ESLint.
+A parser that converts TypeScript into an [ESTree](https://github.com/estree/estree)-compatible form so it can be used in ESLint. The goal is to allow TypeScript files to be parsed by ESLint (though not necessarily pass all ESLint rules).
 
 **Important:** This parser is still in the very early stages and is considered experimental. There are likely a lot of bugs. You should not rely on this in a production environment yet.
 
@@ -22,23 +22,25 @@ And in your ESLint configuration file:
 
 If you're familiar with TypeScript and ESLint, and you'd like to see this project progress, please consider contributing. We need people with a good knowledge of TypeScript to ensure this parser is useful.
 
+## Reporting Bugs
+
+**Do not** file bugs about ESLint rule failures. This is expected because ESLint doesn't know anything about TypeScript syntax. It's likely that many ESLint rules will have failures as a result. Longer-term, it's likely we'll need to create a custom set of ESLint rules that are TypeScript-specific.
+
+Bugs should be filed for:
+
+1. TypeScript syntax that fails to parse.
+1. TypeScript syntax that produces an unexpected AST.
+
 ## Contributing
 
 Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/typescript-eslint-parser/issues).
 
-TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.
-
 ## Build Commands
 
 * `npm test` - run all linting and tests
 * `npm run lint` - run all linting
 
-## Development Plan
+## License
 
-* **Phase 1:** Full ES6 support, stripping out all TypeScript-specific syntax.
-* **Phase 2:** Add JSX support.
-* **Phase 3:** Add support for attaching comments.
-* **Phase 4:** Add support for types.
-* **Phase 5:** Add support for top-level TypeScript syntax.
+TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.
 
-The high-level goal is to have output that matches Espree v3.x.

lib/ast-converter.js

@@ -431,6 +431,47 @@ module.exports = function(ast, extra) {
             return convert(child, node);
         }
 
+        /**
+         * Converts a child into a type annotation. This creates an intermediary
+         * TypeAnnotation node to match what Flow does.
+         * @param {TSNode} child The TypeScript AST node to convert.
+         * @returns {ESTreeNode} The type annotation node.
+         */
+        function convertTypeAnnotation(child) {
+            var annotation = convertChild(child);
+            return {
+                type: "TypeAnnotation",
+                loc: annotation.loc,
+                range: annotation.range,
+                typeAnnotation: annotation
+            };
+        }
+
+        /**
+         * For nodes that are copied directly from the TypeScript AST into
+         * ESTree mostly as-is. The only difference is the addition of a type
+         * property instead of a kind property. Recursively copies all children.
+         * @returns {void}
+         */
+        function deeplyCopy() {
+            result.type = "TS" + SyntaxKind[node.kind];
+            Object.keys(node).filter(function(key) {
+                return !(/^(?:kind|parent|pos|end)$/.test(key));
+            }).forEach(function(key) {
+                if (key === "type") {
+                    result.typeAnnotation = convertTypeAnnotation(node.type);
+                } else {
+                    if (Array.isArray(node[key])) {
+                        result[key] = node[key].map(convertChild);
+                    } else if (node[key] && typeof node[key] === "object") {
+                        result[key] = convertChild(node[key]);
+                    } else {
+                        result[key] = node[key];
+                    }
+                }
+            });
+        }
+
         /**
          * Converts a TypeScript JSX node.tagName into an ESTree node.name
          * @param {Object} tagName  the tagName object from a JSX TSNode
@@ -636,6 +677,10 @@ module.exports = function(ast, extra) {
                     body: convertChild(node.body)
                 });
 
+                if (node.type) {
+                    result.returnType = convertTypeAnnotation(node.type);
+                }
+
                 // check for exports
                 result = fixExports(node, result, ast);
 
@@ -647,6 +692,10 @@ module.exports = function(ast, extra) {
                     id: convertChild(node.name),
                     init: convertChild(node.initializer)
                 });
+
+                if (node.type) {
+                    result.id.typeAnnotation = convertTypeAnnotation(node.type);
+                }
                 break;
 
             case SyntaxKind.VariableStatement:
@@ -821,6 +870,10 @@ module.exports = function(ast, extra) {
                         }
                     };
 
+                if (node.type) {
+                    method.returnType = convertTypeAnnotation(node.type);
+                }
+
                 if (parent.kind === SyntaxKind.ObjectLiteralExpression) {
                     assign(result, {
                         type: "Property",
@@ -936,6 +989,10 @@ module.exports = function(ast, extra) {
                     body: convertChild(node.body),
                     expression: false
                 });
+
+                if (node.type) {
+                    result.returnType = convertTypeAnnotation(node.type);
+                }
                 break;
 
             case SyntaxKind.SuperKeyword:
@@ -1010,6 +1067,11 @@ module.exports = function(ast, extra) {
                     body: convertChild(node.body),
                     expression: node.body.kind !== SyntaxKind.Block
                 });
+
+                if (node.type) {
+                    result.returnType = convertTypeAnnotation(node.type);
+                }
+
                 break;
 
             case SyntaxKind.YieldExpression:
@@ -1533,7 +1595,7 @@ module.exports = function(ast, extra) {
                 return convert(node.expression, parent);
 
             default:
-                result = null;
+                deeplyCopy();
         }
 
         return result;