inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3040] Replaced doc template engine to fix whitespace issues (#3356)

Browse Source
This commit is contained in:
Andy Stark
2018-05-21 15:54:22 +01:00
committed by Eugenio Romano
parent c63dee50f1
commit 0e64efc4e2
17 changed files with 96 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tools/doc/tools/tsInfo.js
View File

@@ -4,7 +4,7 @@ var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
var remark = require("remark");
var combyne = require("combyne");
var ejs = require("ejs");
var typedoc_1 = require("typedoc");
var mdNav_1 = require("../mdNav");
var libFolders = ["core", "content-services", "process-services", "insights"];
@@ -79,9 +79,9 @@ var ParamInfo = /** @class */ (function () {
this.combined = this.name;
if (this.isOptional)
this.combined += "?";
this.combined += ": " + this.type;
this.combined += ": `" + this.type + "`";
if (this.defaultValue !== "")
this.combined += " = " + this.defaultValue;
this.combined += " = `" + this.defaultValue + "`";
}
return ParamInfo;
}());
@@ -213,10 +213,10 @@ function updatePhase(tree, pathname, aggData, errorMessages) {
var methodMD = getMethodDocsFromMD(tree);
updateMethodDocsFromMD(compData, methodMD, errorMessages);
}
var templateName = path.resolve(templateFolder, classType + ".combyne");
var templateName = path.resolve(templateFolder, classType + ".ejs");
var templateSource = fs.readFileSync(templateName, "utf8");
var template = combyne(templateSource);
var mdText = template.render(compData);
var template = ejs.compile(templateSource);
var mdText = template(compData);
mdText = mdText.replace(/^ +\|/mg, "|");
var newSection_1 = remark().data("settings", { paddedTable: false, gfm: false }).parse(mdText.trim()).children;
replaceSection(tree, "Class members", function (before, section, after) {

11
tools/doc/tools/tsInfo.ts
View File

@@ -7,6 +7,7 @@ import * as stringify from "remark-stringify";
import * as frontMatter from "remark-frontmatter";
import * as combyne from "combyne";
import * as ejs from "ejs";
import {
Application,
@@ -129,10 +130,10 @@ class ParamInfo {
if (this.isOptional)
this.combined += "?";
this.combined += `: ${this.type}`;
this.combined += `: \`${this.type}\``;
if (this.defaultValue !== "")
this.combined += ` = ${this.defaultValue}`;
this.combined += ` = \`${this.defaultValue}\``;
}
}
@@ -307,11 +308,11 @@ export function updatePhase(tree, pathname, aggData, errorMessages) {
updateMethodDocsFromMD(compData, methodMD, errorMessages);
}
let templateName = path.resolve(templateFolder, classType + ".combyne");
let templateName = path.resolve(templateFolder, classType + ".ejs");
let templateSource = fs.readFileSync(templateName, "utf8");
let template = combyne(templateSource);
let template = ejs.compile(templateSource);
let mdText = template.render(compData);
let mdText = template(compData);
mdText = mdText.replace(/^ +\|/mg, "|");
let newSection = remark().data("settings", {paddedTable: false, gfm: false}).parse(mdText.trim()).children;

10
tools/doc/tools/tutorialIndex.js
View File

@@ -1,12 +1,12 @@
"use strict";
exports.__esModule = true;
Object.defineProperty(exports, "__esModule", { value: true });
var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
var remark = require("remark");
var frontMatter = require("remark-frontmatter");
var yaml = require("js-yaml");
var combyne = require("combyne");
var ejs = require("ejs");
var unist = require("../unistHelpers");
var tutFolder = path.resolve("docs", "tutorials");
var templateFolder = path.resolve("tools", "doc", "templates");
@@ -17,10 +17,10 @@ function readPhase(tree, pathname, aggData) { }
exports.readPhase = readPhase;
function aggPhase(aggData) {
var indexDocData = getIndexDocData();
var templateName = path.resolve(templateFolder, "tutIndex.combyne");
var templateName = path.resolve(templateFolder, "tutIndex.ejs");
var templateSource = fs.readFileSync(templateName, "utf8");
var template = combyne(templateSource);
var mdText = template.render(indexDocData);
var template = ejs.compile(templateSource);
var mdText = template(indexDocData);
mdText = mdText.replace(/^ +\|/mg, "|");
var newSection = remark().data("settings", { paddedTable: false, gfm: false }).parse(mdText.trim()).children;
var tutIndexFile = path.resolve(tutFolder, "README.md");

8
tools/doc/tools/tutorialIndex.ts
View File

@@ -6,7 +6,7 @@ import * as remark from "remark";
import * as stringify from "remark-stringify";
import * as frontMatter from "remark-frontmatter";
import * as yaml from "js-yaml";
import * as combyne from "combyne";
import * as ejs from "ejs";
import * as unist from "../unistHelpers";
@@ -23,11 +23,11 @@ export function readPhase(tree, pathname, aggData) {}
export function aggPhase(aggData) {
let indexDocData = getIndexDocData();
let templateName = path.resolve(templateFolder, "tutIndex.combyne");
let templateName = path.resolve(templateFolder, "tutIndex.ejs");
let templateSource = fs.readFileSync(templateName, "utf8");
let template = combyne(templateSource);
let template = ejs.compile(templateSource);
let mdText = template.render(indexDocData);
let mdText = template(indexDocData);
mdText = mdText.replace(/^ +\|/mg, "|");
let newSection = remark().data("settings", {paddedTable: false, gfm: false}).parse(mdText.trim()).children;

8
tools/doc/tools/versionIndex.js
View File

@@ -7,7 +7,7 @@ var stringify = require("remark-stringify");
var zone = require("mdast-zone");
var frontMatter = require("remark-frontmatter");
var combyne = require("combyne");
var ejs = require("ejs");
var unist = require("../unistHelpers");
var ngHelpers = require("../ngHelpers");
@@ -77,9 +77,9 @@ function aggPhase(aggData) {
return 0;
});
var templateName = path.resolve(templateFolder, "versIndex.combyne");
var templateName = path.resolve(templateFolder, "versIndex.ejs");
var templateSource = fs.readFileSync(templateName, "utf8");
var template = combyne(templateSource);
var template = ejs.compile(templateSource);
for (var i = 0; i < keys.length; i++) {
var version = keys[i];
@@ -105,7 +105,7 @@ function aggPhase(aggData) {
});
}
var mdText = template.render(versionTemplateData);
var mdText = template(versionTemplateData);
mdText = mdText.replace(/^ +-/mg, "-");
var newSection = remark().data("settings", {paddedTable: false, gfm: false}).parse(mdText.trim()).children;