Integrations for ASTExplorer

Author: kevin-greene-ck

README.md

@@ -28,4 +28,48 @@ $ npm run build
 
 ```
 $ npm test
-```
+```
+
+## Viewing with ASTExplorer
+
+ASTExplorer is a web app for visualizing ASTs. You type source. It shows you the resulting syntax tree based on the parser you've selected. I've included the integrations for this parser. To get that up and running you'll need to clone ASTExplorer.
+
+```
+$ git clone https://github.com/fkling/astexplorer.git
+$ cd astexplorer
+$ git submodule update --init
+$ cd website/
+```
+
+In another terminal window, (until we publish this parser) you'll need to npm link to get things to work.
+
+From the root directory of this parser, where the package.json is...
+
+```
+$ npm link
+```
+
+Then back in your terminal for ASTExplorer (from astexplorer/website)...
+
+```
+$ npm link @creditkarma/thrift-parser
+```
+
+Cool, now we need to copy some stuff into the ASTExplorer project.
+
+If the ASTExplorer project and the @creditkarma/thrift-parser project are siblings you can type this into the temrinal (from astexplorer/website)...
+
+```
+$ cp -r ../../thrift-parser/astexplorer/thrift ./src/parsers/thrift
+```
+
+You'll now need to build ASTExplorer and start the server
+
+```
+$ npm run build
+$ npm start
+```
+
+By default this will start ASTExplorer on localhost:8080
+
+There is a dropdown to select the language you want to use, choose 'Thrift IDL'

astexplorer/thrift/codeExample.txt

@@ -0,0 +1,11 @@
+namespace js test
+
+const string test = 'test'
+
+struct MyStruct {
+	1: optional string test
+}
+
+service MyService {
+	void ping()
+}

astexplorer/thrift/index.js

@@ -0,0 +1,4 @@
+export const id = 'thrift-idl';
+export const displayName = 'Thrift IDL';
+export const mimeTypes = ['text/x-thrift-idl'];
+export const fileExtension = 'thrift';

astexplorer/thrift/ts-thrift-parser.js

@@ -0,0 +1,38 @@
+import defaultParserInterface from '../utils/defaultParserInterface';
+import { parse } from '@creditkarma/thrift-parser';
+
+const ID = 'ck-thrift-parser';
+
+export default {
+  ...defaultParserInterface,
+
+  id: ID,
+  displayName: ID,
+  version: '0.0.0',
+  homepage: 'home',
+  locationProps: new Set(['location']),
+
+  loadParser(callback) {
+    callback((content) => {
+      return parse(content);
+    });
+  },
+
+  parse(parser, code) {
+    return parser(code);
+  },
+
+  getNodeName(node) {
+    return node.type;
+  },
+
+  nodeToRange({ loc }) {
+    if (loc !== null && loc !== undefined) {
+      return [ loc.start.index, loc.end.index ];
+    }
+  },
+
+  opensByDefault(node, key) {
+    return node === 'ThriftDocument' || key === 'body';
+  },
+};