@ng-doc/builder 15.0.0-beta.31 → 15.0.0-beta.33

package/engine/.cache/libs/builder/helpers/declaration-to-playground.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.declarationToPlayground = void 0;
-const typescript_1 = require("./typescript");
-/**
- *
- * @param declaration
- */
-function declarationToPlayground(declaration) {
-    return declaration
-        .getProperties()
-        .filter((property) => !!property.getDecorator('Input'))
-        .reduce((properties, property) => {
-        const inputName = property
-            .getDecorator('Input')
-            ?.getArguments()[0]
-            ?.getText()
-            .replace(/^["']|['"]$/g, '') ?? property.getName();
-        properties[inputName] = {
-            name: property.getName(),
-            type: (0, typescript_1.displayType)(property.getType()),
-            default: property.getInitializer()?.getText(),
-            description: property
-                .getJsDocs()
-                .reduce((comment, doc) => `${comment}\n${doc.getCommentText()}`.trim(), ''),
-            options: property
-                .getType()
-                .getUnionTypes()
-                .map((type) => type.getText()),
-        };
-        return properties;
-    }, {});
-}
-exports.declarationToPlayground = declarationToPlayground;

package/engine/.cache/libs/builder/helpers/emit-built-output.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.emitBuiltOutput = void 0;
-const fs = require("fs");
-const path = require("path");
-/**
- *
- * @param {...any} outputs
- */
-function emitBuiltOutput(...outputs) {
-    outputs.forEach((output) => {
-        fs.mkdirSync(path.dirname(output.filePath), { recursive: true });
-        fs.writeFileSync(output.filePath, output.content);
-    });
-}
-exports.emitBuiltOutput = emitBuiltOutput;

package/engine/.cache/libs/builder/helpers/entity-type.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRouteEntity = exports.isApiScopeEntity = exports.isApiPageEntity = exports.isApiEntity = exports.isNavigationEntity = exports.isPlaygroundEntity = exports.isCategoryEntity = exports.isDependencyEntity = exports.isPageEntity = void 0;
-const engine_1 = require("../engine");
-const navigation_entity_1 = require("../engine/entities/abstractions/navigation.entity");
-const route_entity_1 = require("../engine/entities/abstractions/route.entity");
-/**
- *
- * @param page
- */
-function isPageEntity(page) {
-    return page instanceof engine_1.NgDocPageEntity;
-}
-exports.isPageEntity = isPageEntity;
-/**
- *
- * @param dependency
- */
-function isDependencyEntity(dependency) {
-    return dependency instanceof engine_1.NgDocDependenciesEntity;
-}
-exports.isDependencyEntity = isDependencyEntity;
-/**
- *
- * @param page
- */
-function isCategoryEntity(page) {
-    return page instanceof engine_1.NgDocCategoryEntity;
-}
-exports.isCategoryEntity = isCategoryEntity;
-/**
- *
- * @param page
- */
-function isPlaygroundEntity(page) {
-    return page instanceof engine_1.NgDocPlaygroundEntity;
-}
-exports.isPlaygroundEntity = isPlaygroundEntity;
-/**
- *
- * @param page
- */
-function isNavigationEntity(page) {
-    return page instanceof navigation_entity_1.NgDocNavigationEntity;
-}
-exports.isNavigationEntity = isNavigationEntity;
-/**
- *
- * @param page
- */
-function isApiEntity(page) {
-    return page instanceof engine_1.NgDocApiEntity;
-}
-exports.isApiEntity = isApiEntity;
-/**
- *
- * @param page
- */
-function isApiPageEntity(page) {
-    return page instanceof engine_1.NgDocApiPageEntity;
-}
-exports.isApiPageEntity = isApiPageEntity;
-/**
- *
- * @param page
- */
-function isApiScopeEntity(page) {
-    return page instanceof engine_1.NgDocApiScopeEntity;
-}
-exports.isApiScopeEntity = isApiScopeEntity;
-/**
- *
- * @param page
- */
-function isRouteEntity(page) {
-    return page instanceof route_entity_1.NgDocRouteEntity;
-}
-exports.isRouteEntity = isRouteEntity;

