jsd-jekyll - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

CHANGELOG.md

 # Changelog
 
+## 0.3.0 - 2021-09-21
+
+- Add support using special characters when adding module and category tags based on the filename.
+
 ## 0.2.0 - 2021-04-01
+
 - Fix generated pages include a returns description
@@ -9,5 +14,7 @@ - Add optional pre-processing to tag all files as Modules
 ## 0.1.1 - 2021-02-11
+
 - Fix loading jsdoc environment variables
 
 ## 0.1.0 - 2021-02-09
+
 - First Release

package.json

 {
   "name": "jsd-jekyll",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "JSDoc Plugin and Template for making a Github Pages compatable Jekyll Site",
@@ -5,0 +5,0 @@ "main": "src/main.js",

src/main.js

 /**
  * JSDoc plugin
  */
-const { processParams, processTypes, githubUrl, extract } = require("./processing");
+const {
+  processParams,
+  processTypes,
+  githubUrl,
+  extract
+} = require("./processing");
 const fs = require("jsdoc/fs");
@@ -12,16 +17,21 @@ const env = require("jsdoc/env");
     if (env.opts.includeAll) {
-      if (new RegExp('@module').test(e.source) == false){
-        const captures = e.filename.match(/\\(\w*)\\(\w*)\./);
-        const file = captures[2];
-        e.source = `/** @module ${file} */` + e.source;
+      if (new RegExp("@module").test(e.source) == false) {
+        try {
+          const captures = e.filename.match(/\\(.*)\\(.*)\./);
+          const file = captures[2];
+          e.source = `/** @module ${file} */` + e.source;
+        } catch (err) {
+          console.log(err, e);
+        }
       }
     }
     if (env.opts.folderCategory) {
-    //Option to assign modules to categories based on folder
-      if (new RegExp('@module').test(e.source)){
-        const captures = e.filename.match(/\\(\w*)\\(\w*)\\(\w*)\./);
-        const category = captures[2];
-        const moduleName = e.source.match(/(@module +\w*) ?/)[1];
-        const replace = `${moduleName} \n * @category ${captures[1]}-${captures[2]}`
-        e.source = e.source.replace(/(@module +\w*) ?/, replace);
+      //Option to assign modules to categories based on folder
+      if (new RegExp("@module").test(e.source)) {
+        const captures = e.filename.match(/\\([^\\]+)\\([^\\]+)\\([^\\]+)\./);
+        const moduleName = e.source.match(/(@module +\S*) ?/)[1];
+        // const category = captures[2];
+
+        const replace = `${moduleName} \n * @category ${captures[1]}-${captures[2]}`;
+        e.source = e.source.replace(/(@module +\S*) ?/, replace);
       }
@@ -37,8 +47,8 @@ }
         let content = e.comment.match(funRegEx)[1];
-        content = content.replace(/\(\)/,"");
-        let replacement  = `@function${content}`;
+        content = content.replace(/\(\)/, "");
+        let replacement = `@function${content}`;
         if (extraRegEx.test(content)) {
-          const split = content.split('*');
-          split[1] = ` @description${split[1]}`
-          replacement = `@function${split.join('*')}`
+          const split = content.split("*");
+          split[1] = ` @description${split[1]}`;
+          replacement = `@function${split.join("*")}`;
         }
@@ -80,5 +90,8 @@ e.comment = e.comment.replace(funRegEx, replacement);
       let regex = new RegExp(env.opts.repos[0]["folder"] + "(.*)");
-      e.doclet.meta.repopath = extract(e.doclet.meta.path, regex).replace(/\\/g, "/");
+      e.doclet.meta.repopath = extract(e.doclet.meta.path, regex).replace(
+        /\\/g,
+        "/"
+      );
     }
-  },
+  }
 };
@@ -85,0 +98,0 @@

No alert changes

Improved metrics

Total package byte prevSize

33329

increased by0.85%

Lines of code

409

increased by3.02%

No dependency changes