tnp 19.0.21 → 19.0.22

package/lib/project/abstract/docs.js

@@ -1,813 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Docs = void 0;
-var tslib_1 = require("tslib");
-//#region imports
-//#region @backend
-var tnp_core_1 = require("tnp-core");
-//#endregion
-var tnp_helpers_1 = require("tnp-helpers");
-var tnp_config_1 = require("tnp-config");
-var tnp_helpers_2 = require("tnp-helpers");
-var tnp_helpers_3 = require("tnp-helpers");
-var tnp_core_2 = require("tnp-core");
-var magic_renamer_1 = require("magic-renamer");
-//#endregion
-var Docs = /** @class */ (function (_super) {
-    tslib_1.__extends(Docs, _super);
-    //#endregion
-    //#endregion
-    //#region constructor
-    //#region @backend
-    // @ts-ignore
-    function Docs(project) {
-        var _this = this;
-        // @ts-ignore
-        _this.project = project;
-        var timestampContainer = (0, tnp_core_2.crossPlatformPath)(
-        // @ts-ignore
-        tnp_core_2.path.dirname(_this.docsGlobalTimestampForWatcherAbsPath));
-        // console.log('timestampContainer', timestampContainer);
-        // process.exit(0);
-        _this = _super.call(this, project, {
-            taskName: 'DocsProvider',
-            folderPath: project.location,
-            ignoreFolderPatter: tslib_1.__spreadArray(tslib_1.__spreadArray([
-                project.pathFor('tmp-*/**/*.*'),
-                project.pathFor('tmp-*'),
-                project.pathFor('dist/**/*.*'),
-                project.pathFor('dist'),
-                project.pathFor('dist-*/**/*.*'),
-                project.pathFor('browser/**/*.*'),
-                project.pathFor('browser'),
-                project.pathFor('websql/**/*.*'),
-                project.pathFor('websql')
-            ], tslib_1.__read(['ts', 'js', 'scss', 'css', 'html'].map(function (ext) {
-                return project.pathFor("src/**/*.".concat(ext));
-            })), false), [
-                project.pathFor('.*/**/*.*'),
-                "".concat(timestampContainer),
-                "".concat(timestampContainer, "/**/*.*"),
-            ], false),
-            subscribeOnlyFor: ['md', 'yml'],
-        }) || this;
-        //#region fields & getters
-        _this.docsConfigJsonFileName = 'docs-config.jsonc';
-        _this.docsConfigSchema = 'docs-config.schema.json';
-        _this.customDefaultCss = 'custom-default.css';
-        _this.customDefaultJs = 'custom-default.js';
-        _this.linkedAlreadProjects = {};
-        //#endregion
-        //#region fields & getters / tmp docs folder path
-        /**
-         * mkdocs temp folder
-         */
-        _this.tmpDocsFolderRoot = ".".concat(tnp_config_1.config.frameworkName, "/temp-docs-folder");
-        _this.combinedDocsFolder = "allmdfiles";
-        return _this;
-    }
-    Object.defineProperty(Docs.prototype, "docsConfigCurrentProjAbsPath", {
-        //#region fields & getters / docs config current proj abs path
-        get: function () {
-            //#region @backendFunc
-            return this.project.pathFor(this.docsConfigJsonFileName);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Docs.prototype, "config", {
-        //#endregion
-        //#region fields & getters / docs config
-        get: function () {
-            //#region @backendFunc
-            return this.project.readJson(this.docsConfigJsonFileName);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    //#endregion
-    //#region fields & getters / linkd docs to global container
-    Docs.prototype.linkDocsToGlobalContainer = function () {
-        //#region @backendFunc
-        if (!tnp_helpers_3.Helpers.exists(tnp_core_2.path.dirname(this.docsConfigGlobalContainerAbsPath))) {
-            tnp_helpers_3.Helpers.mkdirp(tnp_core_2.path.dirname(this.docsConfigGlobalContainerAbsPath));
-        }
-        try {
-            tnp_core_1.fse.unlinkSync(this.docsConfigGlobalContainerAbsPath);
-        }
-        catch (error) { }
-        tnp_helpers_3.Helpers.createSymLink(this.project.pathFor(this.tmpDocsFolderRootDocsDirRelativePath), this.docsConfigGlobalContainerAbsPath);
-        this.writeGlobalWatcherTimestamp();
-        //#endregion
-    };
-    Object.defineProperty(Docs.prototype, "tmpDocsFolderRootDocsDirRelativePath", {
-        get: function () {
-            //#region @backendFunc
-            return (0, tnp_core_2.crossPlatformPath)([this.tmpDocsFolderRoot, this.combinedDocsFolder]);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Docs.prototype, "outDocsDistFolderAbs", {
-        //#endregion
-        //#region fields & getters / out docs folder path
-        get: function () {
-            //#region @backendFunc
-            return this.project.pathFor([
-                this.initalParams.docsOutFolder || ".".concat(tnp_config_1.config.frameworkName, "/docs-dist"),
-            ]);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Docs.prototype, "docsConfigGlobalContainerAbsPath", {
-        //#endregion
-        //#region n fields & getters / docs config global container abs path
-        get: function () {
-            //#region @backendFunc
-            var globalContainer = this.project.ins.by('container', this.project.__frameworkVersion);
-            return globalContainer.pathFor(".".concat(tnp_config_1.config.frameworkName, "/docs-from-projects/").concat(this.project.universalPackageName));
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Docs.prototype, "docsGlobalTimestampForWatcherAbsPath", {
-        //#endregion
-        //#region fields & getters / docs global timestamp for watcher abs path
-        get: function () {
-            //#region @backendFunc
-            return this.getTimestampWatcherForPackageName(this.project.universalPackageName);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Docs.prototype, "docsConfigSchemaPath", {
-        //#endregion
-        //#region n fields & getters / docs config schema path
-        get: function () {
-            //#region @backendFunc
-            return this.project.ins
-                .by('isomorphic-lib', this.project.__frameworkVersion)
-                .pathFor(this.docsConfigSchema);
-            //#endregion
-        },
-        enumerable: false,
-        configurable: true
-    });
-    //#endregion
-    //#endregion
-    //#region methods / init
-    Docs.prototype.init = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                //#region @backendFunc
-                this.project.removeFolderByRelativePath(this.tmpDocsFolderRootDocsDirRelativePath);
-                this.project.createFolder(this.tmpDocsFolderRootDocsDirRelativePath);
-                if (!this.project.hasFile(this.docsConfigJsonFileName)) {
-                    this.project.writeJson(this.docsConfigJsonFileName, this.defaultDocsConfig());
-                }
-                try {
-                    tnp_core_1.fse.unlinkSync(this.project.pathFor(this.docsConfigSchema));
-                }
-                catch (error) { }
-                tnp_helpers_3.Helpers.createSymLink(this.docsConfigSchemaPath, this.project.pathFor(this.docsConfigSchema), { continueWhenExistedFolderDoesntExists: true });
-                this.project.vsCodeHelpers.recreateJsonSchemas();
-                this.linkDocsToGlobalContainer();
-                return [2 /*return*/];
-            });
-        });
-    };
-    //#endregion
-    //#region methods / action
-    Docs.prototype.action = function (_a) {
-        return tslib_1.__awaiter(this, arguments, void 0, function (_b) {
-            var portForDocs;
-            var _this = this;
-            var _c;
-            var changeOfFiles = _b.changeOfFiles, asyncEvent = _b.asyncEvent;
-            return tslib_1.__generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        //#region @backendFunc
-                        // if (asyncEvent) {
-                        //   console.log(
-                        //     'changeOfFiles',
-                        //     changeOfFiles.map(f => f.fileAbsolutePath),
-                        //   );
-                        // }
-                        // QUICK_FIX
-                        if (asyncEvent &&
-                            changeOfFiles.length === 1 &&
-                            ((_c = tnp_core_2._.first(changeOfFiles)) === null || _c === void 0 ? void 0 : _c.fileAbsolutePath) ===
-                                this.docsGlobalTimestampForWatcherAbsPath) {
-                            return [2 /*return*/];
-                        }
-                        if (!!asyncEvent) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.init()];
-                    case 1:
-                        _d.sent();
-                        _d.label = 2;
-                    case 2: return [4 /*yield*/, this.recreateFilesInTempFolder(asyncEvent)];
-                    case 3:
-                        _d.sent();
-                        if (!!asyncEvent) return [3 /*break*/, 7];
-                        return [4 /*yield*/, this.buildMkdocs({ watch: this.isWatchCompilation })];
-                    case 4:
-                        _d.sent();
-                        tnp_core_1.chokidar
-                            .watch(this.project.pathFor(this.docsConfigJsonFileName), {
-                            ignoreInitial: true,
-                        })
-                            .on('all', function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                            return tslib_1.__generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0:
-                                        tnp_helpers_3.Helpers.info('Docs config changed (docs-config.jsonc).. rebuilding..');
-                                        return [4 /*yield*/, this.action({
-                                                changeOfFiles: [],
-                                                asyncEvent: true,
-                                            })];
-                                    case 1:
-                                        _a.sent();
-                                        return [2 /*return*/];
-                                }
-                            });
-                        }); });
-                        if (!this.initalParams.docsOutFolder) return [3 /*break*/, 7];
-                        return [4 /*yield*/, this.project.registerAndAssignPort(('docs port for http server'), {
-                                startFrom: 3950,
-                            })];
-                    case 5:
-                        portForDocs = _d.sent();
-                        return [4 /*yield*/, tnp_helpers_3.UtilsHttp.startHttpServer(this.outDocsDistFolderAbs, portForDocs)];
-                    case 6:
-                        _d.sent();
-                        _d.label = 7;
-                    case 7:
-                        if (asyncEvent) {
-                            this.writeGlobalWatcherTimestamp();
-                        }
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    //#endregion
-    //#region methods / docs config json $schema content
-    Docs.prototype.docsConfigSchemaContent = function () {
-        //#region @backendFunc
-        return tnp_helpers_3.Helpers.readFile(this.docsConfigSchemaPath);
-        //#endregion
-    };
-    //#endregion
-    //#region private methods
-    //#region private methods / default docs config
-    Docs.prototype.defaultDocsConfig = function () {
-        //#region @backendFunc
-        return {
-            site_name: this.project.name,
-            // additionalAssets: [], // TODO MAKE IT AUTOMATIC
-            externalDocs: {
-                mdfiles: [],
-                projects: [],
-            },
-            omitFilesPatters: [],
-            priorityOrder: [],
-            mapTitlesNames: {
-                'README.md': 'Introduction',
-            },
-            customCssPath: 'custom.css',
-            customJsPath: 'custom.js',
-        };
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / apply priority order
-    Docs.prototype.applyPriorityOrder = function (files) {
-        //#region @backendFunc
-        var orderByPriority = function (items, priority) {
-            return items.sort(function (a, b) {
-                // Get the index of the 'title' in the priorityOrder array
-                var indexA = priority.indexOf(a.title.replace('.md', ''));
-                var indexB = priority.indexOf(b.title.replace('.md', ''));
-                // If either title is not in the priority order, move it to the end (assign a large index)
-                var priorityA = indexA === -1 ? priority.length : indexA;
-                var priorityB = indexB === -1 ? priority.length : indexB;
-                // Compare by priority order
-                return priorityA - priorityB;
-            });
-        };
-        files = orderByPriority(files, (this.config.priorityOrder || []).map(function (p) { return p.replace('.md', ''); }));
-        // Return prioritized files first, followed by the rest
-        var omitFilesPatters = this.config.omitFilesPatters || [];
-        var result = tnp_core_1.Utils.uniqArray(
-        // [...prioritizedFiles, ...nonPrioritizedFiles]
-        files.filter(function (f) {
-            return f.title &&
-                !omitFilesPatters
-                    .map(function (a) { return a.replace('.md', ''); })
-                    .includes(f.title.replace('.md', ''));
-        }), 'relativePath');
-        return result;
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / mkdocs.yml content
-    Docs.prototype.mkdocsYmlContent = function (entryPointFilesRelativePaths) {
-        //#region @backendFunc
-        // console.log({
-        //   entryPointFilesRelativePaths,
-        // });
-        // example:
-        // - Introduction: introduction/index.md
-        // - Setup: setup/index.md
-        // - Isomorphic Code: isomorphic-code/index.md
-        // - Development: development/index.md
-        // - Tutorials: tutorials/index.md
-        // - Changelog: changelog/index.md
-        // - QA: qa/index.md
-        // docs_dir: ./
-        return "site_name: ".concat(this.config.site_name ? this.config.site_name : tnp_core_2._.upperFirst(this.project.name) + 'Documentation', "\n# site_url:  ").concat(this.project.__env.config.domain, "\nnav:\n").concat(this.applyPriorityOrder(entryPointFilesRelativePaths)
-            .map(function (p) {
-            if (p.relativePath === p.title) {
-                "  - ".concat(tnp_core_2._.replace(p.title, /[_\s]/g, ' '));
-            }
-            return "  - ".concat(tnp_core_2._.replace(p.title, /[_\s]/g, ' '), ": ").concat(p.relativePath);
-        })
-            .join('\n'), "\ndocs_dir: ./").concat(this.combinedDocsFolder, "\ntheme:\n  name: material\n  features:\n    - navigation.tabs\n    - navigation.sections\n    - toc.integrate\n    - navigation.top\n    - search.suggest\n    - search.highlight\n    - content.tabs.link\n    - content.code.annotation\n    - content.code.copy\n  language: en\n  palette:\n    primary: custom\n    accent: custom\n    # - scheme: default\n    #   toggle:\n    #     icon: material/toggle-switch-off-outline\n    #     name: Switch to dark mode\n    # primary: red\n    # accent: red\n    # - scheme: slate\n    #   toggle:\n    #     icon: material/toggle-switch\n    #     name: Switch to light mode\n    # primary: red\n    # accent: red\n\nextra_css:\n  - ").concat(this.config.customCssPath || this.customDefaultCss, "\n\nextra_javascript:\n  - ").concat(this.config.customJsPath || this.customDefaultJs, "\n\n# plugins:\n#   - social\n\n# extra:\n#   social:\n#     - icon: fontawesome/brands/github-alt\n#       link: https://github.com/james-willett\n#     - icon: fontawesome/brands/twitter\n#       link: https://twitter.com/TheJamesWillett\n#     - icon: fontawesome/brands/linkedin\n#       link: https://www.linkedin.com/in/willettjames/\n\nmarkdown_extensions:\n  - pymdownx.highlight:\n      anchor_linenums: true\n  - pymdownx.inlinehilite\n  - pymdownx.snippets\n  - admonition\n  - pymdownx.arithmatex:\n      generic: true\n  - footnotes\n  - pymdownx.details\n  - pymdownx.superfences\n  - pymdownx.mark\n  - attr_list\n  # - pymdownx.emoji:\n  #     emoji_index: !!python/name:materialx.emoji.twemoji\n  #     emoji_generator: !!python/name:materialx.emoji.to_svg\n\n  ");
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / build mkdocs
-    Docs.prototype.buildMkdocs = function (_a) {
-        return tslib_1.__awaiter(this, arguments, void 0, function (_b) {
-            var _c;
-            var watch = _b.watch;
-            return tslib_1.__generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        //#region @backendFunc
-                        this.project.setValueToJSONC(tnp_config_1.config.file.package_json, 'scripts.mkdocs', process.platform === 'darwin' ? 'mkdocs' : 'python3 -m mkdocs');
-                        if (!watch) return [3 /*break*/, 2];
-                        _c = this;
-                        return [4 /*yield*/, this.project.registerAndAssignPort('mkdocs serve', {
-                                startFrom: 3900,
-                            })];
-                    case 1:
-                        _c.mkdocsServePort = _d.sent();
-                        // python3 -m
-                        tnp_helpers_3.Helpers.run(process.platform === 'darwin'
-                            ? "mkdocs serve -a localhost:".concat(this.mkdocsServePort, " --quiet")
-                            : //--quiet
-                                "python3 -m mkdocs serve -a localhost:".concat(this.mkdocsServePort, " --quiet"), {
-                            cwd: this.project.pathFor([this.tmpDocsFolderRoot]),
-                        }).async();
-                        tnp_helpers_3.Helpers.info("Mkdocs server started on  http://localhost:".concat(this.mkdocsServePort));
-                        return [3 /*break*/, 3];
-                    case 2:
-                        if (!tnp_helpers_3.Helpers.exists(this.outDocsDistFolderAbs)) {
-                            tnp_helpers_3.Helpers.mkdirp(this.outDocsDistFolderAbs);
-                        }
-                        tnp_helpers_3.Helpers.run("python3 -m mkdocs build --site-dir ".concat(this.outDocsDistFolderAbs), {
-                            cwd: this.project.pathFor([this.tmpDocsFolderRoot]),
-                        }).sync();
-                        _d.label = 3;
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    //#endregion
-    // TODO @LAST hande @render tag in md files
-    //#region private methods / copy files to docs folder
-    Docs.prototype.copyFilesToTempDocsFolder = function (relativeFilePathesToCopy, asyncEvent) {
-        var e_1, _a, e_2, _b;
-        //#region @backendFunc
-        var counterCopy = 0;
-        //#region handle custom js/css files
-        if (this.config.customCssPath &&
-            this.project.hasFile(this.config.customCssPath)) {
-            tnp_helpers_3.Helpers.copyFile(this.project.pathFor(this.config.customCssPath), this.project.pathFor([
-                this.tmpDocsFolderRootDocsDirRelativePath,
-                this.config.customCssPath,
-            ]));
-        }
-        else {
-            this.project.writeFile([this.tmpDocsFolderRootDocsDirRelativePath, this.customDefaultCss], '');
-        }
-        if (this.config.customJsPath &&
-            this.project.hasFile(this.config.customJsPath)) {
-            tnp_helpers_3.Helpers.copyFile(this.project.pathFor(this.config.customJsPath), this.project.pathFor([
-                this.tmpDocsFolderRootDocsDirRelativePath,
-                this.config.customJsPath,
-            ]));
-        }
-        else {
-            this.project.writeFile([this.tmpDocsFolderRootDocsDirRelativePath, this.customDefaultJs], '');
-        }
-        try {
-            //#endregion
-            for (var relativeFilePathesToCopy_1 = tslib_1.__values(relativeFilePathesToCopy), relativeFilePathesToCopy_1_1 = relativeFilePathesToCopy_1.next(); !relativeFilePathesToCopy_1_1.done; relativeFilePathesToCopy_1_1 = relativeFilePathesToCopy_1.next()) {
-                var asbFileSourcePath = relativeFilePathesToCopy_1_1.value;
-                if (tnp_helpers_3.Helpers.isFolder(asbFileSourcePath) ||
-                    tnp_helpers_3.Helpers.isSymlinkFileExitedOrUnexisted(asbFileSourcePath)) {
-                    continue;
-                }
-                var relativeFileSourcePath = this.project.relative(asbFileSourcePath);
-                // console.log(
-                //   `(${asyncEvent ? 'async' : 'sync'}) Files changed:`,
-                //   relativeFileSourcePath,
-                // );
-                var isNotInRootMdFile = tnp_core_2.path.basename(asbFileSourcePath) !== relativeFileSourcePath;
-                if (isNotInRootMdFile) {
-                    // console.info('repalcign...');
-                    var contentWithReplacedSomeLinks = tnp_helpers_1.UtilsMd.moveAssetsPathesToLevel(tnp_helpers_3.Helpers.readFile(asbFileSourcePath), 2);
-                    // console.info('repalcign done...');
-                    tnp_helpers_3.Helpers.writeFile(this.project.pathFor([
-                        this.tmpDocsFolderRootDocsDirRelativePath,
-                        relativeFileSourcePath,
-                    ]), contentWithReplacedSomeLinks);
-                }
-                else {
-                    tnp_helpers_3.Helpers.copyFile(asbFileSourcePath, this.project.pathFor([
-                        this.tmpDocsFolderRootDocsDirRelativePath,
-                        relativeFileSourcePath,
-                    ]));
-                }
-                counterCopy++;
-                var assetsFromMdFile = tnp_helpers_1.UtilsMd.getAssets(tnp_helpers_3.Helpers.readFile(asbFileSourcePath));
-                try {
-                    // if (path.basename(asbFilePath) === 'QA.md') {
-                    // console.log(`assets for ${relativeFileSourcePath}`, assetsFromMdFile);
-                    // }
-                    // TODO @LAST add assets to watching list
-                    for (var assetsFromMdFile_1 = (e_2 = void 0, tslib_1.__values(assetsFromMdFile)), assetsFromMdFile_1_1 = assetsFromMdFile_1.next(); !assetsFromMdFile_1_1.done; assetsFromMdFile_1_1 = assetsFromMdFile_1.next()) {
-                        var assetRelativePathFromFile = assetsFromMdFile_1_1.value;
-                        var hasSlash = relativeFileSourcePath.includes('/');
-                        var slash = hasSlash ? '/' : '';
-                        var relativeAssetPath = relativeFileSourcePath.replace(slash + tnp_core_2.path.basename(relativeFileSourcePath), slash + assetRelativePathFromFile);
-                        var assetSourcetAbsPath = this.project.pathFor(relativeAssetPath);
-                        var assetDestLocationAbsPath = this.project.pathFor([
-                            this.tmpDocsFolderRootDocsDirRelativePath,
-                            relativeAssetPath,
-                        ]);
-                        // console.log({
-                        //   assetRelativePathFromFile,
-                        //   relativeAssetPath,
-                        //   relativeFileSourcePath,
-                        //   assetDestAbsPath: assetSourcetAbsPath,
-                        //   assetDestLocationAbsPath,
-                        // });
-                        // console.log(
-                        //   `Copy asset ${assetRelativePathFromFile} ${chalk.bold(relativeAssetPath)} to ${assetDestLocationAbsPath}`,
-                        // );
-                        tnp_helpers_3.Helpers.copyFile(assetSourcetAbsPath, assetDestLocationAbsPath);
-                        counterCopy++;
-                    }
-                }
-                catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                finally {
-                    try {
-                        if (assetsFromMdFile_1_1 && !assetsFromMdFile_1_1.done && (_b = assetsFromMdFile_1.return)) _b.call(assetsFromMdFile_1);
-                    }
-                    finally { if (e_2) throw e_2.error; }
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (relativeFilePathesToCopy_1_1 && !relativeFilePathesToCopy_1_1.done && (_a = relativeFilePathesToCopy_1.return)) _a.call(relativeFilePathesToCopy_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        var asyncInfo = asyncEvent
-            ? "\nRefreshing http://localhost:".concat(this.mkdocsServePort, "..")
-            : '';
-        tnp_helpers_3.Helpers.info("(".concat(asyncEvent ? 'async' : 'sync', ") [").concat(tnp_core_1.Utils.fullDateTime(), "] Copied ").concat(counterCopy, " ") +
-            "files to temp docs folder. ".concat(asyncInfo));
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / get root files
-    Docs.prototype.getRootFiles = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                //#region @backendFunc
-                return [2 /*return*/, tslib_1.__spreadArray([], tslib_1.__read(tnp_helpers_3.Helpers.filesFrom(this.project.location)
-                        .filter(function (f) { return f.toLowerCase().endsWith('.md'); })
-                        .map(function (f) { return tnp_core_2.path.basename(f); })), false).map(function (f) { return ({
-                        title: f.replace('.md', ''),
-                        relativePath: f,
-                        // packageName: this.project.universalPackageName,
-                    }); })];
-            });
-        });
-    };
-    //#endregion
-    //#region private methods / link project to docs folder
-    Docs.prototype.linkProjectToDocsFolder = function (packageName) {
-        //#region @backendFunc
-        var _this = this;
-        if (this.project.universalPackageName === packageName) {
-            // Helpers.warn(
-            //   `Project ${packageName} is the same as current project ${this.project.universalPackageName}`,
-            // );
-            return;
-        }
-        // console.log('packageName', packageName);
-        var orgLocation;
-        try {
-            orgLocation = tnp_core_1.fse.realpathSync((0, tnp_core_2.crossPlatformPath)([
-                tnp_core_2.path.dirname(this.docsConfigGlobalContainerAbsPath),
-                packageName,
-            ]));
-        }
-        catch (error) {
-            tnp_helpers_3.Helpers.error("Not found \"".concat(tnp_core_1.chalk.bold(packageName), "\" in global docs container. ") +
-                "Update your externalDocs.project config.", false, true);
-        }
-        var dest = this.project.pathFor([
-            this.tmpDocsFolderRootDocsDirRelativePath,
-            packageName,
-        ]);
-        if (tnp_helpers_3.Helpers.filesFrom(orgLocation).length === 0) {
-            var nearestProj = this.project.ins.nearestTo(orgLocation);
-            tnp_helpers_3.Helpers.error("Please rebuild docs for this project ".concat(nearestProj === null || nearestProj === void 0 ? void 0 : nearestProj.genericName, "."), false, true);
-        }
-        if (!this.linkedAlreadProjects[orgLocation]) {
-            try {
-                tnp_core_1.fse.unlinkSync(dest);
-            }
-            catch (error) { }
-            tnp_helpers_3.Helpers.createSymLink(orgLocation, dest);
-            // TODO unlink watcher when project no longer in docs-config.json
-            tnp_helpers_3.Helpers.info("Listening changes of external project \"".concat(packageName, "\".."));
-            tnp_core_1.chokidar
-                .watch(this.getTimestampWatcherForPackageName(packageName), {
-                ignoreInitial: true,
-            })
-                .on('all', function () {
-                tnp_helpers_3.Helpers.info("Docs changed  in external project \"".concat(tnp_core_1.chalk.bold(packageName), "\".. rebuilding.."));
-                _this.action({
-                    changeOfFiles: [],
-                    asyncEvent: true,
-                });
-            });
-        }
-        this.linkedAlreadProjects[orgLocation] = true;
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / resolve package data from
-    Docs.prototype.resolvePackageDataFrom = function (packageNameWithPath) {
-        //#region @backendFunc
-        var isRelativePath = packageNameWithPath.startsWith('../') &&
-            packageNameWithPath.startsWith('./');
-        var isNpmOrgPath = packageNameWithPath.startsWith('@');
-        // const isNormalNpmPackagePath = !isRelativePath && !isNpmOrgPath;
-        if (isRelativePath) {
-            tnp_helpers_3.Helpers.error("Relative pathes are not supported: ".concat(this.docsConfigCurrentProjAbsPath), false, true);
-        }
-        var packageName = isNpmOrgPath
-            ? packageNameWithPath.split('/').slice(0, 2).join('/')
-            : tnp_core_2._.first(packageNameWithPath.split('/'));
-        this.linkProjectToDocsFolder(packageName);
-        var destRelativePath = packageNameWithPath
-            .replace(packageName + '/', '')
-            .replace(packageName, '');
-        return { packageName: packageName, destRelativePath: destRelativePath };
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / process md files
-    Docs.prototype.getExternalMdFiles = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var externalMdFiles, externalMdFies, externalMdFies_1, externalMdFies_1_1, file, _a, packageName, destRelativePath, sourceAbsPath, destinationAbsPath, destMagicRelativePath, destinationMagicAbsPath, content, rules, rules_1, rules_1_1, rule;
-            var e_3, _b, e_4, _c;
-            return tslib_1.__generator(this, function (_d) {
-                externalMdFiles = [];
-                externalMdFies = this.config.externalDocs.mdfiles;
-                try {
-                    for (externalMdFies_1 = tslib_1.__values(externalMdFies), externalMdFies_1_1 = externalMdFies_1.next(); !externalMdFies_1_1.done; externalMdFies_1_1 = externalMdFies_1.next()) {
-                        file = externalMdFies_1_1.value;
-                        _a = this.resolvePackageDataFrom(file.packageNameWithPath), packageName = _a.packageName, destRelativePath = _a.destRelativePath;
-                        sourceAbsPath = tnp_core_1.fse.realpathSync((0, tnp_core_2.crossPlatformPath)([
-                            tnp_core_2.path.dirname(this.docsConfigGlobalContainerAbsPath),
-                            packageName,
-                            destRelativePath,
-                        ]));
-                        destinationAbsPath = this.project.pathFor([
-                            this.tmpDocsFolderRootDocsDirRelativePath,
-                            packageName,
-                            destRelativePath,
-                        ]);
-                        destMagicRelativePath = file.overrideTitle
-                            ? file.overrideTitle + '.md'
-                            : (0, tnp_core_2.crossPlatformPath)([packageName, destRelativePath])
-                                .split('/')
-                                .map(function (p) { return tnp_core_2._.kebabCase(p.replace('.md', '')); })
-                                .join('__') + '.md';
-                        destinationMagicAbsPath = this.project.pathFor([
-                            this.tmpDocsFolderRootDocsDirRelativePath,
-                            destMagicRelativePath,
-                        ]);
-                        tnp_helpers_3.Helpers.copyFile(sourceAbsPath, destinationAbsPath);
-                        if (file.magicRenameRules) {
-                            content = tnp_helpers_3.Helpers.readFile(destinationAbsPath);
-                            rules = magic_renamer_1.RenameRule.from(file.magicRenameRules);
-                            try {
-                                for (rules_1 = (e_4 = void 0, tslib_1.__values(rules)), rules_1_1 = rules_1.next(); !rules_1_1.done; rules_1_1 = rules_1.next()) {
-                                    rule = rules_1_1.value;
-                                    content = rule.replaceInString(content);
-                                }
-                            }
-                            catch (e_4_1) { e_4 = { error: e_4_1 }; }
-                            finally {
-                                try {
-                                    if (rules_1_1 && !rules_1_1.done && (_c = rules_1.return)) _c.call(rules_1);
-                                }
-                                finally { if (e_4) throw e_4.error; }
-                            }
-                            tnp_helpers_3.Helpers.writeFile(destinationMagicAbsPath, content);
-                        }
-                        externalMdFiles.push({
-                            // packageName,
-                            relativePath: file.magicRenameRules
-                                ? destMagicRelativePath
-                                : (0, tnp_core_2.crossPlatformPath)([packageName, destRelativePath]),
-                            title: file.overrideTitle
-                                ? file.overrideTitle
-                                : destRelativePath.replace('.md', ''),
-                        });
-                    }
-                }
-                catch (e_3_1) { e_3 = { error: e_3_1 }; }
-                finally {
-                    try {
-                        if (externalMdFies_1_1 && !externalMdFies_1_1.done && (_b = externalMdFies_1.return)) _b.call(externalMdFies_1);
-                    }
-                    finally { if (e_3) throw e_3.error; }
-                }
-                return [2 /*return*/, externalMdFiles];
-            });
-        });
-    };
-    //#endregion
-    //#region private methods / get/process externalDocs.projects files
-    Docs.prototype.getProjectsFiles = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _this = this;
-            return tslib_1.__generator(this, function (_a) {
-                //#region @backendFunc
-                return [2 /*return*/, (this.config.externalDocs.projects || []).map(function (p) {
-                        var _a = _this.resolvePackageDataFrom(Array.isArray(p.packageNameWithPath)
-                            ? tnp_core_2._.first(p.packageNameWithPath)
-                            : p.packageNameWithPath), firstPackageName = _a.packageName, firstDestRelativePath = _a.destRelativePath;
-                        var title = p.overrideTitle
-                            ? p.overrideTitle
-                            : (0, tnp_core_2.crossPlatformPath)([firstPackageName, firstDestRelativePath]);
-                        if (Array.isArray(p.packageNameWithPath)) {
-                            var joinEntrypointName = p.overrideTitle
-                                ? p.overrideTitle + '.md'
-                                : p.packageNameWithPath
-                                    .map(function (p) { return tnp_core_2._.snakeCase(p.replace('.md', '')); })
-                                    .join('__') + '.md';
-                            return {
-                                title: title,
-                                relativePath: joinEntrypointName,
-                                // packageName: p.packageName,
-                                contentToWrite: p.packageNameWithPath
-                                    .map(function (singlePackageNameWithPath) {
-                                    var e_5, _a;
-                                    var _b = _this.resolvePackageDataFrom(singlePackageNameWithPath), packageName = _b.packageName, destRelativePath = _b.destRelativePath;
-                                    var orgLocation = _this.project.universalPackageName === packageName
-                                        ? _this.project.pathFor(_this.tmpDocsFolderRootDocsDirRelativePath)
-                                        : tnp_core_1.fse.realpathSync((0, tnp_core_2.crossPlatformPath)([
-                                            tnp_core_2.path.dirname(_this.docsConfigGlobalContainerAbsPath),
-                                            packageName,
-                                        ]));
-                                    var fileContent = tnp_helpers_3.Helpers.readFile([
-                                        orgLocation,
-                                        destRelativePath,
-                                    ]);
-                                    var exterFileConfig = _this.config.externalDocs.mdfiles.find(function (f) { return f.packageNameWithPath === singlePackageNameWithPath; });
-                                    if (exterFileConfig === null || exterFileConfig === void 0 ? void 0 : exterFileConfig.magicRenameRules) {
-                                        var rules = magic_renamer_1.RenameRule.from(exterFileConfig.magicRenameRules);
-                                        try {
-                                            for (var rules_2 = tslib_1.__values(rules), rules_2_1 = rules_2.next(); !rules_2_1.done; rules_2_1 = rules_2.next()) {
-                                                var rule = rules_2_1.value;
-                                                fileContent = rule.replaceInString(fileContent);
-                                            }
-                                        }
-                                        catch (e_5_1) { e_5 = { error: e_5_1 }; }
-                                        finally {
-                                            try {
-                                                if (rules_2_1 && !rules_2_1.done && (_a = rules_2.return)) _a.call(rules_2);
-                                            }
-                                            finally { if (e_5) throw e_5.error; }
-                                        }
-                                    }
-                                    return fileContent;
-                                })
-                                    .join('\n'),
-                            };
-                        }
-                        return {
-                            title: title,
-                            // packageName: p.packageName,
-                            relativePath: "".concat(firstPackageName, "/") +
-                                "".concat(firstDestRelativePath ? firstDestRelativePath : 'README.md'),
-                        };
-                    })];
-            });
-        });
-    };
-    //#endregion
-    //#region private methods / recreate files in temp folder
-    Docs.prototype.recreateFilesInTempFolder = function (asyncEvent) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var files, rootFiles, externalMdFiles, projectsFiles, mapTitlesNames, allFiles, allFiles_1, allFiles_1_1, projectFile;
-            var e_6, _a;
-            var _this = this;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        files = this.exitedFilesAbsPathes;
-                        this.copyFilesToTempDocsFolder(files, asyncEvent);
-                        return [4 /*yield*/, this.getRootFiles()];
-                    case 1:
-                        rootFiles = _b.sent();
-                        return [4 /*yield*/, this.getExternalMdFiles()];
-                    case 2:
-                        externalMdFiles = _b.sent();
-                        return [4 /*yield*/, this.getProjectsFiles()];
-                    case 3:
-                        projectsFiles = _b.sent();
-                        mapTitlesNames = this.config.mapTitlesNames || {};
-                        allFiles = tslib_1.__spreadArray(tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(rootFiles), false), tslib_1.__read(externalMdFiles), false), tslib_1.__read(projectsFiles), false).map(
-                        //#region allow own packages redirection
-                        // QUICKFIX
-                        function (f) {
-                            if (f.relativePath.startsWith("".concat(_this.project.universalPackageName, "/"))) {
-                                f.relativePath = f.relativePath.replace("".concat(_this.project.universalPackageName, "/"), '');
-                            }
-                            if (mapTitlesNames[f.title]) {
-                                f.title = mapTitlesNames[f.title];
-                            }
-                            else if (mapTitlesNames[f.title.replace('.md', '')]) {
-                                f.title = mapTitlesNames[f.title.replace('.md', '')];
-                            }
-                            else if (mapTitlesNames[f.title + '.md']) {
-                                f.title = mapTitlesNames[f.title + '.md'];
-                            }
-                            return f;
-                        });
-                        try {
-                            //#region write join entrypoint files
-                            for (allFiles_1 = tslib_1.__values(allFiles), allFiles_1_1 = allFiles_1.next(); !allFiles_1_1.done; allFiles_1_1 = allFiles_1.next()) {
-                                projectFile = allFiles_1_1.value;
-                                if ('contentToWrite' in projectFile) {
-                                    this.project.writeFile([this.tmpDocsFolderRootDocsDirRelativePath, projectFile.relativePath], projectFile.contentToWrite);
-                                }
-                            }
-                        }
-                        catch (e_6_1) { e_6 = { error: e_6_1 }; }
-                        finally {
-                            try {
-                                if (allFiles_1_1 && !allFiles_1_1.done && (_a = allFiles_1.return)) _a.call(allFiles_1);
-                            }
-                            finally { if (e_6) throw e_6.error; }
-                        }
-                        //#endregion
-                        this.project.writeFile([this.tmpDocsFolderRoot, 'mkdocs.yml'], this.mkdocsYmlContent(allFiles));
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    //#endregion
-    //#region private methods / write global watcher timestamp
-    Docs.prototype.writeGlobalWatcherTimestamp = function () {
-        //#region @backendFunc
-        tnp_helpers_3.Helpers.writeFile(this.docsGlobalTimestampForWatcherAbsPath, new Date().getTime().toString());
-        //#endregion
-    };
-    //#endregion
-    //#region private methods / get timestamp watcher for package name
-    Docs.prototype.getTimestampWatcherForPackageName = function (universalPackageName) {
-        //#region @backendFunc
-        var globalContainer = this.project.ins.by('container', this.project.__frameworkVersion);
-        return globalContainer.pathFor(".".concat(tnp_config_1.config.frameworkName, "/watcher-timestamps-for/").concat(universalPackageName));
-        //#endregion
-    };
-    return Docs;
-}(tnp_helpers_2.BaseDebounceCompilerForProject));
-exports.Docs = Docs;
-//# sourceMappingURL=docs.js.map