@diplodoc/cli 4.1.0 → 4.2.0

package/src/resolvers/md2html.ts

@@ -8,7 +8,13 @@ import liquid from '@diplodoc/transform/lib/liquid';
 
 import {ResolverOptions, YfmToc, ResolveMd2HTMLResult, LeadingPage} from '../models';
 import {ArgvService, TocService, PluginService} from '../services';
-import {generateStaticMarkup, logger, transformToc, getVarsPerFile, getVarsPerRelativeFile} from '../utils';
+import {
+    generateStaticMarkup,
+    logger,
+    transformToc,
+    getVarsPerFile,
+    getVarsPerRelativeFile,
+} from '../utils';
 import {PROCESSING_FINISHED, Lang} from '../constants';
 import {getAssetsPublicPath, getUpdatedMetadata} from '../services/metadata';
 import {MarkdownItPluginCb} from '@diplodoc/transform/lib/plugins/typings';
@@ -31,9 +37,10 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
     const {inputPath, fileExtension, outputPath, outputBundlePath, metadata} = options;
 
     const pathToDir: string = dirname(inputPath);
-    const toc: YfmToc|null = TocService.getForPath(inputPath) || null;
+    const toc: YfmToc | null = TocService.getForPath(inputPath) || null;
     const tocBase: string = toc && toc.base ? toc.base : '';
-    const pathToFileDir: string = pathToDir === tocBase ? '' : pathToDir.replace(`${tocBase}${sep}`, '');
+    const pathToFileDir: string =
+        pathToDir === tocBase ? '' : pathToDir.replace(`${tocBase}${sep}`, '');
     const relativePathToIndex = relative(pathToDir, `${tocBase}${sep}`);
 
     const {input, lang, allowCustomResources} = ArgvService.getConfig();
@@ -43,17 +50,18 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
     const transformFn: Function = FileTransformer[fileExtension];
     const {result} = transformFn(content, {path: inputPath});
 
-    const updatedMetadata = metadata && metadata.isContributorsEnabled
-        ? await getUpdatedMetadata(metadata, content, result?.meta)
-        : result.meta;
+    const updatedMetadata =
+        metadata && metadata.isContributorsEnabled
+            ? await getUpdatedMetadata(metadata, content, result?.meta)
+            : result.meta;
 
-    const fileMeta = fileExtension === '.yaml' ? (result.data.meta ?? {}) : updatedMetadata;
+    const fileMeta = fileExtension === '.yaml' ? result.data.meta ?? {} : updatedMetadata;
 
     if (allowCustomResources) {
         const {script, style} = metadata?.resources || {};
-        fileMeta.style = (fileMeta.style || []).concat(style || [])
-            .map(fixRelativePath(inputPath));
-        fileMeta.script = (fileMeta.script || []).concat(script || [])
+        fileMeta.style = (fileMeta.style || []).concat(style || []).map(fixRelativePath(inputPath));
+        fileMeta.script = (fileMeta.script || [])
+            .concat(script || [])
             .map(fixRelativePath(inputPath));
     } else {
         fileMeta.style = [];
@@ -98,12 +106,13 @@ function YamlFileTransformer(content: string): Object {
         };
     }
 
