@webex/jsdoctrinetest 3.0.0-beta.9 → 3.0.0-beta.91

package/README.md

@@ -28,8 +28,8 @@ Assuming your source code is in `./src` and you've got code like
  * @returns {boolean}
  */
 exports.fn = function fn() {
-  return true
-}
+  return true;
+};
 ```
 
 The following command will create a run a mocha spec asserting the result of `fn()` is `true`.

package/dist/assertions/literal.js

@@ -1,96 +1,76 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.build = build;
 exports.test = test;
-
 var _parseInt2 = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/parse-int"));
-
 var _isNan = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/number/is-nan"));
-
 var _parseFloat2 = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/parse-float"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/typeof"));
-
 var _template = _interopRequireDefault(require("@babel/template"));
-
 var _types = require("@babel/types");
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+
 var pattern = /^\s*?=>( async)?\s*/;
 var tpl = (0, _template.default)("\n  (function() {\n    var assert = require('assert');\n    assert.equal(result, ASSERTION);\n  })();\n");
+
 /**
  * Indicates whether the specified value defines a literal assertion
  * @param {string} value
  * @returns {Boolean}
  */
-
 function test(value) {
   return pattern.test(value);
 }
+
 /**
  * Builds a literal assertion
  * @param {string} value
  * @returns {ast}
  */
-
-
 function build(value) {
   return tpl({
     ASSERTION: literal(value.replace(pattern, ''))
   });
 }
+
 /**
  * Coerces a string into a type
  * @param {string} l
  * @returns {Literal}
  */
-
-
 function literal(l) {
   /* eslint complexity: [0] */
   // eslint-disable-next-line prefer-const
-  var f, i;
-
+  var f;
+  var i;
   switch ((0, _typeof2.default)(l)) {
     case 'boolean':
       return (0, _types.booleanLiteral)(l);
-
     case 'number':
       return (0, _types.numericLiteral)(l);
-
     case 'string':
       if (l === 'true') {
         return (0, _types.booleanLiteral)(true);
       }
-
       if (l === 'false') {
         return (0, _types.booleanLiteral)(false);
       }
-
       i = (0, _parseInt2.default)(l, 10);
-
       if (!(0, _isNan.default)(i)) {
         return (0, _types.numericLiteral)(i);
       }
-
       f = (0, _parseFloat2.default)(l);
-
       if (!(0, _isNan.default)(f)) {
         return (0, _types.numericLiteral)(f);
       }
-
       return (0, _types.stringLiteral)(l);
-
     default:
       throw new Error('Unsupported literal type');
   }

package/dist/assertions/literal.js.map

@@ -1 +1 @@
-{"version":3,"names":["pattern","tpl","template","test","value","build","ASSERTION","literal","replace","l","f","i","booleanLiteral","numericLiteral","stringLiteral","Error"],"sources":["literal.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport template from '@babel/template';\nimport {\n  booleanLiteral,\n  numericLiteral,\n  stringLiteral\n} from '@babel/types';\n\nconst pattern = /^\\s*?=>( async)?\\s*/;\n\nconst tpl = template(`\n  (function() {\n    var assert = require('assert');\n    assert.equal(result, ASSERTION);\n  })();\n`);\n\n/**\n * Indicates whether the specified value defines a literal assertion\n * @param {string} value\n * @returns {Boolean}\n */\nexport function test(value) {\n  return pattern.test(value);\n}\n\n/**\n * Builds a literal assertion\n * @param {string} value\n * @returns {ast}\n */\nexport function build(value) {\n  return tpl({\n    ASSERTION: literal(value.replace(pattern, ''))\n  });\n}\n\n/**\n * Coerces a string into a type\n * @param {string} l\n * @returns {Literal}\n */\nfunction literal(l) {\n  /* eslint complexity: [0] */\n  // eslint-disable-next-line prefer-const\n  let f, i;\n\n  switch (typeof l) {\n    case 'boolean':\n      return booleanLiteral(l);\n    case 'number':\n      return numericLiteral(l);\n    case 'string':\n      if (l === 'true') {\n        return booleanLiteral(true);\n      }\n      if (l === 'false') {\n        return booleanLiteral(false);\n      }\n      i = parseInt(l, 10);\n      if (!Number.isNaN(i)) {\n        return numericLiteral(i);\n      }\n      f = parseFloat(l);\n      if (!Number.isNaN(f)) {\n        return numericLiteral(f);\n      }\n\n      return stringLiteral(l);\n    default:\n      throw new Error('Unsupported literal type');\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AALA;AACA;AACA;AASA,IAAMA,OAAO,GAAG,qBAAhB;AAEA,IAAMC,GAAG,GAAG,IAAAC,iBAAA,4GAAZ;AAOA;AACA;AACA;AACA;AACA;;AACO,SAASC,IAAT,CAAcC,KAAd,EAAqB;EAC1B,OAAOJ,OAAO,CAACG,IAAR,CAAaC,KAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASC,KAAT,CAAeD,KAAf,EAAsB;EAC3B,OAAOH,GAAG,CAAC;IACTK,SAAS,EAAEC,OAAO,CAACH,KAAK,CAACI,OAAN,CAAcR,OAAd,EAAuB,EAAvB,CAAD;EADT,CAAD,CAAV;AAGD;AAED;AACA;AACA;AACA;AACA;;;AACA,SAASO,OAAT,CAAiBE,CAAjB,EAAoB;EAClB;EACA;EACA,IAAIC,CAAJ,EAAOC,CAAP;;EAEA,8BAAeF,CAAf;IACE,KAAK,SAAL;MACE,OAAO,IAAAG,qBAAA,EAAeH,CAAf,CAAP;;IACF,KAAK,QAAL;MACE,OAAO,IAAAI,qBAAA,EAAeJ,CAAf,CAAP;;IACF,KAAK,QAAL;MACE,IAAIA,CAAC,KAAK,MAAV,EAAkB;QAChB,OAAO,IAAAG,qBAAA,EAAe,IAAf,CAAP;MACD;;MACD,IAAIH,CAAC,KAAK,OAAV,EAAmB;QACjB,OAAO,IAAAG,qBAAA,EAAe,KAAf,CAAP;MACD;;MACDD,CAAC,GAAG,wBAASF,CAAT,EAAY,EAAZ,CAAJ;;MACA,IAAI,CAAC,oBAAaE,CAAb,CAAL,EAAsB;QACpB,OAAO,IAAAE,qBAAA,EAAeF,CAAf,CAAP;MACD;;MACDD,CAAC,GAAG,0BAAWD,CAAX,CAAJ;;MACA,IAAI,CAAC,oBAAaC,CAAb,CAAL,EAAsB;QACpB,OAAO,IAAAG,qBAAA,EAAeH,CAAf,CAAP;MACD;;MAED,OAAO,IAAAI,oBAAA,EAAcL,CAAd,CAAP;;IACF;MACE,MAAM,IAAIM,KAAJ,CAAU,0BAAV,CAAN;EAvBJ;AAyBD"}
+{"version":3,"names":["pattern","tpl","template","test","value","build","ASSERTION","literal","replace","l","f","i","booleanLiteral","numericLiteral","stringLiteral","Error"],"sources":["literal.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport template from '@babel/template';\nimport {booleanLiteral, numericLiteral, stringLiteral} from '@babel/types';\n\nconst pattern = /^\\s*?=>( async)?\\s*/;\n\nconst tpl = template(`\n  (function() {\n    var assert = require('assert');\n    assert.equal(result, ASSERTION);\n  })();\n`);\n\n/**\n * Indicates whether the specified value defines a literal assertion\n * @param {string} value\n * @returns {Boolean}\n */\nexport function test(value) {\n  return pattern.test(value);\n}\n\n/**\n * Builds a literal assertion\n * @param {string} value\n * @returns {ast}\n */\nexport function build(value) {\n  return tpl({\n    ASSERTION: literal(value.replace(pattern, '')),\n  });\n}\n\n/**\n * Coerces a string into a type\n * @param {string} l\n * @returns {Literal}\n */\nfunction literal(l) {\n  /* eslint complexity: [0] */\n  // eslint-disable-next-line prefer-const\n  let f;\n  let i;\n\n  switch (typeof l) {\n    case 'boolean':\n      return booleanLiteral(l);\n    case 'number':\n      return numericLiteral(l);\n    case 'string':\n      if (l === 'true') {\n        return booleanLiteral(true);\n      }\n      if (l === 'false') {\n        return booleanLiteral(false);\n      }\n      i = parseInt(l, 10);\n      if (!Number.isNaN(i)) {\n        return numericLiteral(i);\n      }\n      f = parseFloat(l);\n      if (!Number.isNaN(f)) {\n        return numericLiteral(f);\n      }\n\n      return stringLiteral(l);\n    default:\n      throw new Error('Unsupported literal type');\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAIA;AACA;AALA;AACA;AACA;;AAKA,IAAMA,OAAO,GAAG,qBAAqB;AAErC,IAAMC,GAAG,GAAG,IAAAC,iBAAQ,4GAKlB;;AAEF;AACA;AACA;AACA;AACA;AACO,SAASC,IAAI,CAACC,KAAK,EAAE;EAC1B,OAAOJ,OAAO,CAACG,IAAI,CAACC,KAAK,CAAC;AAC5B;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,KAAK,CAACD,KAAK,EAAE;EAC3B,OAAOH,GAAG,CAAC;IACTK,SAAS,EAAEC,OAAO,CAACH,KAAK,CAACI,OAAO,CAACR,OAAO,EAAE,EAAE,CAAC;EAC/C,CAAC,CAAC;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,OAAO,CAACE,CAAC,EAAE;EAClB;EACA;EACA,IAAIC,CAAC;EACL,IAAIC,CAAC;EAEL,8BAAeF,CAAC;IACd,KAAK,SAAS;MACZ,OAAO,IAAAG,qBAAc,EAACH,CAAC,CAAC;IAC1B,KAAK,QAAQ;MACX,OAAO,IAAAI,qBAAc,EAACJ,CAAC,CAAC;IAC1B,KAAK,QAAQ;MACX,IAAIA,CAAC,KAAK,MAAM,EAAE;QAChB,OAAO,IAAAG,qBAAc,EAAC,IAAI,CAAC;MAC7B;MACA,IAAIH,CAAC,KAAK,OAAO,EAAE;QACjB,OAAO,IAAAG,qBAAc,EAAC,KAAK,CAAC;MAC9B;MACAD,CAAC,GAAG,wBAASF,CAAC,EAAE,EAAE,CAAC;MACnB,IAAI,CAAC,oBAAaE,CAAC,CAAC,EAAE;QACpB,OAAO,IAAAE,qBAAc,EAACF,CAAC,CAAC;MAC1B;MACAD,CAAC,GAAG,0BAAWD,CAAC,CAAC;MACjB,IAAI,CAAC,oBAAaC,CAAC,CAAC,EAAE;QACpB,OAAO,IAAAG,qBAAc,EAACH,CAAC,CAAC;MAC1B;MAEA,OAAO,IAAAI,oBAAa,EAACL,CAAC,CAAC;IACzB;MACE,MAAM,IAAIM,KAAK,CAAC,0BAA0B,CAAC;EAAC;AAElD"}

package/dist/extract.js

@@ -1,25 +1,16 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = extract;
-
 var _fs = _interopRequireDefault(require("fs"));
-
 var _traverse = _interopRequireDefault(require("@babel/traverse"));
-
 var _doctrine = _interopRequireDefault(require("doctrine"));
-
 var _types = require("@babel/types");
-
 var _parse = _interopRequireDefault(require("./parse"));
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -45,7 +36,6 @@ function extract(transform, filename) {
   var code = _fs.default.readFileSync(filename, {
     encoding: 'utf8'
   });
-
   var ast = (0, _parse.default)(code, {
     sourceFilename: filename
   });
@@ -61,7 +51,6 @@ function extract(transform, filename) {
             recoverable: true,
             lineNumbers: true
           });
-
           if (result.tags) {
             result.tags.forEach(function (tag) {
               if (tag.title === 'example') {
@@ -83,7 +72,6 @@ function extract(transform, filename) {
           if (done) {
             return;
           }
-
           path.pushContainer('body', results);
           done = true;
         }
@@ -92,22 +80,19 @@ function extract(transform, filename) {
   });
   return ast;
 }
+
 /**
  * Extracts the name from the specified node
  * @param {Node} node
  * @returns {string}
  */
-
-
 function getNodeName(node) {
   if (node.id) {
     return node.id.name;
   }
-
   if (node.key) {
     return node.key.name;
   }
-
   throw new Error('Could not find name for node');
 }
 /**
@@ -115,20 +100,19 @@ function getNodeName(node) {
  * @param {CommentBlock} comment
  * @returns {Boolean}
  */
-
-
 function isJSDocComment(comment) {
   var asterisks = comment.value.match(/^(\*+)/);
-
   if (comment.value.startsWith('/*') && comment.value.endsWith('*/')) {
     return false;
-  } // eslint-disable-next-line
-
+  }
 
-  return (comment.type === "CommentBlock" || // estree
   // eslint-disable-next-line
-  comment.type === "Block" // get-comments / traditional
+  return (comment.type === 'CommentBlock' ||
+  // estree
+  // eslint-disable-next-line
+  comment.type === "Block") &&
+  // get-comments / traditional
   // eslint-disable-next-line
-  ) && asterisks && asterisks[1].length === 1;
+  asterisks && asterisks[1].length === 1;
 }
 //# sourceMappingURL=extract.js.map

package/dist/extract.js.map

@@ -1 +1 @@
-{"version":3,"names":["extract","transform","filename","code","fs","readFileSync","encoding","ast","parse","sourceFilename","results","done","traverse","enter","path","node","leadingComments","filter","isJSDocComment","forEach","comment","result","doctrine","value","unwrap","sloppy","recoverable","lineNumbers","tags","tag","title","push","description","name","getNodeName","loc","type","Program","exit","isProgram","pushContainer","id","key","Error","asterisks","match","startsWith","endsWith","length"],"sources":["extract.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n\nimport fs from 'fs';\n\nimport traverse from '@babel/traverse';\nimport doctrine from 'doctrine';\nimport {isProgram} from '@babel/types';\n\nimport parse from './parse';\n/**\n * transform function which operates on each discovered example block\n * @callback transformCallback\n * @param {Object} options\n * @param {ast} options.comment\n * @param {string} options.name\n * @param {string} options.filename\n * @param {string} options.type\n */\n\n/**\n * Extracts comment blocks from the source code in the specified file\n * @param {transformCallback} transform\n * @param {string} filename\n * @returns {Array<ast>}\n */\nexport default function extract(transform, filename) {\n  // eslint-disable-next-line no-sync\n  const code = fs.readFileSync(filename, {encoding: 'utf8'});\n\n  const ast = parse(code, {sourceFilename: filename});\n\n  const results = [];\n\n  let done = false;\n\n  traverse(ast, {\n    enter(path) {\n      if (path.node.leadingComments) {\n        path.node.leadingComments\n          .filter(isJSDocComment)\n          .forEach((comment) => {\n            const result = doctrine.parse(comment.value, {\n              unwrap: true,\n              sloppy: true,\n              recoverable: true,\n              lineNumbers: true\n            });\n\n            if (result.tags) {\n              result.tags.forEach((tag) => {\n                if (tag.title === 'example') {\n                  results.push(transform({\n                    comment: tag.description,\n                    name: getNodeName(path.node),\n                    filename: path.node.loc.filename,\n                    type: path.node.type\n                  }));\n                }\n              });\n            }\n          });\n      }\n    },\n    Program: {\n      exit(path) {\n        if (isProgram(path)) {\n          if (done) {\n            return;\n          }\n          path.pushContainer('body', results);\n          done = true;\n        }\n      }\n    }\n  });\n\n  return ast;\n}\n\n/**\n * Extracts the name from the specified node\n * @param {Node} node\n * @returns {string}\n */\nfunction getNodeName(node) {\n  if (node.id) {\n    return node.id.name;\n  }\n\n  if (node.key) {\n    return node.key.name;\n  }\n\n  throw new Error('Could not find name for node');\n}\n/**\n * Indicates if the specified comment block is a doc block\n * @param {CommentBlock} comment\n * @returns {Boolean}\n */\nfunction isJSDocComment(comment) {\n  const asterisks = comment.value.match(/^(\\*+)/);\n\n  if (comment.value.startsWith('/*') && comment.value.endsWith('*/')) {\n    return false;\n  }\n\n  // eslint-disable-next-line\n  return (comment.type === `CommentBlock` || // estree\n    // eslint-disable-next-line\n    comment.type === `Block`) // get-comments / traditional\n    // eslint-disable-next-line\n    && asterisks && asterisks[ 1 ].length === 1;\n}\n"],"mappings":";;;;;;;;;;;;AAKA;;AAEA;;AACA;;AACA;;AAEA;;AAXA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,OAAT,CAAiBC,SAAjB,EAA4BC,QAA5B,EAAsC;EACnD;EACA,IAAMC,IAAI,GAAGC,WAAA,CAAGC,YAAH,CAAgBH,QAAhB,EAA0B;IAACI,QAAQ,EAAE;EAAX,CAA1B,CAAb;;EAEA,IAAMC,GAAG,GAAG,IAAAC,cAAA,EAAML,IAAN,EAAY;IAACM,cAAc,EAAEP;EAAjB,CAAZ,CAAZ;EAEA,IAAMQ,OAAO,GAAG,EAAhB;EAEA,IAAIC,IAAI,GAAG,KAAX;EAEA,IAAAC,iBAAA,EAASL,GAAT,EAAc;IACZM,KADY,iBACNC,IADM,EACA;MACV,IAAIA,IAAI,CAACC,IAAL,CAAUC,eAAd,EAA+B;QAC7BF,IAAI,CAACC,IAAL,CAAUC,eAAV,CACGC,MADH,CACUC,cADV,EAEGC,OAFH,CAEW,UAACC,OAAD,EAAa;UACpB,IAAMC,MAAM,GAAGC,iBAAA,CAASd,KAAT,CAAeY,OAAO,CAACG,KAAvB,EAA8B;YAC3CC,MAAM,EAAE,IADmC;YAE3CC,MAAM,EAAE,IAFmC;YAG3CC,WAAW,EAAE,IAH8B;YAI3CC,WAAW,EAAE;UAJ8B,CAA9B,CAAf;;UAOA,IAAIN,MAAM,CAACO,IAAX,EAAiB;YACfP,MAAM,CAACO,IAAP,CAAYT,OAAZ,CAAoB,UAACU,GAAD,EAAS;cAC3B,IAAIA,GAAG,CAACC,KAAJ,KAAc,SAAlB,EAA6B;gBAC3BpB,OAAO,CAACqB,IAAR,CAAa9B,SAAS,CAAC;kBACrBmB,OAAO,EAAES,GAAG,CAACG,WADQ;kBAErBC,IAAI,EAAEC,WAAW,CAACpB,IAAI,CAACC,IAAN,CAFI;kBAGrBb,QAAQ,EAAEY,IAAI,CAACC,IAAL,CAAUoB,GAAV,CAAcjC,QAHH;kBAIrBkC,IAAI,EAAEtB,IAAI,CAACC,IAAL,CAAUqB;gBAJK,CAAD,CAAtB;cAMD;YACF,CATD;UAUD;QACF,CAtBH;MAuBD;IACF,CA3BW;IA4BZC,OAAO,EAAE;MACPC,IADO,gBACFxB,IADE,EACI;QACT,IAAI,IAAAyB,gBAAA,EAAUzB,IAAV,CAAJ,EAAqB;UACnB,IAAIH,IAAJ,EAAU;YACR;UACD;;UACDG,IAAI,CAAC0B,aAAL,CAAmB,MAAnB,EAA2B9B,OAA3B;UACAC,IAAI,GAAG,IAAP;QACD;MACF;IATM;EA5BG,CAAd;EAyCA,OAAOJ,GAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACA,SAAS2B,WAAT,CAAqBnB,IAArB,EAA2B;EACzB,IAAIA,IAAI,CAAC0B,EAAT,EAAa;IACX,OAAO1B,IAAI,CAAC0B,EAAL,CAAQR,IAAf;EACD;;EAED,IAAIlB,IAAI,CAAC2B,GAAT,EAAc;IACZ,OAAO3B,IAAI,CAAC2B,GAAL,CAAST,IAAhB;EACD;;EAED,MAAM,IAAIU,KAAJ,CAAU,8BAAV,CAAN;AACD;AACD;AACA;AACA;AACA;AACA;;;AACA,SAASzB,cAAT,CAAwBE,OAAxB,EAAiC;EAC/B,IAAMwB,SAAS,GAAGxB,OAAO,CAACG,KAAR,CAAcsB,KAAd,CAAoB,QAApB,CAAlB;;EAEA,IAAIzB,OAAO,CAACG,KAAR,CAAcuB,UAAd,CAAyB,IAAzB,KAAkC1B,OAAO,CAACG,KAAR,CAAcwB,QAAd,CAAuB,IAAvB,CAAtC,EAAoE;IAClE,OAAO,KAAP;EACD,CAL8B,CAO/B;;;EACA,OAAO,CAAC3B,OAAO,CAACgB,IAAR,uBAAmC;EACzC;EACAhB,OAAO,CAACgB,IAAR,YAFK,CAEqB;EAC1B;EAHK,KAIFQ,SAJE,IAIWA,SAAS,CAAE,CAAF,CAAT,CAAeI,MAAf,KAA0B,CAJ5C;AAKD"}
+{"version":3,"names":["extract","transform","filename","code","fs","readFileSync","encoding","ast","parse","sourceFilename","results","done","traverse","enter","path","node","leadingComments","filter","isJSDocComment","forEach","comment","result","doctrine","value","unwrap","sloppy","recoverable","lineNumbers","tags","tag","title","push","description","name","getNodeName","loc","type","Program","exit","isProgram","pushContainer","id","key","Error","asterisks","match","startsWith","endsWith","length"],"sources":["extract.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport fs from 'fs';\n\nimport traverse from '@babel/traverse';\nimport doctrine from 'doctrine';\nimport {isProgram} from '@babel/types';\n\nimport parse from './parse';\n/**\n * transform function which operates on each discovered example block\n * @callback transformCallback\n * @param {Object} options\n * @param {ast} options.comment\n * @param {string} options.name\n * @param {string} options.filename\n * @param {string} options.type\n */\n\n/**\n * Extracts comment blocks from the source code in the specified file\n * @param {transformCallback} transform\n * @param {string} filename\n * @returns {Array<ast>}\n */\nexport default function extract(transform, filename) {\n  // eslint-disable-next-line no-sync\n  const code = fs.readFileSync(filename, {encoding: 'utf8'});\n\n  const ast = parse(code, {sourceFilename: filename});\n\n  const results = [];\n\n  let done = false;\n\n  traverse(ast, {\n    enter(path) {\n      if (path.node.leadingComments) {\n        path.node.leadingComments.filter(isJSDocComment).forEach((comment) => {\n          const result = doctrine.parse(comment.value, {\n            unwrap: true,\n            sloppy: true,\n            recoverable: true,\n            lineNumbers: true,\n          });\n\n          if (result.tags) {\n            result.tags.forEach((tag) => {\n              if (tag.title === 'example') {\n                results.push(\n                  transform({\n                    comment: tag.description,\n                    name: getNodeName(path.node),\n                    filename: path.node.loc.filename,\n                    type: path.node.type,\n                  })\n                );\n              }\n            });\n          }\n        });\n      }\n    },\n    Program: {\n      exit(path) {\n        if (isProgram(path)) {\n          if (done) {\n            return;\n          }\n          path.pushContainer('body', results);\n          done = true;\n        }\n      },\n    },\n  });\n\n  return ast;\n}\n\n/**\n * Extracts the name from the specified node\n * @param {Node} node\n * @returns {string}\n */\nfunction getNodeName(node) {\n  if (node.id) {\n    return node.id.name;\n  }\n\n  if (node.key) {\n    return node.key.name;\n  }\n\n  throw new Error('Could not find name for node');\n}\n/**\n * Indicates if the specified comment block is a doc block\n * @param {CommentBlock} comment\n * @returns {Boolean}\n */\nfunction isJSDocComment(comment) {\n  const asterisks = comment.value.match(/^(\\*+)/);\n\n  if (comment.value.startsWith('/*') && comment.value.endsWith('*/')) {\n    return false;\n  }\n\n  // eslint-disable-next-line\n  return (\n    (comment.type === 'CommentBlock' || // estree\n      // eslint-disable-next-line\n      comment.type === `Block`) && // get-comments / traditional\n    // eslint-disable-next-line\n    asterisks &&\n    asterisks[1].length === 1\n  );\n}\n"],"mappings":";;;;;;;;AAIA;AAEA;AACA;AACA;AAEA;AAVA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,OAAO,CAACC,SAAS,EAAEC,QAAQ,EAAE;EACnD;EACA,IAAMC,IAAI,GAAGC,WAAE,CAACC,YAAY,CAACH,QAAQ,EAAE;IAACI,QAAQ,EAAE;EAAM,CAAC,CAAC;EAE1D,IAAMC,GAAG,GAAG,IAAAC,cAAK,EAACL,IAAI,EAAE;IAACM,cAAc,EAAEP;EAAQ,CAAC,CAAC;EAEnD,IAAMQ,OAAO,GAAG,EAAE;EAElB,IAAIC,IAAI,GAAG,KAAK;EAEhB,IAAAC,iBAAQ,EAACL,GAAG,EAAE;IACZM,KAAK,iBAACC,IAAI,EAAE;MACV,IAAIA,IAAI,CAACC,IAAI,CAACC,eAAe,EAAE;QAC7BF,IAAI,CAACC,IAAI,CAACC,eAAe,CAACC,MAAM,CAACC,cAAc,CAAC,CAACC,OAAO,CAAC,UAACC,OAAO,EAAK;UACpE,IAAMC,MAAM,GAAGC,iBAAQ,CAACd,KAAK,CAACY,OAAO,CAACG,KAAK,EAAE;YAC3CC,MAAM,EAAE,IAAI;YACZC,MAAM,EAAE,IAAI;YACZC,WAAW,EAAE,IAAI;YACjBC,WAAW,EAAE;UACf,CAAC,CAAC;UAEF,IAAIN,MAAM,CAACO,IAAI,EAAE;YACfP,MAAM,CAACO,IAAI,CAACT,OAAO,CAAC,UAACU,GAAG,EAAK;cAC3B,IAAIA,GAAG,CAACC,KAAK,KAAK,SAAS,EAAE;gBAC3BpB,OAAO,CAACqB,IAAI,CACV9B,SAAS,CAAC;kBACRmB,OAAO,EAAES,GAAG,CAACG,WAAW;kBACxBC,IAAI,EAAEC,WAAW,CAACpB,IAAI,CAACC,IAAI,CAAC;kBAC5Bb,QAAQ,EAAEY,IAAI,CAACC,IAAI,CAACoB,GAAG,CAACjC,QAAQ;kBAChCkC,IAAI,EAAEtB,IAAI,CAACC,IAAI,CAACqB;gBAClB,CAAC,CAAC,CACH;cACH;YACF,CAAC,CAAC;UACJ;QACF,CAAC,CAAC;MACJ;IACF,CAAC;IACDC,OAAO,EAAE;MACPC,IAAI,gBAACxB,IAAI,EAAE;QACT,IAAI,IAAAyB,gBAAS,EAACzB,IAAI,CAAC,EAAE;UACnB,IAAIH,IAAI,EAAE;YACR;UACF;UACAG,IAAI,CAAC0B,aAAa,CAAC,MAAM,EAAE9B,OAAO,CAAC;UACnCC,IAAI,GAAG,IAAI;QACb;MACF;IACF;EACF,CAAC,CAAC;EAEF,OAAOJ,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA,SAAS2B,WAAW,CAACnB,IAAI,EAAE;EACzB,IAAIA,IAAI,CAAC0B,EAAE,EAAE;IACX,OAAO1B,IAAI,CAAC0B,EAAE,CAACR,IAAI;EACrB;EAEA,IAAIlB,IAAI,CAAC2B,GAAG,EAAE;IACZ,OAAO3B,IAAI,CAAC2B,GAAG,CAACT,IAAI;EACtB;EAEA,MAAM,IAAIU,KAAK,CAAC,8BAA8B,CAAC;AACjD;AACA;AACA;AACA;AACA;AACA;AACA,SAASzB,cAAc,CAACE,OAAO,EAAE;EAC/B,IAAMwB,SAAS,GAAGxB,OAAO,CAACG,KAAK,CAACsB,KAAK,CAAC,QAAQ,CAAC;EAE/C,IAAIzB,OAAO,CAACG,KAAK,CAACuB,UAAU,CAAC,IAAI,CAAC,IAAI1B,OAAO,CAACG,KAAK,CAACwB,QAAQ,CAAC,IAAI,CAAC,EAAE;IAClE,OAAO,KAAK;EACd;;EAEA;EACA,OACE,CAAC3B,OAAO,CAACgB,IAAI,KAAK,cAAc;EAAI;EAClC;EACAhB,OAAO,CAACgB,IAAI,YAAY;EAAK;EAC/B;EACAQ,SAAS,IACTA,SAAS,CAAC,CAAC,CAAC,CAACI,MAAM,KAAK,CAAC;AAE7B"}

package/dist/index.js

@@ -1,64 +1,50 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 var _path = _interopRequireDefault(require("path"));
-
 var _generator = _interopRequireDefault(require("@babel/generator"));
-
 var _extract = _interopRequireDefault(require("./extract"));
-
 var _transform = _interopRequireDefault(require("./transform"));
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
 /* eslint require-jsdoc: [0] */
-
 /* eslint no-console: [0] */
+
 function isNodeModule(filename) {
   return filename.includes('node_modules') && !filename.includes('packages/node_modules');
 }
-
 function inject(module, filename) {
   var _generate = (0, _generator.default)((0, _extract.default)(_transform.default, filename), {
-    compact: false,
-    quotes: 'single'
-  }),
-      code = _generate.code;
-
+      compact: false,
+      quotes: 'single'
+    }),
+    code = _generate.code;
   if (process.env.JSDOCTRINETEST_VERBOSE) {
     console.log(filename);
     console.log(code);
     console.log();
   }
-
   module._compile(code, filename);
 }
-
 function enableSpecInjection() {
   var dir;
   var load = require.extensions['.js'];
-
   require.extensions['.js'] = function loadWithSpecs(m, filename) {
     if (isNodeModule(filename)) {
       return load(m, filename);
-    } // this is really janky, but so far seems to properly ensure we only load
+    }
+    // this is really janky, but so far seems to properly ensure we only load
     // files in the directories specified to mocha
-
-
     if (!dir) {
       dir = _path.default.dirname(filename);
     }
-
     if (!filename.includes(dir)) {
       return load(m, filename);
     }
-
     return inject(m, filename);
   };
 }
-
 enableSpecInjection();
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["isNodeModule","filename","includes","inject","module","generate","extract","transform","compact","quotes","code","process","env","JSDOCTRINETEST_VERBOSE","console","log","_compile","enableSpecInjection","dir","load","require","extensions","loadWithSpecs","m","path","dirname"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/* eslint require-jsdoc: [0] */\n/* eslint no-console: [0] */\n\nimport path from 'path';\n\nimport generate from '@babel/generator';\n\nimport extract from './extract';\nimport transform from './transform';\n\nfunction isNodeModule(filename) {\n  return filename.includes('node_modules') && !filename.includes('packages/node_modules');\n}\n\nfunction inject(module, filename) {\n  const {code} = generate(extract(transform, filename), {\n    compact: false,\n    quotes: 'single'\n  });\n\n  if (process.env.JSDOCTRINETEST_VERBOSE) {\n    console.log(filename);\n    console.log(code);\n    console.log();\n  }\n  module._compile(code, filename);\n}\n\nfunction enableSpecInjection() {\n  let dir;\n  const load = require.extensions['.js'];\n\n  require.extensions['.js'] = function loadWithSpecs(m, filename) {\n    if (isNodeModule(filename)) {\n      return load(m, filename);\n    }\n    // this is really janky, but so far seems to properly ensure we only load\n    // files in the directories specified to mocha\n    if (!dir) {\n      dir = path.dirname(filename);\n    }\n\n    if (!filename.includes(dir)) {\n      return load(m, filename);\n    }\n\n    return inject(m, filename);\n  };\n}\n\nenableSpecInjection();\n"],"mappings":";;;;AAOA;;AAEA;;AAEA;;AACA;;AAZA;AACA;AACA;;AAEA;;AACA;AASA,SAASA,YAAT,CAAsBC,QAAtB,EAAgC;EAC9B,OAAOA,QAAQ,CAACC,QAAT,CAAkB,cAAlB,KAAqC,CAACD,QAAQ,CAACC,QAAT,CAAkB,uBAAlB,CAA7C;AACD;;AAED,SAASC,MAAT,CAAgBC,MAAhB,EAAwBH,QAAxB,EAAkC;EAChC,gBAAe,IAAAI,kBAAA,EAAS,IAAAC,gBAAA,EAAQC,kBAAR,EAAmBN,QAAnB,CAAT,EAAuC;IACpDO,OAAO,EAAE,KAD2C;IAEpDC,MAAM,EAAE;EAF4C,CAAvC,CAAf;EAAA,IAAOC,IAAP,aAAOA,IAAP;;EAKA,IAAIC,OAAO,CAACC,GAAR,CAAYC,sBAAhB,EAAwC;IACtCC,OAAO,CAACC,GAAR,CAAYd,QAAZ;IACAa,OAAO,CAACC,GAAR,CAAYL,IAAZ;IACAI,OAAO,CAACC,GAAR;EACD;;EACDX,MAAM,CAACY,QAAP,CAAgBN,IAAhB,EAAsBT,QAAtB;AACD;;AAED,SAASgB,mBAAT,GAA+B;EAC7B,IAAIC,GAAJ;EACA,IAAMC,IAAI,GAAGC,OAAO,CAACC,UAAR,CAAmB,KAAnB,CAAb;;EAEAD,OAAO,CAACC,UAAR,CAAmB,KAAnB,IAA4B,SAASC,aAAT,CAAuBC,CAAvB,EAA0BtB,QAA1B,EAAoC;IAC9D,IAAID,YAAY,CAACC,QAAD,CAAhB,EAA4B;MAC1B,OAAOkB,IAAI,CAACI,CAAD,EAAItB,QAAJ,CAAX;IACD,CAH6D,CAI9D;IACA;;;IACA,IAAI,CAACiB,GAAL,EAAU;MACRA,GAAG,GAAGM,aAAA,CAAKC,OAAL,CAAaxB,QAAb,CAAN;IACD;;IAED,IAAI,CAACA,QAAQ,CAACC,QAAT,CAAkBgB,GAAlB,CAAL,EAA6B;MAC3B,OAAOC,IAAI,CAACI,CAAD,EAAItB,QAAJ,CAAX;IACD;;IAED,OAAOE,MAAM,CAACoB,CAAD,EAAItB,QAAJ,CAAb;EACD,CAfD;AAgBD;;AAEDgB,mBAAmB"}
+{"version":3,"names":["isNodeModule","filename","includes","inject","module","generate","extract","transform","compact","quotes","code","process","env","JSDOCTRINETEST_VERBOSE","console","log","_compile","enableSpecInjection","dir","load","require","extensions","loadWithSpecs","m","path","dirname"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/* eslint require-jsdoc: [0] */\n/* eslint no-console: [0] */\n\nimport path from 'path';\n\nimport generate from '@babel/generator';\n\nimport extract from './extract';\nimport transform from './transform';\n\nfunction isNodeModule(filename) {\n  return filename.includes('node_modules') && !filename.includes('packages/node_modules');\n}\n\nfunction inject(module, filename) {\n  const {code} = generate(extract(transform, filename), {\n    compact: false,\n    quotes: 'single',\n  });\n\n  if (process.env.JSDOCTRINETEST_VERBOSE) {\n    console.log(filename);\n    console.log(code);\n    console.log();\n  }\n  module._compile(code, filename);\n}\n\nfunction enableSpecInjection() {\n  let dir;\n  const load = require.extensions['.js'];\n\n  require.extensions['.js'] = function loadWithSpecs(m, filename) {\n    if (isNodeModule(filename)) {\n      return load(m, filename);\n    }\n    // this is really janky, but so far seems to properly ensure we only load\n    // files in the directories specified to mocha\n    if (!dir) {\n      dir = path.dirname(filename);\n    }\n\n    if (!filename.includes(dir)) {\n      return load(m, filename);\n    }\n\n    return inject(m, filename);\n  };\n}\n\nenableSpecInjection();\n"],"mappings":";;;AAOA;AAEA;AAEA;AACA;AAZA;AACA;AACA;;AAEA;AACA;;AASA,SAASA,YAAY,CAACC,QAAQ,EAAE;EAC9B,OAAOA,QAAQ,CAACC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAACD,QAAQ,CAACC,QAAQ,CAAC,uBAAuB,CAAC;AACzF;AAEA,SAASC,MAAM,CAACC,MAAM,EAAEH,QAAQ,EAAE;EAChC,gBAAe,IAAAI,kBAAQ,EAAC,IAAAC,gBAAO,EAACC,kBAAS,EAAEN,QAAQ,CAAC,EAAE;MACpDO,OAAO,EAAE,KAAK;MACdC,MAAM,EAAE;IACV,CAAC,CAAC;IAHKC,IAAI,aAAJA,IAAI;EAKX,IAAIC,OAAO,CAACC,GAAG,CAACC,sBAAsB,EAAE;IACtCC,OAAO,CAACC,GAAG,CAACd,QAAQ,CAAC;IACrBa,OAAO,CAACC,GAAG,CAACL,IAAI,CAAC;IACjBI,OAAO,CAACC,GAAG,EAAE;EACf;EACAX,MAAM,CAACY,QAAQ,CAACN,IAAI,EAAET,QAAQ,CAAC;AACjC;AAEA,SAASgB,mBAAmB,GAAG;EAC7B,IAAIC,GAAG;EACP,IAAMC,IAAI,GAAGC,OAAO,CAACC,UAAU,CAAC,KAAK,CAAC;EAEtCD,OAAO,CAACC,UAAU,CAAC,KAAK,CAAC,GAAG,SAASC,aAAa,CAACC,CAAC,EAAEtB,QAAQ,EAAE;IAC9D,IAAID,YAAY,CAACC,QAAQ,CAAC,EAAE;MAC1B,OAAOkB,IAAI,CAACI,CAAC,EAAEtB,QAAQ,CAAC;IAC1B;IACA;IACA;IACA,IAAI,CAACiB,GAAG,EAAE;MACRA,GAAG,GAAGM,aAAI,CAACC,OAAO,CAACxB,QAAQ,CAAC;IAC9B;IAEA,IAAI,CAACA,QAAQ,CAACC,QAAQ,CAACgB,GAAG,CAAC,EAAE;MAC3B,OAAOC,IAAI,CAACI,CAAC,EAAEtB,QAAQ,CAAC;IAC1B;IAEA,OAAOE,MAAM,CAACoB,CAAC,EAAEtB,QAAQ,CAAC;EAC5B,CAAC;AACH;AAEAgB,mBAAmB,EAAE"}

package/dist/mocha-template.js

@@ -1,24 +1,20 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = generateSpec;
-
 var _types = require("@babel/types");
-
 var _template = _interopRequireDefault(require("@babel/template"));
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+
 var makeDescribeBlock = (0, _template.default)("\n  describe(DESCRIBED_THING, function() {\n    IT_BLOCK\n  });\n");
 var makeItBlock = (0, _template.default)("\n  it(DOES_A_THING, function() {\n    STATEMENTS\n  });\n");
+
 /**
  * Wraps a test case in a Mocha it-block
  * @param {Object} a
@@ -26,14 +22,11 @@ var makeItBlock = (0, _template.default)("\n  it(DOES_A_THING, function() {\n
  * @param {Object} a.testCase
  * @returns {[type]}
  */
-
 function generateSpec(a) {
   var itLine = a.name;
-
   if (a.type.toLowerCase().includes('function')) {
     itLine += '()';
   }
-
   var d = makeDescribeBlock({
     DESCRIBED_THING: (0, _types.stringLiteral)(a.filename),
     IT_BLOCK: makeItBlock({

package/dist/mocha-template.js.map

@@ -1 +1 @@
-{"version":3,"names":["makeDescribeBlock","template","makeItBlock","generateSpec","a","itLine","name","type","toLowerCase","includes","d","DESCRIBED_THING","stringLiteral","filename","IT_BLOCK","DOES_A_THING","STATEMENTS","testCase"],"sources":["mocha-template.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {stringLiteral} from '@babel/types';\nimport template from '@babel/template';\n\nconst makeDescribeBlock = template(`\n  describe(DESCRIBED_THING, function() {\n    IT_BLOCK\n  });\n`);\n\nconst makeItBlock = template(`\n  it(DOES_A_THING, function() {\n    STATEMENTS\n  });\n`);\n\n/**\n * Wraps a test case in a Mocha it-block\n * @param {Object} a\n * @param {string} a.name\n * @param {Object} a.testCase\n * @returns {[type]}\n */\nexport default function generateSpec(a) {\n  let itLine = a.name;\n\n  if (a.type.toLowerCase().includes('function')) {\n    itLine += '()';\n  }\n\n  const d = makeDescribeBlock({\n    DESCRIBED_THING: stringLiteral(a.filename),\n    IT_BLOCK: makeItBlock({\n      DOES_A_THING: stringLiteral(itLine),\n      STATEMENTS: a.testCase\n    })\n  });\n\n  return d;\n}\n"],"mappings":";;;;;;;;;;;;AAIA;;AACA;;AALA;AACA;AACA;AAKA,IAAMA,iBAAiB,GAAG,IAAAC,iBAAA,sEAA1B;AAMA,IAAMC,WAAW,GAAG,IAAAD,iBAAA,+DAApB;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;;AACe,SAASE,YAAT,CAAsBC,CAAtB,EAAyB;EACtC,IAAIC,MAAM,GAAGD,CAAC,CAACE,IAAf;;EAEA,IAAIF,CAAC,CAACG,IAAF,CAAOC,WAAP,GAAqBC,QAArB,CAA8B,UAA9B,CAAJ,EAA+C;IAC7CJ,MAAM,IAAI,IAAV;EACD;;EAED,IAAMK,CAAC,GAAGV,iBAAiB,CAAC;IAC1BW,eAAe,EAAE,IAAAC,oBAAA,EAAcR,CAAC,CAACS,QAAhB,CADS;IAE1BC,QAAQ,EAAEZ,WAAW,CAAC;MACpBa,YAAY,EAAE,IAAAH,oBAAA,EAAcP,MAAd,CADM;MAEpBW,UAAU,EAAEZ,CAAC,CAACa;IAFM,CAAD;EAFK,CAAD,CAA3B;EAQA,OAAOP,CAAP;AACD"}
+{"version":3,"names":["makeDescribeBlock","template","makeItBlock","generateSpec","a","itLine","name","type","toLowerCase","includes","d","DESCRIBED_THING","stringLiteral","filename","IT_BLOCK","DOES_A_THING","STATEMENTS","testCase"],"sources":["mocha-template.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {stringLiteral} from '@babel/types';\nimport template from '@babel/template';\n\nconst makeDescribeBlock = template(`\n  describe(DESCRIBED_THING, function() {\n    IT_BLOCK\n  });\n`);\n\nconst makeItBlock = template(`\n  it(DOES_A_THING, function() {\n    STATEMENTS\n  });\n`);\n\n/**\n * Wraps a test case in a Mocha it-block\n * @param {Object} a\n * @param {string} a.name\n * @param {Object} a.testCase\n * @returns {[type]}\n */\nexport default function generateSpec(a) {\n  let itLine = a.name;\n\n  if (a.type.toLowerCase().includes('function')) {\n    itLine += '()';\n  }\n\n  const d = makeDescribeBlock({\n    DESCRIBED_THING: stringLiteral(a.filename),\n    IT_BLOCK: makeItBlock({\n      DOES_A_THING: stringLiteral(itLine),\n      STATEMENTS: a.testCase,\n    }),\n  });\n\n  return d;\n}\n"],"mappings":";;;;;;;;AAIA;AACA;AALA;AACA;AACA;;AAKA,IAAMA,iBAAiB,GAAG,IAAAC,iBAAQ,sEAIhC;AAEF,IAAMC,WAAW,GAAG,IAAAD,iBAAQ,+DAI1B;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASE,YAAY,CAACC,CAAC,EAAE;EACtC,IAAIC,MAAM,GAAGD,CAAC,CAACE,IAAI;EAEnB,IAAIF,CAAC,CAACG,IAAI,CAACC,WAAW,EAAE,CAACC,QAAQ,CAAC,UAAU,CAAC,EAAE;IAC7CJ,MAAM,IAAI,IAAI;EAChB;EAEA,IAAMK,CAAC,GAAGV,iBAAiB,CAAC;IAC1BW,eAAe,EAAE,IAAAC,oBAAa,EAACR,CAAC,CAACS,QAAQ,CAAC;IAC1CC,QAAQ,EAAEZ,WAAW,CAAC;MACpBa,YAAY,EAAE,IAAAH,oBAAa,EAACP,MAAM,CAAC;MACnCW,UAAU,EAAEZ,CAAC,CAACa;IAChB,CAAC;EACH,CAAC,CAAC;EAEF,OAAOP,CAAC;AACV"}

package/dist/parse.js

@@ -1,19 +1,13 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = parse;
-
 var _defaults2 = _interopRequireDefault(require("lodash/defaults"));
-
 var _babylon = require("babylon");
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */

package/dist/parse.js.map

@@ -1 +1 @@
-{"version":3,"names":["parse","code","options","babelParse","allowImportExportEverywhere","sourceType","plugins"],"sources":["parse.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {parse as babelParse} from 'babylon';\nimport {defaults} from 'lodash';\n\n/**\n * Wrapper around babylon's parse with defaults set\n * @param {string} code\n * @param {object} options\n * @returns {ast}\n */\nexport default function parse(code, options) {\n  return babelParse(code, defaults(options, {\n    allowImportExportEverywhere: true,\n    sourceType: 'module',\n    plugins: [\n      'jsx',\n      'flow',\n      'asyncFunctions',\n      'classConstructorCall',\n      'doExpressions',\n      'trailingFunctionCommas',\n      'objectRestSpread',\n      'decorators',\n      'classProperties',\n      'exportExtensions',\n      'exponentiationOperator',\n      'asyncGenerators',\n      'functionBind',\n      'functionSent'\n    ]\n  }));\n}\n"],"mappings":";;;;;;;;;;;;;;AAIA;;AAJA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,KAAT,CAAeC,IAAf,EAAqBC,OAArB,EAA8B;EAC3C,OAAO,IAAAC,cAAA,EAAWF,IAAX,EAAiB,wBAASC,OAAT,EAAkB;IACxCE,2BAA2B,EAAE,IADW;IAExCC,UAAU,EAAE,QAF4B;IAGxCC,OAAO,EAAE,CACP,KADO,EAEP,MAFO,EAGP,gBAHO,EAIP,sBAJO,EAKP,eALO,EAMP,wBANO,EAOP,kBAPO,EAQP,YARO,EASP,iBATO,EAUP,kBAVO,EAWP,wBAXO,EAYP,iBAZO,EAaP,cAbO,EAcP,cAdO;EAH+B,CAAlB,CAAjB,CAAP;AAoBD"}
+{"version":3,"names":["parse","code","options","babelParse","allowImportExportEverywhere","sourceType","plugins"],"sources":["parse.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {parse as babelParse} from 'babylon';\nimport {defaults} from 'lodash';\n\n/**\n * Wrapper around babylon's parse with defaults set\n * @param {string} code\n * @param {object} options\n * @returns {ast}\n */\nexport default function parse(code, options) {\n  return babelParse(\n    code,\n    defaults(options, {\n      allowImportExportEverywhere: true,\n      sourceType: 'module',\n      plugins: [\n        'jsx',\n        'flow',\n        'asyncFunctions',\n        'classConstructorCall',\n        'doExpressions',\n        'trailingFunctionCommas',\n        'objectRestSpread',\n        'decorators',\n        'classProperties',\n        'exportExtensions',\n        'exponentiationOperator',\n        'asyncGenerators',\n        'functionBind',\n        'functionSent',\n      ],\n    })\n  );\n}\n"],"mappings":";;;;;;;;;AAIA;AAJA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,KAAK,CAACC,IAAI,EAAEC,OAAO,EAAE;EAC3C,OAAO,IAAAC,cAAU,EACfF,IAAI,EACJ,wBAASC,OAAO,EAAE;IAChBE,2BAA2B,EAAE,IAAI;IACjCC,UAAU,EAAE,QAAQ;IACpBC,OAAO,EAAE,CACP,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,wBAAwB,EACxB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,cAAc;EAElB,CAAC,CAAC,CACH;AACH"}

package/dist/transform.js

@@ -1,31 +1,23 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = transform;
-
 var _deleteProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/delete-property"));
-
 var _template = _interopRequireDefault(require("@babel/template"));
-
 var _traverse = _interopRequireDefault(require("@babel/traverse"));
-
 var _parse = _interopRequireDefault(require("./parse"));
-
 var _mochaTemplate = _interopRequireDefault(require("./mocha-template"));
-
 var _literal = require("./assertions/literal");
-
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+
 var assertionStatementTemplate = (0, _template.default)("\n  return Promise.resolve(ORIGINAL)\n    .then(function(result) {\n      ASSERTIONS\n    })\n");
+
 /**
  * @param {Object} options
  * @param {ast} options.comment
@@ -34,18 +26,16 @@ var assertionStatementTemplate = (0, _template.default)("\n  return Promise.reso
  * @param {string} options.type
  * @returns {ast}
  */
-
 function transform(_ref) {
   var comment = _ref.comment,
-      name = _ref.name,
-      filename = _ref.filename,
-      type = _ref.type;
+    name = _ref.name,
+    filename = _ref.filename,
+    type = _ref.type;
   var ast = (0, _parse.default)(comment);
   (0, _traverse.default)(ast, {
     enter: function enter(path) {
       if (path.node.trailingComments) {
         var assertions = path.node.trailingComments.map(makeAsserter);
-
         if (assertions.length) {
           (0, _deleteProperty.default)(path.node, 'trailingComments');
           path.replaceWith(assertionStatementTemplate({
@@ -63,18 +53,16 @@ function transform(_ref) {
     type: type
   });
 }
+
 /**
  * Takes a trailing comment from an example block and changes it to an assertion
  * @param {CommentBlock} comment
  * @returns {ast}
  */
-
-
 function makeAsserter(comment) {
   if ((0, _literal.test)(comment.value)) {
     return (0, _literal.build)(comment.value);
   }
-
   return null;
 }
 //# sourceMappingURL=transform.js.map

package/dist/transform.js.map

@@ -1 +1 @@
-{"version":3,"names":["assertionStatementTemplate","template","transform","comment","name","filename","type","ast","parse","traverse","enter","path","node","trailingComments","assertions","map","makeAsserter","length","replaceWith","ORIGINAL","ASSERTIONS","generateSpec","testCase","literalAssertionTest","value","buildLiteralAssertion"],"sources":["transform.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n\nimport template from '@babel/template';\nimport traverse from '@babel/traverse';\n\nimport parse from './parse';\nimport generateSpec from './mocha-template';\nimport {\n  build as buildLiteralAssertion,\n  test as literalAssertionTest\n} from './assertions/literal';\n\nconst assertionStatementTemplate = template(`\n  return Promise.resolve(ORIGINAL)\n    .then(function(result) {\n      ASSERTIONS\n    })\n`);\n\n/**\n * @param {Object} options\n * @param {ast} options.comment\n * @param {string} options.name\n * @param {string} options.filename\n * @param {string} options.type\n * @returns {ast}\n */\nexport default function transform({\n  comment, name, filename, type\n}) {\n  const ast = parse(comment);\n\n  traverse(ast, {\n    enter(path) {\n      if (path.node.trailingComments) {\n        const assertions = path.node.trailingComments.map(makeAsserter);\n\n        if (assertions.length) {\n          Reflect.deleteProperty(path.node, 'trailingComments');\n\n          path.replaceWith(assertionStatementTemplate({\n            ORIGINAL: path.node,\n            ASSERTIONS: assertions\n          }));\n        }\n      }\n    }\n  });\n\n  return generateSpec({\n    testCase: ast,\n    name,\n    filename,\n    type\n  });\n}\n\n/**\n * Takes a trailing comment from an example block and changes it to an assertion\n * @param {CommentBlock} comment\n * @returns {ast}\n */\nfunction makeAsserter(comment) {\n  if (literalAssertionTest(comment.value)) {\n    return buildLiteralAssertion(comment.value);\n  }\n\n  return null;\n}\n"],"mappings":";;;;;;;;;;;;;;AAKA;;AACA;;AAEA;;AACA;;AACA;;AAVA;AACA;AACA;AAaA,IAAMA,0BAA0B,GAAG,IAAAC,iBAAA,mGAAnC;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACe,SAASC,SAAT,OAEZ;EAAA,IADDC,OACC,QADDA,OACC;EAAA,IADQC,IACR,QADQA,IACR;EAAA,IADcC,QACd,QADcA,QACd;EAAA,IADwBC,IACxB,QADwBA,IACxB;EACD,IAAMC,GAAG,GAAG,IAAAC,cAAA,EAAML,OAAN,CAAZ;EAEA,IAAAM,iBAAA,EAASF,GAAT,EAAc;IACZG,KADY,iBACNC,IADM,EACA;MACV,IAAIA,IAAI,CAACC,IAAL,CAAUC,gBAAd,EAAgC;QAC9B,IAAMC,UAAU,GAAGH,IAAI,CAACC,IAAL,CAAUC,gBAAV,CAA2BE,GAA3B,CAA+BC,YAA/B,CAAnB;;QAEA,IAAIF,UAAU,CAACG,MAAf,EAAuB;UACrB,6BAAuBN,IAAI,CAACC,IAA5B,EAAkC,kBAAlC;UAEAD,IAAI,CAACO,WAAL,CAAiBlB,0BAA0B,CAAC;YAC1CmB,QAAQ,EAAER,IAAI,CAACC,IAD2B;YAE1CQ,UAAU,EAAEN;UAF8B,CAAD,CAA3C;QAID;MACF;IACF;EAdW,CAAd;EAiBA,OAAO,IAAAO,sBAAA,EAAa;IAClBC,QAAQ,EAAEf,GADQ;IAElBH,IAAI,EAAJA,IAFkB;IAGlBC,QAAQ,EAARA,QAHkB;IAIlBC,IAAI,EAAJA;EAJkB,CAAb,CAAP;AAMD;AAED;AACA;AACA;AACA;AACA;;;AACA,SAASU,YAAT,CAAsBb,OAAtB,EAA+B;EAC7B,IAAI,IAAAoB,aAAA,EAAqBpB,OAAO,CAACqB,KAA7B,CAAJ,EAAyC;IACvC,OAAO,IAAAC,cAAA,EAAsBtB,OAAO,CAACqB,KAA9B,CAAP;EACD;;EAED,OAAO,IAAP;AACD"}
+{"version":3,"names":["assertionStatementTemplate","template","transform","comment","name","filename","type","ast","parse","traverse","enter","path","node","trailingComments","assertions","map","makeAsserter","length","replaceWith","ORIGINAL","ASSERTIONS","generateSpec","testCase","literalAssertionTest","value","buildLiteralAssertion"],"sources":["transform.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport template from '@babel/template';\nimport traverse from '@babel/traverse';\n\nimport parse from './parse';\nimport generateSpec from './mocha-template';\nimport {build as buildLiteralAssertion, test as literalAssertionTest} from './assertions/literal';\n\nconst assertionStatementTemplate = template(`\n  return Promise.resolve(ORIGINAL)\n    .then(function(result) {\n      ASSERTIONS\n    })\n`);\n\n/**\n * @param {Object} options\n * @param {ast} options.comment\n * @param {string} options.name\n * @param {string} options.filename\n * @param {string} options.type\n * @returns {ast}\n */\nexport default function transform({comment, name, filename, type}) {\n  const ast = parse(comment);\n\n  traverse(ast, {\n    enter(path) {\n      if (path.node.trailingComments) {\n        const assertions = path.node.trailingComments.map(makeAsserter);\n\n        if (assertions.length) {\n          Reflect.deleteProperty(path.node, 'trailingComments');\n\n          path.replaceWith(\n            assertionStatementTemplate({\n              ORIGINAL: path.node,\n              ASSERTIONS: assertions,\n            })\n          );\n        }\n      }\n    },\n  });\n\n  return generateSpec({\n    testCase: ast,\n    name,\n    filename,\n    type,\n  });\n}\n\n/**\n * Takes a trailing comment from an example block and changes it to an assertion\n * @param {CommentBlock} comment\n * @returns {ast}\n */\nfunction makeAsserter(comment) {\n  if (literalAssertionTest(comment.value)) {\n    return buildLiteralAssertion(comment.value);\n  }\n\n  return null;\n}\n"],"mappings":";;;;;;;;;AAIA;AACA;AAEA;AACA;AACA;AATA;AACA;AACA;;AASA,IAAMA,0BAA0B,GAAG,IAAAC,iBAAQ,mGAKzC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASC,SAAS,OAAkC;EAAA,IAAhCC,OAAO,QAAPA,OAAO;IAAEC,IAAI,QAAJA,IAAI;IAAEC,QAAQ,QAARA,QAAQ;IAAEC,IAAI,QAAJA,IAAI;EAC9D,IAAMC,GAAG,GAAG,IAAAC,cAAK,EAACL,OAAO,CAAC;EAE1B,IAAAM,iBAAQ,EAACF,GAAG,EAAE;IACZG,KAAK,iBAACC,IAAI,EAAE;MACV,IAAIA,IAAI,CAACC,IAAI,CAACC,gBAAgB,EAAE;QAC9B,IAAMC,UAAU,GAAGH,IAAI,CAACC,IAAI,CAACC,gBAAgB,CAACE,GAAG,CAACC,YAAY,CAAC;QAE/D,IAAIF,UAAU,CAACG,MAAM,EAAE;UACrB,6BAAuBN,IAAI,CAACC,IAAI,EAAE,kBAAkB,CAAC;UAErDD,IAAI,CAACO,WAAW,CACdlB,0BAA0B,CAAC;YACzBmB,QAAQ,EAAER,IAAI,CAACC,IAAI;YACnBQ,UAAU,EAAEN;UACd,CAAC,CAAC,CACH;QACH;MACF;IACF;EACF,CAAC,CAAC;EAEF,OAAO,IAAAO,sBAAY,EAAC;IAClBC,QAAQ,EAAEf,GAAG;IACbH,IAAI,EAAJA,IAAI;IACJC,QAAQ,EAARA,QAAQ;IACRC,IAAI,EAAJA;EACF,CAAC,CAAC;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASU,YAAY,CAACb,OAAO,EAAE;EAC7B,IAAI,IAAAoB,aAAoB,EAACpB,OAAO,CAACqB,KAAK,CAAC,EAAE;IACvC,OAAO,IAAAC,cAAqB,EAACtB,OAAO,CAACqB,KAAK,CAAC;EAC7C;EAEA,OAAO,IAAI;AACb"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/jsdoctrinetest",
-  "version": "3.0.0-beta.9",
+  "version": "3.0.0-beta.91",
   "description": "",
   "license": "MIT",
   "contributors": [
@@ -41,7 +41,7 @@
     "@babel/types": "^7.14.9"
   },
   "dependencies": {
-    "@webex/test-helper-chai": "3.0.0-beta.9",
+    "@webex/test-helper-chai": "3.0.0-beta.91",
     "babylon": "^6.18.0",
     "doctrine": "^2.1.0",
     "lodash": "^4.17.21"

package/src/assertions/literal.js

@@ -3,11 +3,7 @@
  */
 
 import template from '@babel/template';
-import {
-  booleanLiteral,
-  numericLiteral,
-  stringLiteral
-} from '@babel/types';
+import {booleanLiteral, numericLiteral, stringLiteral} from '@babel/types';
 
 const pattern = /^\s*?=>( async)?\s*/;
 
@@ -34,7 +30,7 @@ export function test(value) {
  */
 export function build(value) {
   return tpl({
-    ASSERTION: literal(value.replace(pattern, ''))
+    ASSERTION: literal(value.replace(pattern, '')),
   });
 }
 
@@ -46,7 +42,8 @@ export function build(value) {
 function literal(l) {
   /* eslint complexity: [0] */
   // eslint-disable-next-line prefer-const
-  let f, i;
+  let f;
+  let i;
 
   switch (typeof l) {
     case 'boolean':

package/src/extract.js

@@ -2,7 +2,6 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
-
 import fs from 'fs';
 
 import traverse from '@babel/traverse';
@@ -39,29 +38,29 @@ export default function extract(transform, filename) {
   traverse(ast, {
     enter(path) {
       if (path.node.leadingComments) {
-        path.node.leadingComments
-          .filter(isJSDocComment)
-          .forEach((comment) => {
-            const result = doctrine.parse(comment.value, {
-              unwrap: true,
-              sloppy: true,
-              recoverable: true,
-              lineNumbers: true
-            });
+        path.node.leadingComments.filter(isJSDocComment).forEach((comment) => {
+          const result = doctrine.parse(comment.value, {
+            unwrap: true,
+            sloppy: true,
+            recoverable: true,
+            lineNumbers: true,
+          });
 
-            if (result.tags) {
-              result.tags.forEach((tag) => {
-                if (tag.title === 'example') {
-                  results.push(transform({
+          if (result.tags) {
+            result.tags.forEach((tag) => {
+              if (tag.title === 'example') {
+                results.push(
+                  transform({
                     comment: tag.description,
                     name: getNodeName(path.node),
                     filename: path.node.loc.filename,
-                    type: path.node.type
-                  }));
-                }
-              });
-            }
-          });
+                    type: path.node.type,
+                  })
+                );
+              }
+            });
+          }
+        });
       }
     },
     Program: {
@@ -73,8 +72,8 @@ export default function extract(transform, filename) {
           path.pushContainer('body', results);
           done = true;
         }
-      }
-    }
+      },
+    },
   });
 
   return ast;
@@ -109,9 +108,12 @@ function isJSDocComment(comment) {
   }
 
   // eslint-disable-next-line
-  return (comment.type === `CommentBlock` || // estree
-    // eslint-disable-next-line
-    comment.type === `Block`) // get-comments / traditional
+  return (
+    (comment.type === 'CommentBlock' || // estree
+      // eslint-disable-next-line
+      comment.type === `Block`) && // get-comments / traditional
     // eslint-disable-next-line
-    && asterisks && asterisks[ 1 ].length === 1;
+    asterisks &&
+    asterisks[1].length === 1
+  );
 }

package/src/index.js

@@ -19,7 +19,7 @@ function isNodeModule(filename) {
 function inject(module, filename) {
   const {code} = generate(extract(transform, filename), {
     compact: false,
-    quotes: 'single'
+    quotes: 'single',
   });
 
   if (process.env.JSDOCTRINETEST_VERBOSE) {

package/src/mocha-template.js

@@ -35,8 +35,8 @@ export default function generateSpec(a) {
     DESCRIBED_THING: stringLiteral(a.filename),
     IT_BLOCK: makeItBlock({
       DOES_A_THING: stringLiteral(itLine),
-      STATEMENTS: a.testCase
-    })
+      STATEMENTS: a.testCase,
+    }),
   });
 
   return d;

package/src/parse.js

@@ -12,24 +12,27 @@ import {defaults} from 'lodash';
  * @returns {ast}
  */
 export default function parse(code, options) {
-  return babelParse(code, defaults(options, {
-    allowImportExportEverywhere: true,
-    sourceType: 'module',
-    plugins: [
-      'jsx',
-      'flow',
-      'asyncFunctions',
-      'classConstructorCall',
-      'doExpressions',
-      'trailingFunctionCommas',
-      'objectRestSpread',
-      'decorators',
-      'classProperties',
-      'exportExtensions',
-      'exponentiationOperator',
-      'asyncGenerators',
-      'functionBind',
-      'functionSent'
-    ]
-  }));
+  return babelParse(
+    code,
+    defaults(options, {
+      allowImportExportEverywhere: true,
+      sourceType: 'module',
+      plugins: [
+        'jsx',
+        'flow',
+        'asyncFunctions',
+        'classConstructorCall',
+        'doExpressions',
+        'trailingFunctionCommas',
+        'objectRestSpread',
+        'decorators',
+        'classProperties',
+        'exportExtensions',
+        'exponentiationOperator',
+        'asyncGenerators',
+        'functionBind',
+        'functionSent',
+      ],
+    })
+  );
 }

package/src/transform.js

@@ -2,16 +2,12 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
-
 import template from '@babel/template';
 import traverse from '@babel/traverse';
 
 import parse from './parse';
 import generateSpec from './mocha-template';
-import {
-  build as buildLiteralAssertion,
-  test as literalAssertionTest
-} from './assertions/literal';
+import {build as buildLiteralAssertion, test as literalAssertionTest} from './assertions/literal';
 
 const assertionStatementTemplate = template(`
   return Promise.resolve(ORIGINAL)
@@ -28,9 +24,7 @@ const assertionStatementTemplate = template(`
  * @param {string} options.type
  * @returns {ast}
  */
-export default function transform({
-  comment, name, filename, type
-}) {
+export default function transform({comment, name, filename, type}) {
   const ast = parse(comment);
 
   traverse(ast, {
@@ -41,20 +35,22 @@ export default function transform({
         if (assertions.length) {
           Reflect.deleteProperty(path.node, 'trailingComments');
 
-          path.replaceWith(assertionStatementTemplate({
-            ORIGINAL: path.node,
-            ASSERTIONS: assertions
-          }));
+          path.replaceWith(
+            assertionStatementTemplate({
+              ORIGINAL: path.node,
+              ASSERTIONS: assertions,
+            })
+          );
         }
       }
-    }
+    },
   });
 
   return generateSpec({
     testCase: ast,
     name,
     filename,
-    type
+    type,
   });
 }