Pug (fkling#465)

* feat(parsers): Pug support

* bug(pug): fixed `getNodeName` logic

* Fix eslint issues

Author: Fernando G. Vilar

README.md

@@ -52,6 +52,7 @@ The AST explorer provides following code parsers:
   - [mdxhast][]
 - PHP
   - [php-parser][]
+- [Pug][]
 - Regular Expressions:
   - [regexp-tree][]
   - [regjsparser][]
@@ -152,6 +153,7 @@ node.
 [regexp-tree]: https://github.com/DmitrySoshnikov/regexp-tree
 [regjsparser]: https://github.com/jviereck/regjsparser
 [php-parser]: https://github.com/glayzzle/php-parser
+[pug]: https://github.com/pugjs/pug
 [glimmer]: https://github.com/glimmerjs/glimmer-vm
 [handlebars]: http://handlebarsjs.com/
 [icu]: https://github.com/formatjs/formatjs/tree/master/packages/intl-messageformat-parser

website/package.json

@@ -117,6 +117,8 @@
     "prop-type": "^0.0.1",
     "prop-types": "^15.5.10",
     "pubsub-js": "^1.4.2",
+    "pug-lexer": "^4.1.0",
+    "pug-parser": "^5.0.1",
     "query-string": "5",
     "react": "16",
     "react-dom": "^16.0.1",

website/src/parsers/pug/codeExample.txt

@@ -0,0 +1,19 @@
+doctype html
+html(lang='en')
+  head
+    title Pug
+    script(type='text/javascript').
+      const foo = true;
+      let bar = function() {};
+      if (foo) {
+      bar(1 + 5)
+      }
+  body
+    h1 Pug - node template engine
+    #container.col
+      p You are amazing
+      p
+        | Pug is a terse and simple
+        | templating language with a
+        | strong focus on performance
+        | and powerful features.

website/src/parsers/pug/index.js

@@ -0,0 +1,6 @@
+import 'codemirror/mode/pug/pug';
+
+export const id = 'pug';
+export const displayName = 'Pug';
+export const mimeTypes = [];
+export const fileExtension = 'pug';

website/src/parsers/pug/pug.js

@@ -0,0 +1,60 @@
+import defaultParserInterface from '../utils/defaultParserInterface';
+import pkg from 'pug-parser/package.json';
+
+const ID = 'pug';
+
+export default {
+  ...defaultParserInterface,
+
+  id: ID,
+  displayName: ID,
+  version: pkg.version,
+  homepage: pkg.homepage || 'https://github.com/pugjs/pug',
+  typeProps: new Set(['type', 'name']),
+  locationProps: new Set(['line', 'column']),
+
+  loadParser(callback) {
+    require(['pug-lexer', 'pug-parser'], (lex, parse) => {
+      callback({ lex, parse });
+    });
+  },
+
+  parse({ lex, parse }, code, options) {
+    return parse(lex(code, {}), { src: code });
+  },
+
+  opensByDefault(node, key) {
+    switch (key) {
+      case 'block':
+      case 'nodes':
+        return true;
+    }
+  },
+
+  getNodeName(node) {
+    let { type } = node;
+    /* eslint-disable no-fallthrough */
+    switch (type) {
+      case 'Block': return '';
+      case 'Doctype': return `Doctype(${node.val})`;
+      case 'Comment': if (node.buffer) return 'Comment(buffer)';
+      case 'NamedBlock': return `Block:${node.mode}(${node.name})`;
+      case 'Code': if (node.val === 'break') return 'Code(break)';
+      case 'When': if (node.expr === 'default') return 'When(default)';
+      case 'Include':
+      case 'RawInclude':
+      case 'Extends':
+      case 'Each':
+      case 'While':
+      case 'Conditional':
+      case 'Case':
+      case 'AttributeBlock':
+      case 'Text': return type;
+      default: type = 'Attribute';
+      case 'Filter':
+      case 'Mixin': if (node.call) type = 'Mixin:call';
+      case 'Tag': return `${type}(${node.name})`;
+    }
+    /* eslint-enable no-fallthrough */
+  },
+};

website/yarn.lock

@@ -1415,6 +1415,11 @@ acorn@^7.1.0:
   resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.1.0.tgz#949d36f2c292535da602283586c2477c57eb2d6c"
   integrity sha512-kL5CuoXA/dgxlBbVrflsflzQ3PAas7RYZB52NOm/6839iVYJgKMJ3cQJD+t2i5+qFa8h3MDpEOJiS64E8JLnSQ==
 
+acorn@~4.0.2:
+  version "4.0.13"
+  resolved "https://registry.yarnpkg.com/acorn/-/acorn-4.0.13.tgz#105495ae5361d697bd195c825192e1ad7f253787"
+  integrity sha1-EFSVrlNh1pe9GVyCUZLhrX8lN4c=
+
 ajv-errors@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/ajv-errors/-/ajv-errors-1.0.1.tgz#f35986aceb91afadec4102fbd85014950cefa64d"
@@ -2998,6 +3003,13 @@ character-entities@^1.0.0:
   resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-1.2.3.tgz#bbed4a52fe7ef98cc713c6d80d9faa26916d54e6"
   integrity sha512-yB4oYSAa9yLcGyTbB4ItFwHw43QHdH129IJ5R+WvxOkWlyFnR5FAaBNnUq4mcxsTVZGh28bHoeTHMKXH1wZf3w==
 
+character-parser@^2.1.1:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/character-parser/-/character-parser-2.2.0.tgz#c7ce28f36d4bcd9744e5ffc2c5fcde1c73261fc0"
+  integrity sha1-x84o821LzZdE5f/CxfzeHHMmH8A=
+  dependencies:
+    is-regex "^1.0.3"
+
 character-reference-invalid@^1.0.0:
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-1.1.3.tgz#1647f4f726638d3ea4a750cf5d1975c1c7919a85"
@@ -5857,6 +5869,14 @@ is-directory@^0.3.1:
   resolved "https://registry.yarnpkg.com/is-directory/-/is-directory-0.3.1.tgz#61339b6f2475fc772fd9c9d83f5c8575dc154ae1"
   integrity sha1-YTObbyR1/Hcv2cnYP1yFddwVSuE=
 
+is-expression@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/is-expression/-/is-expression-3.0.0.tgz#39acaa6be7fd1f3471dc42c7416e61c24317ac9f"
+  integrity sha1-Oayqa+f9HzRx3ELHQW5hwkMXrJ8=
+  dependencies:
+    acorn "~4.0.2"
+    object-assign "^4.0.1"
+
 is-extendable@^0.1.0, is-extendable@^0.1.1:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89"
@@ -5984,7 +6004,7 @@ is-property@^1.0.0, is-property@^1.0.2:
   resolved "https://registry.yarnpkg.com/is-property/-/is-property-1.0.2.tgz#57fe1c4e48474edd65b09911f26b1cd4095dda84"
   integrity sha1-V/4cTkhHTt1lsJkR8msc1Ald2oQ=
 
-is-regex@^1.0.4:
+is-regex@^1.0.3, is-regex@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/is-regex/-/is-regex-1.0.4.tgz#5517489b547091b0930e095654ced25ee97e9491"
   integrity sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=
@@ -7951,6 +7971,28 @@ pubsub-js@^1.4.2:
   resolved "https://registry.yarnpkg.com/pubsub-js/-/pubsub-js-1.7.0.tgz#eca97f9a4217bef62b2d3aaa1552005260cc2e49"
   integrity sha512-Pb68P9qFZxnvDipHMuj9oT1FoIgBcXJ9C9eWdHCLZAnulaUoJ3+Y87RhGMYilWpun6DMWVmvK70T4RP4drZMSA==
 
+pug-error@^1.3.3:
+  version "1.3.3"
+  resolved "https://registry.yarnpkg.com/pug-error/-/pug-error-1.3.3.tgz#f342fb008752d58034c185de03602dd9ffe15fa6"
+  integrity sha512-qE3YhESP2mRAWMFJgKdtT5D7ckThRScXRwkfo+Erqga7dyJdY3ZquspprMCj/9sJ2ijm5hXFWQE/A3l4poMWiQ==
+
+pug-lexer@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/pug-lexer/-/pug-lexer-4.1.0.tgz#531cde48c7c0b1fcbbc2b85485c8665e31489cfd"
+  integrity sha512-i55yzEBtjm0mlplW4LoANq7k3S8gDdfC6+LThGEvsK4FuobcKfDAwt6V4jKPH9RtiE3a2Akfg5UpafZ1OksaPA==
+  dependencies:
+    character-parser "^2.1.1"
+    is-expression "^3.0.0"
+    pug-error "^1.3.3"
+
+pug-parser@^5.0.1:
+  version "5.0.1"
+  resolved "https://registry.yarnpkg.com/pug-parser/-/pug-parser-5.0.1.tgz#03e7ada48b6840bd3822f867d7d90f842d0ffdc9"
+  integrity sha512-nGHqK+w07p5/PsPIyzkTQfzlYfuqoiGjaoqHv1LjOv2ZLXmGX1O+4Vcvps+P4LhxZ3drYSljjq4b+Naid126wA==
+  dependencies:
+    pug-error "^1.3.3"
+    token-stream "0.0.1"
+
 pump@^2.0.0:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/pump/-/pump-2.0.1.tgz#12399add6e4cf7526d973cbc8b5ce2e2908b3909"
@@ -9550,6 +9592,11 @@ to-regex@^3.0.1, to-regex@^3.0.2:
     regex-not "^1.0.2"
     safe-regex "^1.1.0"
 
+[email protected]:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/token-stream/-/token-stream-0.0.1.tgz#ceeefc717a76c4316f126d0b9dbaa55d7e7df01a"
+  integrity sha1-zu78cXp2xDFvEm0LnbqlXX598Bo=
+
 toposort@^1.0.0:
   version "1.0.7"
   resolved "https://registry.yarnpkg.com/toposort/-/toposort-1.0.7.tgz#2e68442d9f64ec720b8cc89e6443ac6caa950029"