package/engine/.cache/libs/builder/helpers/extract-docs.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractParameterDocs = exports.extractSeeDocs = exports.extractDocs = void 0;
-const tsdoc_1 = require("@microsoft/tsdoc");
-const core_1 = require("@ng-doc/core");
-const ts_doc_formatter_1 = require("../engine/ts-doc-formatter");
-const marked_1 = require("./marked");
-/**
- *
- * @param node
- * @param section
- * @param customTag
- */
-function extractDocs(node, customTag) {
-    const jsDocs = (0, core_1.asArray)(node.getJsDocs()[0]);
-    const parser = new tsdoc_1.TSDocParser(getTsDocConfiguration());
-    const docs = jsDocs.map((doc) => {
-        const context = parser.parseString(doc.getText());
-        return customTag
-            ? ts_doc_formatter_1.TsDocFormatter.renderDocNodes(context.docComment.customBlocks.filter((block) => block.blockTag.tagName === customTag))
-            : ts_doc_formatter_1.TsDocFormatter.renderDocNode(context.docComment.summarySection);
-    }).join('');
-    return (0, marked_1.marked)(docs);
-}
-exports.extractDocs = extractDocs;
-/**
- *
- * @param node
- */
-function extractSeeDocs(node) {
-    const jsDocs = (0, core_1.asArray)(node.getJsDocs()[0]);
-    const parser = new tsdoc_1.TSDocParser(getTsDocConfiguration());
-    return jsDocs.map((jsDoc) => {
-        const context = parser.parseString(jsDoc.getText());
-        return context.docComment.seeBlocks
-            .map((seeBlock) => ts_doc_formatter_1.TsDocFormatter.renderDocNode(seeBlock))
-            .map(marked_1.marked);
-    }).flat();
-}
-exports.extractSeeDocs = extractSeeDocs;
-/**
- *
- * @param node
- * @param paramName
- */
-function extractParameterDocs(node, paramName) {
-    const jsDocs = (0, core_1.asArray)(node.getJsDocs()[0]);
-    const parser = new tsdoc_1.TSDocParser(getTsDocConfiguration());
-    const docs = jsDocs.map((doc) => {
-        const context = parser.parseString(doc.getText());
-        const paramBlock = context.docComment.params.tryGetBlockByName(paramName);
-        return paramBlock ? ts_doc_formatter_1.TsDocFormatter.renderDocNode(paramBlock.content) : '';
-    }).join('');
-    return (0, marked_1.marked)(docs);
-}
-exports.extractParameterDocs = extractParameterDocs;
-/**
- *
- */
-function getTsDocConfiguration() {
-    const customTags = [
-        new tsdoc_1.TSDocTagDefinition({ tagName: '@usageNotes', syntaxKind: tsdoc_1.TSDocTagSyntaxKind.BlockTag, allowMultiple: false })
-    ];
-    const configuration = new tsdoc_1.TSDocConfiguration();
-    customTags.forEach((tag) => configuration.addTagDefinition(tag));
-    return configuration;
-}

package/engine/.cache/libs/builder/helpers/extract-path-anchor.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractPathAnchor = void 0;
-/**
- * Extract path anchor from a given path
- *
- * @param {string} path - The path to extract anchor from
- * @returns {NgDocPathAnchor} The extracted anchor
- */
-function extractPathAnchor(path) {
-    const pathParts = path.split('#');
-    return {
-        path: pathParts[0] ?? '',
-        anchor: pathParts[1] ?? '',
-    };
-}
-exports.extractPathAnchor = extractPathAnchor;

package/engine/.cache/libs/builder/helpers/extract-selectors.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractSelectors = void 0;
-const ts_morph_1 = require("ts-morph");
-const component_decorator_resolver_1 = require("../resolvers/component-decorator.resolver");
-/**
- *
- * @param declaration
- */
-function extractSelectors(declaration) {
-    if (ts_morph_1.Node.isClassDeclaration(declaration)) {
-        const decorator = declaration.getDecorator('Component') ?? declaration.getDecorator('Directive');
-        if (decorator) {
-            const expression = decorator.getArguments()[0];
-            if (ts_morph_1.Node.isObjectLiteralExpression(expression)) {
-                const selector = (0, component_decorator_resolver_1.componentDecoratorResolver)(expression).selector ?? '';
-                return selector.split(',').map((s) => s.trim());
-            }
-        }
-    }
-    return [];
-}
-exports.extractSelectors = extractSelectors;

