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-2463] Update doc tools to work with subfolders (#3056)

Browse Source 
* [ADF-2463] Updated main doc tool and index tool to handle subfolders

* [ADF-2463] Updated version index tool for subfolders
This commit is contained in:
Andy Stark
2018-03-09 22:39:59 +00:00
committed by Eugenio Romano
parent 16a8fa8cd8
commit 4ee7cc0870
3 changed files with 54 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/config/DocProcessor/tools/index.js
View File

@@ -39,7 +39,7 @@ function initPhase(aggData) {
aggData.srcData = {};
aggData.mdFileDesc = [];
aggData.mdFileStatus = [];
aggData.mdFilePath = [];
searchLibraryRecursive(aggData.srcData, path.resolve(rootFolder));
//console.log(JSON.stringify(aggData.srcData));
@@ -50,7 +50,7 @@ function readPhase(tree, pathname, aggData) {
var itemName = path.basename(pathname, ".md");
// Look for the first paragraph in the file by skipping other items.
// Should usually be a position 1 in the tree.
// Should usually be at position 1 in the tree.
var s;
var briefDesc;
@@ -80,6 +80,10 @@ function readPhase(tree, pathname, aggData) {
}
}
var linkPath = pathname.replace(/\\/g, '/');
linkPath = linkPath.substr(linkPath.indexOf("docs") + 5);
aggData.mdFilePath[itemName] = linkPath;
}
function aggPhase(aggData) {
@@ -159,6 +163,7 @@ function prepareIndexSections(aggData) {
var briefDesc = aggData.mdFileDesc[itemName];
var displayName = ngHelpers.ngNameToDisplayName(itemName);
var pathname = aggData.mdFilePath[itemName];
var status = "";
@@ -169,6 +174,7 @@ function prepareIndexSections(aggData) {
sections[libName][srcData.type].documented.push({
"displayName": displayName,
"mdName": itemName + ".md",
"mdPath": pathname,
"srcPath": srcData.path,
"briefDesc": briefDesc,
"status": status
@@ -280,7 +286,7 @@ function makeMDUndocumentedListItem(docItem) {
function makeMDDocumentedTableRow(docItem) {
var mdFileLink = unist.makeLink(unist.makeText(docItem.displayName), docItem.mdName);
var mdFileLink = unist.makeLink(unist.makeText(docItem.displayName), docItem.mdPath);
var srcFileLink = unist.makeLink(unist.makeText("Source"), "../lib/" + docItem.srcPath);
var desc = docItem.briefDesc;

15
lib/config/DocProcessor/tools/versionIndex.js
View File

@@ -31,7 +31,7 @@ function initPhase(aggData) {
function readPhase(tree, pathname, aggData) {
var compName = path.basename(pathname, ".md");
var compName = pathname; //path.basename(pathname, ".md");
var angNameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(model)|(pipe)|(service)|(widget))/;
if (!compName.match(angNameRegex))
@@ -86,13 +86,20 @@ function aggPhase(aggData) {
for (var i = 0; i < keys.length; i++) {
var version = keys[i];
var versionItems = aggData.versions[version];
versionItems.sort();
versionItems.sort((a, b) => {
var aa = path.basename(a, ".md");
var bb = path.basename(b, ".md");
return aa.localeCompare(bb);
});
var versListItems = [];
for (var v = 0; v < versionItems.length; v++) {
var displayName = ngHelpers.ngNameToDisplayName(versionItems[v]);
var pageLink = versionItems[v] + ".md";
var displayName = ngHelpers.ngNameToDisplayName(path.basename(versionItems[v], ".md"));
var pageLink = versionItems[v];// + ".md";
pageLink = pageLink.replace(/\\/g, '/');
pageLink = pageLink.substr(pageLink.indexOf("docs") + 5);
versListItems.push(
unist.makeListItem(