-    const links = data?.links?.map(
-        (link) =>
-            link.href ? ({...link, href: link.href.replace(/.md$/gmu, '.html')}) : link,
+    const links = data?.links?.map((link) =>
+        link.href ? {...link, href: link.href.replace(/.md$/gmu, '.html')} : link,
     );
 
-    if (links) { data.links = links; }
+    if (links) {
+        data.links = links;
+    }
 
     return {
         result: {data},
@@ -128,7 +137,6 @@ function MdFileTransformer(content: string, transformOptions: FileTransformOptio
     const root = resolve(input);
     const path: string = resolve(input, filePath);
 
-
     return transform(content, {
         ...options,
         plugins: plugins as MarkdownItPluginCb<unknown>[],

package/src/resolvers/md2md.ts

@@ -50,7 +50,10 @@ export async function resolveMd2Md(options: ResolveMd2MdOptions): Promise<void>
                 changesName = Math.trunc(new Date(changesDate).getTime() / 1000);
             }
             if (!changesName) {
-                changesName = `name-${mdFilename}-${String(changelogs.length - index).padStart(3, '0')}`;
+                changesName = `name-${mdFilename}-${String(changelogs.length - index).padStart(
+                    3,
+                    '0',
+                )}`;
             }
 
             const changesPath = join(outputDir, `changes-${changesName}.json`);
@@ -59,10 +62,13 @@ export async function resolveMd2Md(options: ResolveMd2MdOptions): Promise<void>
                 throw new Error(`Changelog ${changesPath} already exists!`);
             }
 
-            writeFileSync(changesPath, JSON.stringify({
-                ...changes,
-                source: mdFilename,
-            }));
+            writeFileSync(
+                changesPath,
+                JSON.stringify({
+                    ...changes,
+                    source: mdFilename,
+                }),
+            );
         });
     }
 