package/engine/.cache/libs/builder/helpers/filter-useless-members.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterUselessMembers = void 0;
-const EXCLUDING_RULES = [/^ɵ/];
-/**
- * Excludes from the passed array members that have names that are not important to the end user
- *
- * @param members - List of members
- */
-function filterUselessMembers(members) {
-    return members.filter((member) => !EXCLUDING_RULES.every((rule) => rule.test(member.getName())));
-}
-exports.filterUselessMembers = filterUselessMembers;

package/engine/.cache/libs/builder/helpers/find-closest-file.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findClosestFile = void 0;
-const fs = require("fs");
-const path = require("path");
-/**
- *	Finds the closest file in the given path.
- *
- * @param {string} currentFolder The current folder to search in.
- * @param {string} fileName The file name to search for.
- * @returns {string} The path to the closest file.
- */
-function findClosestFile(currentFolder, fileName) {
-    const currentPath = currentFolder;
-    const filePath = path.join(currentPath, fileName);
-    if (fs.existsSync(filePath)) {
-        return filePath;
-    }
-    const parentPath = path.dirname(currentPath);
-    if (['/', '.', ''].includes(parentPath)) {
-        return null;
-    }
-    return findClosestFile(parentPath, fileName);
-}
-exports.findClosestFile = findClosestFile;

package/engine/.cache/libs/builder/helpers/format-code.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatCode = void 0;
-/**
- *	Format code with Prettier
- *
- * @param {string} code Code to format
- * @param {NgDocCodeType} codeType Type of code
- * @returns {string} Formatted code
- */
-function formatCode(code, codeType) {
-    try {
-        const parser = getPrettierParserFromCodeType(codeType);
-        return require('prettier').format(code, parser ? { parser } : {});
-    }
-    catch (e) {
-        return code;
-    }
-}
-exports.formatCode = formatCode;
-/**
- *	Returns the parser for the given code type.
- *
- * @param {NgDocCodeType} codeType Code type
- * @returns {string} Parser
- */
-function getPrettierParserFromCodeType(codeType) {
-    switch (codeType) {
-        case 'CSS':
-        case 'LESS':
-        case 'SCSS':
-        case 'SASS':
-            return 'css';
-        default:
-            return codeType.toLowerCase();
-    }
-}

package/engine/.cache/libs/builder/helpers/generate-api-entities.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateApiEntities = void 0;
-const core_1 = require("@ng-doc/core");
-const glob = require("glob");
-const engine_1 = require("../engine");
-const is_not_excluded_path_1 = require("./is-not-excluded-path");
-const is_supported_declaration_1 = require("./is-supported-declaration");
-// one file - sourceFile.getNodesReferencingOtherSourceFiles()[0].getModuleSpecifierSourceFile().getNodesReferencingOtherSourceFiles()
-/**
- *
- * @param apiRootEntity
- */
-function generateApiEntities(apiRootEntity) {
-    const result = [];
-    apiRootEntity.target?.scopes.forEach((scope) => {
-        const scopeEntity = new engine_1.NgDocApiScopeEntity(apiRootEntity.builder, apiRootEntity.sourceFile, apiRootEntity.context, apiRootEntity, scope);
-        result.push(scopeEntity);
-        (0, core_1.asArray)(scope.include).forEach((include) => (0, core_1.asArray)(new Set(apiRootEntity.sourceFile
-            .getProject()
-            .addSourceFilesAtPaths(glob.sync(include).filter((p) => (0, is_not_excluded_path_1.isNotExcludedPath)(p, (0, core_1.asArray)(scope.exclude))))
-            .map((sourceFile) => (0, core_1.asArray)(sourceFile.getExportedDeclarations().values()))
-            .flat(2)))
-            .filter(is_supported_declaration_1.isSupportedDeclaration)
-            .forEach((declaration) => {
-            const name = declaration.getName();
-            if (name) {
-                result.push(new engine_1.NgDocApiPageEntity(apiRootEntity.builder, declaration.getSourceFile(), apiRootEntity.context, scopeEntity, name));
-            }
-        }));
-    });
-    return result;
-}
-exports.generateApiEntities = generateApiEntities;

package/engine/.cache/libs/builder/helpers/get-declaration-type.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeclarationType = void 0;
-const core_1 = require("@ng-doc/core");
-/**
- *
- * @param node
- */
-function getDeclarationType(node) {
-    for (const declaration of core_1.NgDocDeclarations) {
-        if (node?.getKindName().includes(declaration)) {
-            return declaration;
-        }
-    }
-    return undefined;
-}
-exports.getDeclarationType = getDeclarationType;

