documentary - npm Package Compare versions

Comparing version 1.21.0 to 1.21.1

build/bin/catcher.js

@@ -19,3 +19,1 @@ const { debuglog } = require('util');
 module.exports=catcher
-
-//# sourceMappingURL=catcher.js.map

build/bin/get-args.js

@@ -45,3 +45,2 @@ let argufy = require('argufy'); if (argufy && argufy.__esModule) argufy = argufy.default;
 
-module.exports=getArgs
-//# sourceMappingURL=get-args.js.map
+module.exports=getArgs

build/bin/run.js

@@ -55,3 +55,2 @@ let whichStream = require('which-stream'); if (whichStream && whichStream.__esModule) whichStream = whichStream.default;
 
-module.exports = run
-//# sourceMappingURL=run.js.map
+module.exports = run

build/bin/run/extract.js

@@ -189,3 +189,2 @@ const { createReadStream } = require('fs');
 
-module.exports.propExtractRe = propExtractRe
-//# sourceMappingURL=extract.js.map
+module.exports.propExtractRe = propExtractRe

build/bin/run/generate.js

@@ -68,3 +68,1 @@ const { createReadStream } = require('fs');
 module.exports=generateTypedef
-
-//# sourceMappingURL=generate.js.map

build/index.js

@@ -21,3 +21,2 @@ /**
 module.exports = documentary
-module.exports.Toc = $_lib_Toc
-//# sourceMappingURL=index.js.map
+module.exports.Toc = $_lib_Toc

build/lib/components.js

 let rexml = require('rexml'); if (rexml && rexml.__esModule) rexml = rexml.default;
 let render = require('preact-render-to-string'); if (render && render.__esModule) render = render.default;
 
+       const makeComponentRe = (key) => {
+  const re = new RegExp(`( *)(<${key}(\\s+.*)*(/>|[\\s\\S]*?<\\/${key}>))`, 'gm')
+  return re
+}
+
 function loadComponents(components) {
   const compsReplacements = Object.keys(components)
     .map((key) => {
-      const re = new RegExp(`( *)(<${key}(\\s+.*)?(/>|[\\s\\S]*?<\\/${key}>))`, 'gm')
+      const re = makeComponentRe(key)
       const replacement = function (m, pad, Component) {
@@ -26,2 +31,3 @@ const [{ content, props }] = rexml(key, Component)
 module.exports=loadComponents
-//# sourceMappingURL=components.js.map
+
+module.exports.makeComponentRe = makeComponentRe

build/lib/Documentary.js

@@ -184,3 +184,2 @@ const { Replaceable, makeMarkers, makeCutRule, makePasteRule } = require('restream');
 
-module.exports = Documentary
-//# sourceMappingURL=Documentary.js.map
+module.exports = Documentary

build/lib/index.js

@@ -85,3 +85,2 @@ const { createReadStream, lstatSync } = require('fs');
 module.exports.git = git
-module.exports.codeSurround = codeSurround
-//# sourceMappingURL=index.js.map
+module.exports.codeSurround = codeSurround

build/lib/js-replace-stream.js

@@ -11,3 +11,2 @@ const JSDocumentary = require('./JSDocumentary');
 
-module.exports = createJsReplaceStream
-//# sourceMappingURL=js-replace-stream.js.map
+module.exports = createJsReplaceStream

build/lib/JSDocumentary.js

@@ -42,3 +42,2 @@ const { Replaceable } = require('restream');
 
-module.exports = JSDocumentary
-//# sourceMappingURL=JSDocumentary.js.map
+module.exports = JSDocumentary

build/lib/replace-stream.js

@@ -20,3 +20,2 @@ const Documentary = require('./Documentary');
 
-module.exports = createReplaceStream
-//# sourceMappingURL=replace-stream.js.map
+module.exports = createReplaceStream

build/lib/rules/badge.js

@@ -13,3 +13,2 @@ const badgeRe = /^%NPM: ((?:[@\w\d-_]+\/)?[\w\d-_]+)%$/gm
 
-module.exports.badgeRe = badgeRe
-//# sourceMappingURL=badge.js.map
+module.exports.badgeRe = badgeRe

build/lib/rules/example.js

@@ -75,3 +75,2 @@ const { debuglog } = require('util');
 module.exports.replacer = replacer
-module.exports.re = re
-//# sourceMappingURL=example.js.map
+module.exports.re = re

build/lib/rules/fork.js

@@ -23,3 +23,1 @@ const { fork } = require('spawncommand');
 module.exports=forkRule
-
-//# sourceMappingURL=fork.js.map

build/lib/rules/gif.js

@@ -38,3 +38,2 @@ // import { debuglog } from 'util'
 
-module.exports.gifRe = gifRe
-//# sourceMappingURL=gif.js.map
+module.exports.gifRe = gifRe

build/lib/rules/index.js

@@ -36,3 +36,2 @@ const { debuglog } = require('util');
 module.exports.linkTitleRe = linkTitleRe
-module.exports.linkRe = linkRe
-//# sourceMappingURL=index.js.map
+module.exports.linkRe = linkRe

build/lib/rules/macro.js

@@ -48,3 +48,2 @@ const re = /^%TABLE-MACRO (.+)\n([\s\S]+?)\n%(\n|$)/gm
 
-module.exports.re = re
-//# sourceMappingURL=macro.js.map
+module.exports.re = re

build/lib/rules/macros.js

@@ -55,3 +55,2 @@ let extractTags = require('rexml'); if (extractTags && extractTags.__esModule) extractTags = extractTags.default;
 module.exports.macroRule = macroRule
-module.exports.useMacroRule = useMacroRule
-//# sourceMappingURL=macros.js.map
+module.exports.useMacroRule = useMacroRule

build/lib/rules/method-title.js

@@ -66,3 +66,2 @@ const { debuglog } = require('util');
 module.exports.replacer = replacer
-module.exports.methodTitleRe = re
-//# sourceMappingURL=method-title.js.map
+module.exports.methodTitleRe = re

build/lib/rules/section-break.js

@@ -57,3 +57,2 @@ const { join } = require('path');
 
-module.exports.sectionBrakeRe = sectionBrakeRe
-//# sourceMappingURL=section-break.js.map
+module.exports.sectionBrakeRe = sectionBrakeRe

build/lib/rules/table.js

@@ -107,3 +107,2 @@ const { debuglog } = require('util');
 module.exports.replacer = replacer
-module.exports.tableRe = re
-//# sourceMappingURL=table.js.map
+module.exports.tableRe = re

build/lib/rules/tree.js

@@ -32,3 +32,1 @@ let spawn = require('spawncommand'); if (spawn && spawn.__esModule) spawn = spawn.default;
 module.exports=treeRule
-
-//# sourceMappingURL=tree.js.map

build/lib/rules/type.js

@@ -97,3 +97,2 @@ const { debuglog } = require('util');
 
-module.exports.typeRe = typeRe
-//# sourceMappingURL=type.js.map
+module.exports.typeRe = typeRe

build/lib/rules/typedef-js.js

@@ -76,3 +76,2 @@ const { debuglog } = require('util');
 
-module.exports.typedefJsRe = typedefJsRe
-//# sourceMappingURL=typedef-js.js.map
+module.exports.typedefJsRe = typedefJsRe

build/lib/rules/typedef-md.js

@@ -20,3 +20,2 @@ const { debuglog } = require('util');
 
-module.exports.typedefMdRe = typedefMdRe
-//# sourceMappingURL=typedef-md.js.map
+module.exports.typedefMdRe = typedefMdRe

build/lib/Toc.js

@@ -308,3 +308,2 @@ const { Transform } = require('stream');
 module.exports = Toc
-module.exports.getToc = getToc
-//# sourceMappingURL=Toc.js.map
+module.exports.getToc = getToc

build/lib/typedef/jsdoc.js

@@ -28,3 +28,2 @@ const { debuglog } = require('util');
 
-module.exports.jsDocRe = jsDocRe
-//# sourceMappingURL=jsdoc.js.map
+module.exports.jsDocRe = jsDocRe

build/lib/typedef/re.js

@@ -5,3 +5,2 @@ const propRe = / \* @prop(?:erty)? .+\n/
 
-module.exports=typedefRe
-//# sourceMappingURL=re.js.map
+module.exports=typedefRe

build/lib/Typedefs.js

@@ -108,3 +108,2 @@ const { debuglog } = require('util');
 module.exports = Typedefs
-module.exports.getTypedefs = getTypedefs
-//# sourceMappingURL=Typedefs.js.map
+module.exports.getTypedefs = getTypedefs

CHANGELOG.md

@@ -0,1 +1,8 @@
+## 26 January 2019
+
+### 1.21.1
+
+- [fix] Detect components with multiline arguments.
+- [refactor] Rename `index.js` to `doc.js` and make `alamode.js` as an executable `bin/index.js`.
+
 ## 25 January 2018
@@ -2,0 +9,0 @@

package.json

 {
   "name": "documentary",
-  "version": "1.21.0",
+  "version": "1.21.1",
   "description": "A Documentation Pre-processor To Generate The Table Of Contents, Embed Examples With Their Output, Make Markdown Tables, Maintain Typedefs For JavaScript And README, Watch Changes To Push, Use Macros And Prettify API Titles.",
@@ -24,8 +24,8 @@ "main": "build",
     "example/typedef.js": "yarn dev example/typedef.js -T",
-    "b": "alamode src -o build -i bin/alamode.js",
+    "b": "alamode src -o build -i bin/index.js -s",
     "build": "yarn-s b doc"
   },
   "bin": {
-    "doc": "build/bin/index.js",
-    "doc-dev": "src/bin/alamode.js"
+    "doc": "build/bin/doc.js",
+    "doc-dev": "src/bin/index.js"
   },
@@ -32,0 +32,0 @@ "man": "man/doc.1",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

150821

decreased by-53.77%

Number of package files

61

decreased by-38.38%

Lines of code

1789

decreased by-11.17%

No dependency changes