@@ -85,11 +91,7 @@ function copyFile(targetPath: string, targetDestPath: string, options?: PluginOp
 }
 
 export function liquidMd2Md(input: string, vars: Record<string, unknown>, path: string) {
-    const {
-        applyPresets,
-        resolveConditions,
-        conditionsInCode,
-    } = ArgvService.getConfig();
+    const {applyPresets, resolveConditions, conditionsInCode} = ArgvService.getConfig();
 
     return liquid(input, vars, path, {
         conditions: resolveConditions,
@@ -101,9 +103,7 @@ export function liquidMd2Md(input: string, vars: Record<string, unknown>, path:
 }
 
 function transformMd2Md(input: string, options: PluginOptions) {
-    const {
-        disableLiquid,
-    } = ArgvService.getConfig();
+    const {disableLiquid} = ArgvService.getConfig();
     const {
         vars = {},
         path,

package/src/services/authors.ts

@@ -18,7 +18,6 @@ async function updateAuthorMetadataStringByAuthorLogin(
     return '';
 }
 
-
 async function updateAuthorMetadataStringByFilePath(
     filePath: string,
     vcsConnector?: VCSConnector,
@@ -37,7 +36,10 @@ async function updateAuthorMetadataStringByFilePath(
     return '';
 }
 
-async function getAuthorDetails(vcsConnector: VCSConnector, author: string | object): Promise<string | null> {
+async function getAuthorDetails(
+    vcsConnector: VCSConnector,
+    author: string | object,
+): Promise<string | null> {
     if (typeof author === 'object') {
         // Avoiding problems when adding to html markup
         return replaceDoubleToSingleQuotes(JSON.stringify(author));

package/src/services/contributors.ts

@@ -6,17 +6,24 @@ import {REGEXP_INCLUDE_CONTENTS, REGEXP_INCLUDE_FILE_PATH} from '../constants';
 import {Contributor, Contributors, FileData} from '../models';
 import {FileContributors, VCSConnector} from '../vcs-connector/connector-models';
 
-async function getFileContributorsMetadata(fileData: FileData, vcsConnector: VCSConnector): Promise<string> {
+async function getFileContributorsMetadata(
+    fileData: FileData,
+    vcsConnector: VCSConnector,
+): Promise<string> {
     const contributors = await getFileContributorsString(fileData, vcsConnector);
 
     return `contributors: ${contributors}`;
 }
 
-async function getFileContributorsString(fileData: FileData, vcsConnector: VCSConnector): Promise<string> {
+async function getFileContributorsString(
+    fileData: FileData,
+    vcsConnector: VCSConnector,
+): Promise<string> {
     const {tmpInputFilePath, inputFolderPathLength} = fileData;
 
     const relativeFilePath = tmpInputFilePath.substring(inputFolderPathLength);
-    const fileContributors: FileContributors = await vcsConnector.getContributorsByPath(relativeFilePath);
+    const fileContributors: FileContributors =
+        await vcsConnector.getContributorsByPath(relativeFilePath);
     let nestedContributors: Contributors = {};
 
     if (!fileContributors.hasIncludes) {
@@ -29,13 +36,17 @@ async function getFileContributorsString(fileData: FileData, vcsConnector: VCSCo
         ...nestedContributors,
     };
 
-    const contributorsArray: Contributor[] =
-        Object.entries(fileContributorsWithContributorsIncludedFiles).map(([, contributor]) => contributor);
+    const contributorsArray: Contributor[] = Object.entries(
+        fileContributorsWithContributorsIncludedFiles,
+    ).map(([, contributor]) => contributor);
 
     return replaceDoubleToSingleQuotes(JSON.stringify(contributorsArray));
 }
 
-async function getContributorsForNestedFiles(fileData: FileData, vcsConnector: VCSConnector): Promise<Contributors> {
+async function getContributorsForNestedFiles(
+    fileData: FileData,
+    vcsConnector: VCSConnector,
+): Promise<Contributors> {
     const {fileContent, inputFolderPathLength} = fileData;
 
     const includeContents = fileContent.match(REGEXP_INCLUDE_CONTENTS);
@@ -44,7 +55,10 @@ async function getContributorsForNestedFiles(fileData: FileData, vcsConnector: V
     }
 
     const includesContributors: Contributors[] = [];
-    const relativeIncludeFilePaths: Set<string> = getRelativeIncludeFilePaths(fileData, includeContents);
+    const relativeIncludeFilePaths: Set<string> = getRelativeIncludeFilePaths(
+        fileData,
+        includeContents,
+    );
 
     for (const relativeIncludeFilePath of relativeIncludeFilePaths.values()) {
         const relativeFilePath = relativeIncludeFilePath.substring(inputFolderPathLength);
@@ -89,7 +103,10 @@ function getRelativeIncludeFilePaths(fileData: FileData, includeContents: string
 
         if (relativeIncludeFilePath && relativeIncludeFilePath.length !== 0) {
             const relativeIncludeFilePathWithoutHash = relativeIncludeFilePath[0].split('#');
-            const includeFilePath = join(dirname(tmpInputFilePath), relativeIncludeFilePathWithoutHash[0]);
+            const includeFilePath = join(
+                dirname(tmpInputFilePath),
+                relativeIncludeFilePathWithoutHash[0],
+            );
 
             relativeIncludeFilePaths.add(includeFilePath);
         }
@@ -98,7 +115,4 @@ function getRelativeIncludeFilePaths(fileData: FileData, includeContents: string
     return relativeIncludeFilePaths;
 }
 
-export {
-    getFileContributorsMetadata,
-    getFileContributorsString,
-};
+export {getFileContributorsMetadata, getFileContributorsString};

package/src/services/includers/batteries/common.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-const {promises: {readdir}} = require('fs');
+const {
+    promises: {readdir},
+} = require('fs');
 
 async function getDirs(path: string) {
     const isDir = (i: any) => i.isDirectory();
@@ -31,4 +33,14 @@ function concatNewLine(prefix: string, suffix: string) {
     return prefix.trim().length ? `${prefix}<br>${suffix}` : suffix;
 }
 
-export {complement, isMdExtension, isHidden, allPass, compose, prop, getDirs, getFiles, concatNewLine};
+export {
+    complement,
+    isMdExtension,
+    isHidden,
+    allPass,
+    compose,
+    prop,
+    getDirs,
+    getFiles,
+    concatNewLine,
+};

package/src/services/includers/batteries/generic.ts

@@ -31,7 +31,14 @@ type Params = {
 };
 
 async function includerFunction(params: IncluderFunctionParams<Params>) {
-    const {readBasePath, writeBasePath, tocPath, item, passedParams: {input, leadingPage}, index} = params;
+    const {
+        readBasePath,
+        writeBasePath,
+        tocPath,
+        item,
+        passedParams: {input, leadingPage},
+        index,
+    } = params;
 
     if (!input?.length || !item.include?.path) {
         throw new GenericIncluderError('provide includer with input parameter', tocPath);
@@ -42,14 +49,17 @@ async function includerFunction(params: IncluderFunctionParams<Params>) {
 
         const tocDirPath = dirname(tocPath);
 
-        const contentPath = index === 0
-            ? join(writeBasePath, tocDirPath, input)
-            : join(readBasePath, tocDirPath, input);
+        const contentPath =
+            index === 0
+                ? join(writeBasePath, tocDirPath, input)
+                : join(readBasePath, tocDirPath, input);
 
         let cache = {};
         let found = [];
 
-        ({state: {found, cache}} = await glob(MD_GLOB, {
+        ({
+            state: {found, cache},
+        } = await glob(MD_GLOB, {
             cwd: contentPath,
             nosort: true,
             nocase: true,
@@ -93,9 +103,14 @@ function createGraphFromPaths(paths: string[]) {
 
         const file = chunks.pop();
 
-        updateWith(graph, chunks, (old) => {
-            return old ? {files: [...old.files, file]} : {files: [file]};
-        }, Object);
+        updateWith(
+            graph,
+            chunks,
+            (old) => {
+                return old ? {files: [...old.files, file]} : {files: [file]};
+            },
+            Object,
+        );
     }
 
     return graph;
@@ -103,7 +118,10 @@ function createGraphFromPaths(paths: string[]) {
 
 function createToc(leadingPageName: string, tocName: string) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return function createTocRec(graph: Record<string, any>, cursor: string[]): Record<string, any> {
+    return function createTocRec(
+        graph: Record<string, any>,
+        cursor: string[],
+    ): Record<string, any> {
         const handler = (file: string) => ({
             name: parse(file).name === 'index' ? leadingPageName : file,
             href: join(...cursor, file),

package/src/services/includers/batteries/sourcedocs.ts

@@ -23,7 +23,10 @@ type Params = {
 };
 
 async function includerFunction(params: IncluderFunctionParams<Params>) {
-    logger.warn(params.tocPath, `sourcedocs inlcuder is getting depricated in favor of generic includer\n${usage}`);
+    logger.warn(
+        params.tocPath,
+        `sourcedocs inlcuder is getting depricated in favor of generic includer\n${usage}`,
+    );
 
     await generic.includerFunction(params);
 }

package/src/services/includers/batteries/unarchive.ts

@@ -73,15 +73,19 @@ type Params = {
 };
 
 async function includerFunction(params: IncluderFunctionParams<Params>) {
-    const {readBasePath, writeBasePath, tocPath, passedParams: {input, output}, index} = params;
+    const {
+        readBasePath,
+        writeBasePath,
+        tocPath,
+        passedParams: {input, output},
+        index,
+    } = params;
 
     if (!input?.length || !output?.length) {
         throw new UnarchiveIncluderError('provide includer with input parameter', tocPath);
     }
 
-    const contentPath = index === 0
-        ? join(writeBasePath, input)
-        : join(readBasePath, input);
+    const contentPath = index === 0 ? join(writeBasePath, input) : join(readBasePath, input);
 
     const writePath = join(writeBasePath, output);
 

package/src/services/includers/index.ts

@@ -40,7 +40,9 @@ class IncludersError extends Error {
 }
 
 function init(custom: Includer[] = []) {
-    if (includersMap) { return; }
+    if (includersMap) {
+        return;
+    }
 
     includersMap = {generic, sourcedocs, unarchive};
 
@@ -55,7 +57,7 @@ async function applyIncluders(path: string, item: YfmToc, vars: YfmPreset) {
     }
 
     if (!includeValid(item.include)) {
-        throw new IncludersError('include doesn\'t comply with includers standard', path);
+        throw new IncludersError("include doesn't comply with includers standard", path);
     }
 
     // normalize include mode (includers support link mode only)
@@ -126,7 +128,7 @@ function includerExists(includer: YfmTocIncluder) {
     return includersMap[includer.name as keyof typeof includersMap];
 }
 
-export type applyIncluderParams = {
+export type ApplyIncluderParams = {
     path: string;
     item: YfmToc;
     includer: Includer;
@@ -136,7 +138,7 @@ export type applyIncluderParams = {
     vars: YfmPreset;
 };
 
-async function applyIncluder(args: applyIncluderParams) {
+async function applyIncluder(args: ApplyIncluderParams) {
     const {rootInput: readBasePath, input: writeBasePath} = ArgvService.getConfig();
 
     const {path, item, includer, passedParams, index, vars} = args;

package/src/services/leading.ts

@@ -5,13 +5,16 @@ import log from '@diplodoc/transform/lib/log';
 
 import {ArgvService, PresetService} from './index';
 import {LeadingPage} from '../models';
-import {filterTextItems, filterFiles, firstFilterTextItems, liquidFields, liquidField} from './utils';
+import {
+    filterTextItems,
+    filterFiles,
+    firstFilterTextItems,
+    liquidFields,
+    liquidField,
+} from './utils';
 
 function filterFile(path: string) {
-    const {
-        input: inputFolderPath,
-        vars,
-    } = ArgvService.getConfig();
+    const {input: inputFolderPath, vars} = ArgvService.getConfig();
 
     const pathToDir = dirname(path);
     const filePath = resolve(inputFolderPath, path);
@@ -25,26 +28,20 @@ function filterFile(path: string) {
 
     /* Should remove all links with false expressions */
     try {
-        const title = firstFilterTextItems(
-            parsedIndex.title,
-            combinedVars,
-            {resolveConditions: true},
-        );
+        const title = firstFilterTextItems(parsedIndex.title, combinedVars, {
+            resolveConditions: true,
+        });
         parsedIndex.title = liquidField(title, combinedVars, path);
 
-        const description = filterTextItems(
-            parsedIndex.description,
-            combinedVars,
-            {resolveConditions: true},
-        );
+        const description = filterTextItems(parsedIndex.description, combinedVars, {
+            resolveConditions: true,
+        });
         parsedIndex.description = liquidFields(description, combinedVars, path);
 
         if (parsedIndex.meta?.title) {
-            const metaTitle = firstFilterTextItems(
-                parsedIndex.meta.title,
-                combinedVars,
-                {resolveConditions: true},
-            );
+            const metaTitle = firstFilterTextItems(parsedIndex.meta.title, combinedVars, {
+                resolveConditions: true,
+            });
             parsedIndex.meta.title = liquidField(metaTitle, combinedVars, path);
         }
 
@@ -58,15 +55,15 @@ function filterFile(path: string) {
         }
 
         if (parsedIndex.nav) {
-            const navTitle = firstFilterTextItems(
-                parsedIndex.nav.title,
-                combinedVars,
-                {resolveConditions: true},
-            );
+            const navTitle = firstFilterTextItems(parsedIndex.nav.title, combinedVars, {
+                resolveConditions: true,
+            });
             parsedIndex.nav.title = liquidField(navTitle, combinedVars, path);
         }
 
-        parsedIndex.links = filterFiles(parsedIndex.links, 'links', combinedVars, {resolveConditions: true});
+        parsedIndex.links = filterFiles(parsedIndex.links, 'links', combinedVars, {
+            resolveConditions: true,
+        });
 
         parsedIndex.links.forEach((link) => {
             if (link.title) {

package/src/services/metadata.ts

@@ -35,7 +35,12 @@ async function getContentWithUpdatedMetadata(
 }
 
 function getContentWithUpdatedStaticMetadata({
-    fileContent, sourcePath, addSystemMeta, addSourcePath, resources, systemVars,
+    fileContent,
+    sourcePath,
+    addSystemMeta,
+    addSourcePath,
+    resources,
+    systemVars,
 }: {
     fileContent: string;
     sourcePath?: string;
@@ -105,14 +110,22 @@ async function getContentWithUpdatedDynamicMetadata(
             const matchAuthor = fileMetadata.match(REGEXP_AUTHOR);
             if (matchAuthor) {
                 const matchedAuthor = matchAuthor[0];
-                authorMetadata = await updateAuthorMetadataStringByAuthorLogin(matchedAuthor, options.vcsConnector);
+                authorMetadata = await updateAuthorMetadataStringByAuthorLogin(
+                    matchedAuthor,
+                    options.vcsConnector,
+                );
             }
         }
 
         if (!authorMetadata) {
-            const {fileData: {tmpInputFilePath, inputFolderPathLength}} = options;
+            const {
+                fileData: {tmpInputFilePath, inputFolderPathLength},
+            } = options;
             const relativeFilePath = tmpInputFilePath.substring(inputFolderPathLength);
-            authorMetadata = await updateAuthorMetadataStringByFilePath(relativeFilePath, options.vcsConnector);
+            authorMetadata = await updateAuthorMetadataStringByFilePath(
+                relativeFilePath,
+                options.vcsConnector,
+            );
         }
 
         if (authorMetadata) {
@@ -158,7 +171,8 @@ function matchMetadata(fileContent: string) {
 }
 
 async function getContributorsMetadataString(
-    options: MetaDataOptions, fileContent: string,
+    options: MetaDataOptions,
+    fileContent: string,
 ): Promise<string | undefined> {
     const {isContributorsEnabled, vcsConnector, fileData} = options;
 
@@ -180,10 +194,16 @@ function getUpdatedMetadataString(newMetadatas: string[], defaultMetadata = ''):
     const defaultMetadataСarriage = preparedDefaultMetadata ? сarriage : '';
     const updatedMetadata = `${preparedDefaultMetadata}${defaultMetadataСarriage}${newMetadata}`;
 
-    return `${metadataBorder}${сarriage}${updatedMetadata}${metadataBorder}${defaultMetadata.length ? '' : сarriage}`;
+    return `${metadataBorder}${сarriage}${updatedMetadata}${metadataBorder}${
+        defaultMetadata.length ? '' : сarriage
+    }`;
 }
 
-async function getUpdatedMetadata(options: MetaDataOptions, fileContent: string, meta?: Metadata): Promise<Metadata> {
+async function getUpdatedMetadata(
+    options: MetaDataOptions,
+    fileContent: string,
+    meta?: Metadata,
+): Promise<Metadata> {
     const {vcsConnector} = options;
 
     const newMetadata: Metadata = {
@@ -203,7 +223,10 @@ async function getUpdatedMetadata(options: MetaDataOptions, fileContent: string,
     };
 }
 
-async function getContributorsMetadata(options: MetaDataOptions, fileContent: string): Promise<string> {
+async function getContributorsMetadata(
+    options: MetaDataOptions,
+    fileContent: string,
+): Promise<string> {
     const {isContributorsEnabled, vcsConnector, fileData} = options;
 
     if (isContributorsEnabled && vcsConnector) {
@@ -218,7 +241,10 @@ async function getContributorsMetadata(options: MetaDataOptions, fileContent: st
     return JSON.stringify([]);
 }
 
-async function getAuthorMetadata(meta: Metadata, vcsConnector?: VCSConnector): Promise<string | null> {
+async function getAuthorMetadata(
+    meta: Metadata,
+    vcsConnector?: VCSConnector,
+): Promise<string | null> {
     if (meta.author && vcsConnector) {
         const updatedAuthor = await getAuthorDetails(vcsConnector, meta.author);
 
@@ -232,7 +258,6 @@ function getSystemVarsMetadataString(systemVars: object) {
     return `__system: ${JSON.stringify(systemVars)}`;
 }
 
-
 function getAssetsPublicPath(filePath: string) {
     const {input} = ArgvService.getConfig();
     const path: string = resolve(input, filePath);

package/src/services/preset.ts

@@ -8,8 +8,8 @@ let presetStorage: PresetStorage = new Map();
 
 function add(parsedPreset: DocPreset, path: string, varsPreset: string) {
     const combinedValues: YfmPreset = {
-        ...parsedPreset.default || {},
-        ...parsedPreset[varsPreset] || {},
+        ...(parsedPreset.default || {}),
+        ...(parsedPreset[varsPreset] || {}),
     };
 
     const key = dirname(normalize(path));