package/engine/.cache/libs/builder/helpers/get-entity-constructor.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEntityConstructor = void 0;
-const minimatch_1 = require("minimatch");
-const engine_1 = require("../engine");
-/**
- *
- * @param path
- */
-function getEntityConstructor(path) {
-    if ((0, minimatch_1.default)(path, engine_1.PAGE_PATTERN)) {
-        return engine_1.NgDocPageEntity;
-    }
-    else if ((0, minimatch_1.default)(path, engine_1.CATEGORY_PATTERN)) {
-        return engine_1.NgDocCategoryEntity;
-    }
-    else if ((0, minimatch_1.default)(path, engine_1.PAGE_DEPENDENCY_PATTERN)) {
-        return engine_1.NgDocDependenciesEntity;
-    }
-    else if ((0, minimatch_1.default)(path, engine_1.API_PATTERN)) {
-        return engine_1.NgDocApiEntity;
-    }
-    else if ((0, minimatch_1.default)(path, engine_1.PLAYGROUND_PATTERN)) {
-        return engine_1.NgDocPlaygroundEntity;
-    }
-    else {
-        throw new Error(`Unknown entity type for path: ${path}`);
-    }
-}
-exports.getEntityConstructor = getEntityConstructor;

package/engine/.cache/libs/builder/helpers/get-keyword-type-from-entity.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKeywordTypeFromEntity = void 0;
-const entity_type_1 = require("./entity-type");
-const get_kind_type_1 = require("./get-kind-type");
-/**
- *
- * @param entity
- */
-function getKeywordTypeFromEntity(entity) {
-    if ((0, entity_type_1.isApiPageEntity)(entity)) {
-        const kindType = entity.declaration && (0, get_kind_type_1.getKindType)(entity.declaration);
-        return kindType ?? 'api';
-    }
-    if ((0, entity_type_1.isPageEntity)(entity)) {
-        return 'guideline';
-    }
-    return undefined;
-}
-exports.getKeywordTypeFromEntity = getKeywordTypeFromEntity;

package/engine/.cache/libs/builder/helpers/get-kind-type.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKindType = void 0;
-const core_1 = require("@ng-doc/core");
-const ts_morph_1 = require("ts-morph");
-const get_declaration_type_1 = require("./get-declaration-type");
-/**
- *
- * @param node
- */
-function getKindType(node) {
-    if (ts_morph_1.Node.isClassDeclaration(node)) {
-        for (const decorator of core_1.NgDocAngularEntities) {
-            if (node.getDecorator(decorator)) {
-                return decorator;
-            }
-        }
-    }
-    return (0, get_declaration_type_1.getDeclarationType)(node);
-}
-exports.getKindType = getKindType;

package/engine/.cache/libs/builder/helpers/index.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./build-assets"), exports);
-tslib_1.__exportStar(require("./code-type-from-ext"), exports);
-tslib_1.__exportStar(require("./create-builder-context"), exports);
-tslib_1.__exportStar(require("./declaration-folder-name"), exports);
-tslib_1.__exportStar(require("./declaration-to-playground"), exports);
-tslib_1.__exportStar(require("./emit-built-output"), exports);
-tslib_1.__exportStar(require("./entity-type"), exports);
-tslib_1.__exportStar(require("./extract-docs"), exports);
-tslib_1.__exportStar(require("./extract-path-anchor"), exports);
-tslib_1.__exportStar(require("./extract-selectors"), exports);
-tslib_1.__exportStar(require("./filter-useless-members"), exports);
-tslib_1.__exportStar(require("./find-closest-file"), exports);
-tslib_1.__exportStar(require("./format-code"), exports);
-tslib_1.__exportStar(require("./generate-api-entities"), exports);
-tslib_1.__exportStar(require("./get-declaration-type"), exports);
-tslib_1.__exportStar(require("./get-entity-constructor"), exports);
-tslib_1.__exportStar(require("./get-keyword-type-from-entity"), exports);
-tslib_1.__exportStar(require("./get-kind-type"), exports);
-tslib_1.__exportStar(require("./is-not-excluded-path"), exports);
-tslib_1.__exportStar(require("./is-supported-declaration"), exports);
-tslib_1.__exportStar(require("./marked"), exports);
-tslib_1.__exportStar(require("./no-empty"), exports);
-tslib_1.__exportStar(require("./no-line-breaks"), exports);
-tslib_1.__exportStar(require("./not-empty-assets"), exports);
-tslib_1.__exportStar(require("./presentation"), exports);
-tslib_1.__exportStar(require("./print-console"), exports);
-tslib_1.__exportStar(require("./process-snippets"), exports);
-tslib_1.__exportStar(require("./slash"), exports);
-tslib_1.__exportStar(require("./typescript"), exports);
-tslib_1.__exportStar(require("./unique-name"), exports);

