feat: allow load custom resources (#184)

* feat: allow load custom resources * tests for loading custom resources * misc refactor * generate relative paths only for html mode * fix: md2md add meta only core resource path * chore(rebase): change args source
diplodoc-platform · Oct 27, 2022 · 80c6624 · 80c6624
1 parent 7f4e908
commit 80c6624
Show file tree

Hide file tree

Showing 55 changed files with 754 additions and 38 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -30,6 +30,7 @@ export const REDIRECTS_FILENAME = 'redirects.yaml';
 export const LINT_CONFIG_FILENAME = '.yfmlint';
 export const SINGLE_PAGE_FILENAME = 'single-page.html';
 export const SINGLE_PAGE_DATA_FILENAME = 'single-page.json';
+export const CUSTOM_STYLE = 'custom-style';
 
 export enum Stage {
     NEW = 'new',
@@ -55,6 +56,11 @@ export enum IncludeMode {
     LINK = 'link'
 }
 
+export enum ResourceType {
+    style = 'style',
+    script = 'script',
+}
+
 export const BUILD_FOLDER_PATH = dirname(process.mainModule?.filename || '');
 
 export const YFM_PLUGINS = [

diff --git a/src/index.ts b/src/index.ts
@@ -28,6 +28,8 @@ import {
 import {ArgvService, Includers} from './services';
 import {argvValidator} from './validator';
 import {prepareMapFile} from './steps/processMapFile';
+import {copyFiles} from './utils';
+import {Resources} from './models';
 
 console.time(MAIN_TIMER_ID);
 
@@ -136,6 +138,11 @@ yargs
         describe: 'Disable building',
         type: 'boolean',
     })
+    .option('allow-custom-resources', {
+        default: false,
+        describe: 'Allow loading custom resources',
+        type: 'boolean',
+    })
     .check(argvValidator)
     .example('yfm -i ./input -o ./output', '')
     .demandOption(['input', 'output'], 'Please provide input and output arguments to work with this tool')
@@ -168,6 +175,8 @@ async function main(args: Arguments<any>) {
             lintDisabled,
             buildDisabled,
             addMapFile,
+            allowCustomResources,
+            resources,
         } = ArgvService.getConfig();
 
         preparingTemporaryFolders(args, userOutputFolder, tmpInputFolder, tmpOutputFolder);
@@ -207,6 +216,17 @@ async function main(args: Arguments<any>) {
                     shell.cp(resolve(pathToRedirects), tmpOutputFolder);
                     shell.cp(resolve(pathToLintConfig), tmpOutputFolder);
 
+                    if (resources && allowCustomResources) {
+                        const resourcePaths: string[] = [];
+
+                        // collect paths of all resources
+                        Object.keys(resources).forEach((type) =>
+                            resources[type as keyof Resources]?.forEach((path: string) => resourcePaths.push(path)));
+
+                        //copy resources
+                        copyFiles(args.input, tmpOutputFolder, resourcePaths);
+                    }
+
                     break;
                 }
             }

diff --git a/src/models.ts b/src/models.ts
@@ -2,7 +2,7 @@ import {Logger} from '@doc-tools/transform/lib/log';
 import {LintConfig} from '@doc-tools/transform/lib/yfmlint';
 
 import {FileContributors, VCSConnector, VCSConnectorConfig} from './vcs-connector/connector-models';
-import {Lang, Stage, IncludeMode} from './constants';
+import {Lang, Stage, IncludeMode, ResourceType} from './constants';
 
 export type VarsPreset = 'internal'|'external';
 
@@ -33,6 +33,7 @@ interface YfmConfig {
     lintDisabled: boolean;
     buildDisabled: boolean;
     lintConfig: LintConfig;
+    resources?: Resources;
 }
 
 export interface YfmArgv extends YfmConfig {
@@ -49,6 +50,7 @@ export interface YfmArgv extends YfmConfig {
     contributors: boolean;
     addSystemMeta: boolean;
     addMapFile: boolean;
+    allowCustomResources: boolean;
 }
 
 export interface DocPreset {
@@ -158,6 +160,7 @@ export interface MetaDataOptions {
     vcsConnector?: VCSConnector;
     addSystemMeta?: boolean;
     addSourcePath?: boolean;
+    resources?: Resources;
 }
 
 export interface PluginOptions {
@@ -221,3 +224,7 @@ export interface ResolveMd2HTMLResult {
     };
     lang: Lang;
 }
+
+export type Resources = {
+    [key in ResourceType]?: string[];
+};
diff --git a/src/resolvers/md2html.ts b/src/resolvers/md2html.ts
@@ -10,7 +10,7 @@ import {ResolverOptions, YfmToc, ResolveMd2HTMLResult} from '../models';
 import {ArgvService, TocService, PluginService} from '../services';
 import {generateStaticMarkup, logger, transformToc, getVarsPerFile, getVarsPerRelativeFile} from '../utils';
 import {PROCESSING_FINISHED, Lang} from '../constants';
-import {getUpdatedMetadata} from '../services/metadata';
+import {getAssetsPublicPath, getUpdatedMetadata} from '../services/metadata';
 
 export interface FileTransformOptions {
     path: string;
@@ -31,7 +31,7 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
     const pathToFileDir: string = pathToDir === tocBase ? '' : pathToDir.replace(`${tocBase}${sep}`, '');
     const relativePathToIndex = relative(pathToDir, `${tocBase}${sep}`);
 
-    const {input, lang} = ArgvService.getConfig();
+    const {input, lang, allowCustomResources} = ArgvService.getConfig();
     const resolvedPath: string = resolve(input, inputPath);
     const content: string = readFileSync(resolvedPath, 'utf8');
 
@@ -42,12 +42,18 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
         ? await getUpdatedMetadata(metadata, content, result?.meta)
         : result.meta;
 
+    let fileMeta = fileExtension === '.yaml' ? result.data.meta : updatedMetadata;
+
+    if (allowCustomResources && metadata?.resources) {
+        fileMeta = {...fileMeta, ...metadata?.resources};
+    }
+
     const props = {
         data: {
             leading: inputPath.endsWith('.yaml'),
             toc: transformToc(toc, pathToDir) || {},
             ...result,
-            meta: updatedMetadata,
+            meta: fileMeta,
         },
         router: {
             pathname: join(relativePathToIndex, pathToFileDir, basename(outputPath)),
@@ -104,16 +110,14 @@ function MdFileTransformer(content: string, transformOptions: FileTransformOptio
     const root = resolve(input);
     const path: string = resolve(input, filePath);
 
-    /* Relative path from folder of .md file to root of user' output folder */
-    const assetsPublicPath = relative(dirname(path), resolve(input));
 
     return transform(content, {
         ...options,
         plugins,
         vars,
         root,
         path,
-        assetsPublicPath,
+        assetsPublicPath: getAssetsPublicPath(filePath),
         getVarsPerFile: getVarsPerRelativeFile,
         extractTitle: true,
     });

diff --git a/src/services/metadata.ts b/src/services/metadata.ts
@@ -1,10 +1,14 @@
+import {dump} from 'js-yaml';
+
 import {VCSConnector} from '../vcs-connector/connector-models';
-import {Metadata, MetaDataOptions} from '../models';
+import {Metadata, MetaDataOptions, Resources} from '../models';
 import {getAuthorDetails, updateAuthorMetadataString} from './authors';
 import {getFileContributorsMetadata, getFileContributorsString} from './contributors';
 import {isObject} from './utils';
 import {сarriage} from '../utils';
-import {metadataBorder} from '../constants';
+import {metadataBorder, ResourceType} from '../constants';
+import {dirname, join, relative, resolve} from 'path';
+import {ArgvService} from './index';
 
 async function getContentWithUpdatedMetadata(
     fileContent: string,
@@ -24,19 +28,24 @@ function getContentWithUpdatedStaticMetadata(
     options?: MetaDataOptions,
     systemVars?: unknown,
 ): string {
-    if (!options || (!options?.addSystemMeta || !systemVars) && !options?.addSourcePath) {
+    const newMetadatas: string[] = [];
+
+    if (!options || (!options?.addSystemMeta || !systemVars) && !options?.addSourcePath && !options.resources) {
         return fileContent;
     }
 
     const matches = matchMetadata(fileContent);
-    const newMetadatas: string[] = [];
 
     const {addSystemMeta, addSourcePath, fileData} = options;
 
     if (addSystemMeta && systemVars && isObject(systemVars)) {
         newMetadatas.push(getSystemVarsMetadataString(systemVars));
     }
 
+    if (options.resources) {
+        newMetadatas.push(dump(options.resources));
+    }
+
     if (addSourcePath && fileData.sourcePath) {
         const sourcePathMetadataString = `sourcePath: ${fileData.sourcePath}`;
         newMetadatas.push(sourcePathMetadataString);
@@ -181,8 +190,31 @@ function getSystemVarsMetadataString(systemVars: object) {
     return `__system: ${JSON.stringify(systemVars)}`;
 }
 
+
+function getAssetsPublicPath(filePath: string) {
+    const {input} = ArgvService.getConfig();
+    const path: string = resolve(input, filePath);
+
+    /* Relative path from folder of .md file to root of user' output folder */
+    return relative(dirname(path), resolve(input));
+}
+
+function getResolvedResourcePaths(resources: Resources, assetsPublicPath: string) {
+    const metaResources = {...resources};
+
+    for (const type of Object.keys(metaResources) as Array<keyof typeof ResourceType>) {
+        metaResources[type] = metaResources[type]?.map((el) => {
+            return join(assetsPublicPath, el);
+        });
+    }
+
+    return metaResources;
+}
+
 export {
     getContentWithUpdatedMetadata,
     getContentWithUpdatedStaticMetadata,
     getUpdatedMetadata,
+    getResolvedResourcePaths,
+    getAssetsPublicPath,
 };
diff --git a/src/steps/processAssets.ts b/src/steps/processAssets.ts
@@ -1,11 +1,10 @@
 import walkSync from 'walk-sync';
-import {dirname, resolve} from 'path';
+import {resolve} from 'path';
 import shell from 'shelljs';
-import {copyFileSync} from 'fs';
 
 import {BUNDLE_FILENAME, BUILD_FOLDER_PATH} from '../constants';
 import {ArgvService} from '../services';
-import {logger} from '../utils';
+import {copyFiles} from '../utils';
 
 /**
  * Processes assets files (everything except .yaml and .md files)
@@ -27,16 +26,7 @@ export function processAssets(outputBundlePath: string) {
         ],
     });
 
-    for (const pathToAsset of assetFilePath) {
-        const outputDir: string = resolve(outputFolderPath, dirname(pathToAsset));
-        const from = resolve(inputFolderPath, pathToAsset);
-        const to = resolve(outputFolderPath, pathToAsset);
-
-        shell.mkdir('-p', outputDir);
-        copyFileSync(from, to);
-
-        logger.copy(pathToAsset);
-    }
+    copyFiles(inputFolderPath, outputFolderPath, assetFilePath);
 
     /* Copy js bundle to user' output folder */
     const sourceBundlePath = resolve(BUILD_FOLDER_PATH, BUNDLE_FILENAME);