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-4190] Fixed bad auto-generated URLs (#4413)

Browse Source 
* [ADF-4190] Tool + config updates to fix Typedoc issues

* [ADF-4190] Added missing AppDefinitionRepresentation link
This commit is contained in:
Andy Stark
2019-03-08 13:29:06 +00:00
committed by Eugenio Romano
parent ec13d88e61
commit 8b8f1e147f
6 changed files with 68 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
tools/doc/tools/typeLinker.js
View File

@@ -1,5 +1,5 @@
"use strict";
exports.__esModule = true;
Object.defineProperty(exports, "__esModule", { value: true });
var path = require("path");
var unist = require("../unistHelpers");
var ngHelpers = require("../ngHelpers");
@@ -11,6 +11,7 @@ var includedNodeTypes = [
var docFolder = path.resolve("docs");
var adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud", "extensions"];
var externalNameLinks;
var linkOverrides;
function processDocs(mdCache, aggData, errorMessages) {
initPhase(aggData, mdCache);
var pathnames = Object.keys(mdCache);
@@ -21,6 +22,10 @@ function processDocs(mdCache, aggData, errorMessages) {
exports.processDocs = processDocs;
function initPhase(aggData, mdCache) {
externalNameLinks = aggData.config.externalNameLinks;
linkOverrides = {};
aggData.config.linkOverrides.forEach(function (override) {
linkOverrides[override.toLowerCase()] = 1;
});
aggData.docFiles = {};
aggData.nameLookup = new SplitNameLookup();
/*
@@ -286,7 +291,13 @@ function resolveTypeLink(aggData, docFilePath, text) {
*/
var classInfo = aggData.classInfo[possTypeName];
//if (ref && isLinkable(ref.kind)) {
if (classInfo) {
if (linkOverrides[possTypeName.toLowerCase()]) {
return '';
}
else if (externalNameLinks[possTypeName]) {
return externalNameLinks[possTypeName];
}
else if (classInfo) {
var kebabName = ngHelpers.kebabifyClassName(possTypeName);
var possDocFile = aggData.docFiles[kebabName];
//let url = "../../" + classInfo.sourcePath;
@@ -297,9 +308,6 @@ function resolveTypeLink(aggData, docFilePath, text) {
}
return url;
}
else if (externalNameLinks[possTypeName]) {
return externalNameLinks[possTypeName];
}
else {
return "";
}
@@ -317,7 +325,6 @@ function fixRelDocUrl(docPathFrom, docPathTo) {
var relDocPathFrom = docPathFrom.substring(docPathFrom.indexOf('docs'));
var docPathSegments = relDocPathFrom.split(/[\\\/]/);
var dotPathPart = '';
console.log("Fixing: " + docPathFrom + " " + docPathTo);
for (var i = 0; i < (docPathSegments.length - 2); i++) {
dotPathPart += '../';
}

17
tools/doc/tools/typeLinker.ts
View File

@@ -20,6 +20,7 @@ const docFolder = path.resolve("docs");
const adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud", "extensions"];
let externalNameLinks;
let linkOverrides;
export function processDocs(mdCache, aggData, errorMessages) {
initPhase(aggData, mdCache);
@@ -34,6 +35,12 @@ export function processDocs(mdCache, aggData, errorMessages) {
function initPhase(aggData, mdCache) {
externalNameLinks = aggData.config.externalNameLinks;
linkOverrides = {};
aggData.config.linkOverrides.forEach(override => {
linkOverrides[override.toLowerCase()] = 1;
});
aggData.docFiles = {};
aggData.nameLookup = new SplitNameLookup();
@@ -346,7 +353,11 @@ function resolveTypeLink(aggData, docFilePath, text): string {
let classInfo = aggData.classInfo[possTypeName];
//if (ref && isLinkable(ref.kind)) {
if (classInfo) {
if (linkOverrides[possTypeName.toLowerCase()]) {
return '';
} else if (externalNameLinks[possTypeName]) {
return externalNameLinks[possTypeName];
} else if (classInfo) {
let kebabName = ngHelpers.kebabifyClassName(possTypeName);
let possDocFile = aggData.docFiles[kebabName];
@@ -360,8 +371,6 @@ function resolveTypeLink(aggData, docFilePath, text): string {
}
return url;
} else if (externalNameLinks[possTypeName]) {
return externalNameLinks[possTypeName];
} else {
return "";
}
@@ -384,8 +393,6 @@ function fixRelDocUrl(docPathFrom: string, docPathTo: string) {
let docPathSegments = relDocPathFrom.split(/[\\\/]/);
let dotPathPart = '';
console.log(`Fixing: ${docPathFrom} ${docPathTo}`);
for (let i = 0; i < (docPathSegments.length - 2); i++) {
dotPathPart += '../';
}