package/engine/.cache/libs/builder/helpers/is-not-excluded-path.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNotExcludedPath = void 0;
-const core_1 = require("@ng-doc/core");
-const minimatch_1 = require("minimatch");
-/**
- *
- * @param path
- * @param excluded
- */
-function isNotExcludedPath(path, excluded) {
-    return (0, core_1.asArray)(excluded).every((e) => !(0, minimatch_1.default)(path, e));
-}
-exports.isNotExcludedPath = isNotExcludedPath;

package/engine/.cache/libs/builder/helpers/is-supported-declaration.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSupportedDeclaration = void 0;
-const ts_morph_1 = require("ts-morph");
-/**
- *
- * @param declaration
- */
-function isSupportedDeclaration(declaration) {
-    return ts_morph_1.Node.isClassDeclaration(declaration)
-        || ts_morph_1.Node.isInterfaceDeclaration(declaration)
-        || ts_morph_1.Node.isEnumDeclaration(declaration)
-        || ts_morph_1.Node.isFunctionDeclaration(declaration)
-        || ts_morph_1.Node.isVariableDeclaration(declaration)
-        || ts_morph_1.Node.isTypeAliasDeclaration(declaration)
-        || ts_morph_1.Node.isModuleDeclaration(declaration);
-}
-exports.isSupportedDeclaration = isSupportedDeclaration;

package/engine/.cache/libs/builder/helpers/marked.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.marked = void 0;
-const core_1 = require("@ng-doc/core");
-const marked_1 = require("marked");
-const NOTE_ANCHOR = '<p><strong>Note</strong>';
-const WARNING_ANCHOR = '<p><strong>Warning</strong>';
-/**
- *
- * @param this
- * @param markdown
- */
-function marked(markdown) {
-    const renderer = {
-        code(code, language) {
-            const lang = language ?? 'typescript';
-            return `<pre><code class="language-${lang}" lang="${lang}">${(0, core_1.escapeHtml)(code)}</code></pre>`;
-        },
-        blockquote(quote) {
-            if (new RegExp(`^${NOTE_ANCHOR}`).test(quote)) {
-                return `<ng-doc-blockquote type="note">${quote.replace(new RegExp(`^${NOTE_ANCHOR}\\s*`), '<p>')}</ng-doc-blockquote>`;
-            }
-            if (new RegExp(`^${WARNING_ANCHOR}`).test(quote)) {
-                return `<ng-doc-blockquote type="warning">${quote.replace(new RegExp(`^${WARNING_ANCHOR}\\s*`), '<p>')}</ng-doc-blockquote>`;
-            }
-            return `<ng-doc-blockquote>${quote}</ng-doc-blockquote>`;
-        },
-    };
-    marked_1.marked.use({ renderer });
-    return marked_1.marked.parse(markdown);
-}
-exports.marked = marked;

package/engine/.cache/libs/builder/helpers/no-empty.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noEmpty = void 0;
-const core_1 = require("@ng-doc/core");
-/**
- *
- * @param arr
- */
-function noEmpty(arr) {
-    return arr.filter(core_1.isPresent);
-}
-exports.noEmpty = noEmpty;

package/engine/.cache/libs/builder/helpers/no-line-breaks.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noLineBreaks = void 0;
-/**
- *
- * @param str
- */
-function noLineBreaks(str) {
-    return str.replace(/[\r\n]/gm, '');
-}
-exports.noLineBreaks = noLineBreaks;

package/engine/.cache/libs/builder/helpers/not-empty-assets.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.notEmptyAssets = void 0;
-/**
- *
- * @param assets
- */
-function notEmptyAssets(assets) {
-    return assets.filter((assets) => !!assets.code.trim());
-}
-exports.notEmptyAssets = notEmptyAssets;