docu.mjs

#!/usr/bin/env node
/* This commentaries are made by hand to be processed by https://github.com/StringManolo/docu */

/* lang -> javascript
* name -> docu.mjs
* title -> Docu - Documentation
* filetype -> ES6 module
* description -> Docu is a code geneator CLI tool. Is intended to generate documentation in html, markdown and bbcode from code commentaries.
* summary -> CLI tool to create documents from commentaries in html, markdown and bbcode.
* dependency -> node https://node.org,fwl.mjs https://github.com/StringManolo/fwl
*/

import fs from "fs";
import fwl from "./fwl.mjs";

fwl(global);

if (!process.argv[2]) {
  console.log(`Usage: 
node docu.mjs myCodeFile html > documentation.html
node docu.mjs myCodeFile markdown > documentation.md
node docu.mjs myCodeFile bbcode > documentation.txt
`);
  process.exit(0);
}

if (process.argv[3]) {
  documentType = process.argv[3];
}

const filename = process.argv[2];

let file;
try {
  file = fs.readFileSync(filename, { encoding: "utf-8" });
} catch(e) {
  console.log(`Unable to load the file: ${e}`);
  process.exit(0);
}

let stringContext = false;
let commentContext = false;
let commentStartPos = false;
let lineCounter = 1;
let comments = [];
let commentLines = [];
for (let i in file) {
  if (file[i] == "\n") {
    ++lineCounter;
  }
  if (file[i - 1] != "\\" && file[i] == '"' || file[i] == "'" || file[i] == "`") {
    if (commentContext == false) {
      switch(file[i]) {
        case '"': 
          stringContext = (stringContext == '"' ? false : '"');
        break;

        case "'":
          stringContext = (stringContext == "'" ? false : "'");
        break;

        case "`":
          stringContext = (stringContext == "`" ? false : "`");
      }
    }
  } else if(file[i] == "/" && file[1 + +i] == "*") {
    if (stringContext == false) {
      commentContext = true;
      commentStartPos = i; 
    }
  } else if(file[i] == "*" && file[1 + +i] == "/") {
    if (stringContext == false) {
      if (commentStartPos) {
        commentLines.push(lineCounter);
        comments.push(file.substring(commentStartPos, +i + 2));
        commentStartPos = false;
        stringContext = false;
        commentContext = false;
      }
    }
  }
}


let lang = "unknown";
let sourceLink = "";
const processParts = (part, lineNumber) => {
  let aux = "";
  switch(part[0]) {
    case "lang":
      lang = part[1];
      return p (`code: ${part[1]}`);

    case "title": 
      t = title (`${part[1]}`);
    break;

    case "sourceLink":
      sourceLink = part[1];
    break;
       

    case "name": return h1 (`${part[1]}`) + hr ``;
    case "filetype": return h3 (`${part[1]}`) + hr ``;
    case "description": return h4 (`${part[1]}`) + hr ``;
    case "dependency": {
      const dLinks = part[1].split(",");
      let dGenerated = "";
      for (let i in dLinks) {
        dGenerated += link(dLinks[i]) + ",";
      }
      return list(dGenerated.substr(0, dGenerated.length-1));
    }

    case "variable":
    case "object":
    case "function":
    case "property":
    case "method": {
      let lineNumberLink;
      if (documentType == "html") {
        lineNumberLink = link(`${lineNumber} #L${lineNumber}`);
      } else {
        lineNumberLink = link(`${lineNumber} ${sourceLink}#L${lineNumber}`);
      }

      return p("") + br("") + h5(italic (`${part[0]}`) + " " + bold (`${part[1]}`) + "  " + lineNumberLink) + br ``;
    }

    case "type": return br (`${italic(part[1])}`);

    case "summary": return br (`${part[1]}`);

    case "return":
      if(part.length > 3) {
        return  "Return: " + bold (`${part[1]}`) + " " + italic (`${part[2]}`) + "  " + br (` ${part[3]}`);
      } else if (part.length < 4) {
        return "Return: " + italic (`${part[2]}`) + " " + br ``;
      }
    break;

    case "param":
      if (part.length > 3) {
        return  "Argument: " + bold (`${part[1]}`) + " " + italic (`${part[2]}`)  + "   " + br (`${part[3]}`);
      } else {
        return  "Argument: " + bold (`${part[1]}`) + br ``;
      }

    case "values": return br (`Values: ${part[1]}`);

    case "example": {
      const formatedCode = `${lang}
${part[1].trim()}`;
      return code(formatedCode);
    }

  }
  return "";
}

let premarkup = "",
premarkup2 = "",
markup = "",
t = "",
postmarkup = "";

if (documentType == "html") {
premarkup = html `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
`;
premarkup2 = html `</head>
<body>
`;
postmarkup = html `</body>
</html>`;
}

const parseComment = (comment, lineNumber) => {
  if (/(\n|\r\n)/g.test(comment)) {
    let lines = comment.split("\n");
    for (let i in lines) {
      if (/\-\>/g.test(lines[i])) {
        if (/\/\*/g.test(lines[i]) || /\*/g.test(lines[i])) {
          lines[i] = lines[i].split("*").splice(1, lines[i].length).join("*").trim();
          let parts = lines[i].split("->").map(part => part.trim());
          if (parts[0] == "example") {
//maybe missing some part if -> found again? 
            parts = lines.splice(i, lines.length - (1 + +i)).join("\n").split("->");
            parts[0] = parts[0].trim();
/*
            let aux = parts[1].split("\n");
            for (let i = 0; i < aux.length; ++i) {
              if (i == 0) {
                aux[i] = aux[i].trim();
              }
              let precomputedIndex = (1 + +i).toString().length;
              let separator = "";
              let numberOfSpaces = 3 - precomputedIndex;
              for (let j = 0; j < numberOfSpaces; ++j) {
                separator += " ";
              }
              separator += "|  ";
              aux[i] = `${1 + +i}${separator}${aux[i]}`;
            }
            parts[1] = aux.join("\n");
*/
          }
          markup += processParts(parts, lineNumber);
        } else {
          //console.log("Not finding star");
        }
      } else {
        //console.log("Not finding arrow");
      }
    }
  } else {
    //console.log(`Not finding line breaks`);
  }
}


for (let i in comments) {
  parseComment(comments[i], +commentLines[i] + 1);
}

const replaceAll = (str, pattern, newStr) => {
  while (pattern.test(str)) {
    str = str.replace(pattern, newStr);
  }
  return str;
}

const htmlEntities = s => {
  const r = "replace";
  const a = s[r](/ /g,"&#32;")[r](/!/g,"&#33;")[r](/"/g,"&#34;")[r](/%/g,"&#37;")[r](/'/g,"&#39;")[r](/\(/g,"&#40;")[r](/\)/g,"&#41;")[r](/</g,"&#60;")[r](/>/g,"&#62;")[r](/`/g,"&#96;")[r](/a/g,"&#97;")[r](/A/g,"&#65;")[r](/e/g,"&#101;")[r](/E/g,"&#69;")[r](/i/g,"&#105;")[r](/I/g,"&#73;")[r](/o/g,"&#111;")[r](/O/g,"&#79;")[r](/u/g,"&#117;")[r](/U/g,"&#85;")[r](/{/g,"&#123;")[r](/}/g,"&#125;")[r](/‘/g,"&#8216;")[r](/’/g,"&#8217")[r](/‚/g,"&#8218;")[r](/“/g,"&#8220;")[r](/”/g,"&#8221;")[r](/„/g,"&#8222;")[r](/′/g,"&#8242;")[r](/″/g,"&#8244;")[r](/‹/g,"&#8249;")[r](/›/g,"&#8250;")[r](/s/g,"&#115;")[r](/S/g,"&#83;")[r](/\./g,"&#46;");
  return a;
}


let endFile, auxFile;
if (documentType == "html") {
  endFile = file.split("\n");
  auxFile = "html\n";
  for (let i in endFile) {
    auxFile += `<span id="L${+i + 1}">${htmlEntities(endFile[i])}</span>\n`;
  }
}

let generated;
if (documentType == "html") {
  generated = (premarkup + t + premarkup2 + markup + style_default() + p`` + text `Source:` + rawCode(auxFile) + postmarkup);
} else {
  generated = (premarkup + t + premarkup2 + markup + style_default() +
p`` + postmarkup);
}

generated = replaceAll(generated, /REMOVETHISLINE/g, "");

console.log(generated);