feat: support metadata

diplodoc-platform · Jan 17, 2024 · edb6412 · edb6412
1 parent 253ccd1
commit edb6412
Show file tree

Hide file tree

Showing 27 changed files with 473 additions and 103 deletions.
diff --git a/.eslintrc b/.eslintrc
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,11 @@
+module.exports = {
+    "extends": ["@diplodoc/eslint-config"],
+    "root": true,
+    parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: ['./tsconfig.json'],
+      },
+    "env": {
+        "node": true
+    }
+}
diff --git a/src/cmd/build/index.ts b/src/cmd/build/index.ts
@@ -197,8 +197,13 @@ async function handler(args: Arguments<any>) {
             addMapFile,
             allowCustomResources,
             resources,
+            metadata,
         } = ArgvService.getConfig();
 
+        if (typeof metadata !== 'undefined' && !Array.isArray(metadata)) {
+            ArgvService.patch('metadata', [metadata]);
+        }
+
         preparingTemporaryFolders(userOutputFolder);
 
         await processServiceFiles();
@@ -242,9 +247,9 @@ async function handler(args: Arguments<any>) {
                         // collect paths of all resources
                         Object.keys(resources).forEach(
                             (type) =>
-                                resources[type as keyof Resources]?.forEach((path: string) =>
-                                    resourcePaths.push(path),
-                                ),
+                                resources[type as keyof Resources]?.forEach((path) => {
+                                    resourcePaths.push(path);
+                                }),
                         );
 
                         //copy resources

diff --git a/src/models.ts b/src/models.ts
@@ -41,6 +41,7 @@ interface YfmConfig {
     buildDisabled: boolean;
     lintConfig: LintConfig;
     resources?: Resources;
+    metadata?: Record<string, string>[];
     yandexCloudTranslateFolderId: string;
     yandexCloudTranslateGlossaryPairs: YandexCloudTranslateGlossaryPair[];
 }
@@ -241,7 +242,7 @@ export interface PathData {
 }
 
 export type Resources = {
-    [key in ResourceType]?: string[];
+    [type in ResourceType]?: string[];
 };
 
 export type YandexCloudTranslateGlossaryPair = {

diff --git a/src/resolvers/md2html.ts b/src/resolvers/md2html.ts
@@ -43,7 +43,7 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
         pathToDir === tocBase ? '' : pathToDir.replace(`${tocBase}${sep}`, '');
     const relativePathToIndex = relative(pathToDir, `${tocBase}${sep}`);
 
-    const {input, lang, allowCustomResources} = ArgvService.getConfig();
+    const {input, lang, allowCustomResources, metadata: yfmMetadata = []} = ArgvService.getConfig();
     const resolvedPath: string = resolve(input, inputPath);
     const content: string = readFileSync(resolvedPath, 'utf8');
 
@@ -61,6 +61,12 @@ export async function resolveMd2HTML(options: ResolverOptions): Promise<ResolveM
 
     const fileMeta = fileExtension === '.yaml' ? result.data.meta ?? {} : updatedMetadata;
 
+    if (Array.isArray(fileMeta?.metadata)) {
+        fileMeta.metadata.push(...yfmMetadata);
+    } else {
+        fileMeta.metadata = yfmMetadata;
+    }
+
     if (allowCustomResources) {
         const {script, style} = metadata?.resources || {};
         fileMeta.style = (fileMeta.style || []).concat(style || []).map(fixRelativePath(inputPath));

diff --git a/src/resolvers/md2md.ts b/src/resolvers/md2md.ts
@@ -13,14 +13,15 @@ import {ChangelogItem} from '@diplodoc/transform/lib/plugins/changelog/types';
 
 export async function resolveMd2Md(options: ResolveMd2MdOptions): Promise<void> {
     const {inputPath, outputPath, metadata} = options;
-    const {input, output} = ArgvService.getConfig();
+    const {input, output, metadata: yfmMetadata} = ArgvService.getConfig();
     const resolvedInputPath = resolve(input, inputPath);
     const vars = getVarsPerFile(inputPath);
 
     const content = await getContentWithUpdatedMetadata(
         readFileSync(resolvedInputPath, 'utf8'),
         metadata,
         vars.__system,
+        yfmMetadata,
     );
 
     const {result, changelogs} = transformMd2Md(content, {

diff --git a/src/services/argv.ts b/src/services/argv.ts
@@ -31,8 +31,13 @@ function set(argv: YfmArgv) {
     _argv = argv;
 }
 
+function patch<Key extends keyof YfmArgv>(field: Key, value: YfmArgv[Key]) {
+    _argv[field] = value;
+}
+
 export default {
     getConfig,
     init,
     set,
+    patch,
 };
diff --git a/src/services/metadata.ts b/src/services/metadata.ts
@@ -1,4 +1,4 @@
-import {dump} from 'js-yaml';
+import {dump, load} from 'js-yaml';
 
 import {VCSConnector} from '../vcs-connector/connector-models';
 import {MetaDataOptions, Metadata, Resources} from '../models';
@@ -22,6 +22,7 @@ async function getContentWithUpdatedMetadata(
     fileContent: string,
     options?: MetaDataOptions,
     systemVars?: unknown,
+    yfmMetadata?: Record<string, string>[],
 ): Promise<string> {
     let result;
 
@@ -32,7 +33,9 @@ async function getContentWithUpdatedMetadata(
         addSourcePath: options?.addSourcePath,
         resources: options?.resources,
         systemVars,
+        yfmMetadata,
     });
+
     result = await getContentWithUpdatedDynamicMetadata(result, options);
 
     return result;
@@ -45,17 +48,24 @@ function getContentWithUpdatedStaticMetadata({
     addSourcePath,
     resources,
     systemVars,
+    yfmMetadata = [],
 }: {
     fileContent: string;
     sourcePath?: string;
     addSystemMeta?: boolean;
     addSourcePath?: boolean;
     resources?: Resources;
     systemVars?: unknown;
+    yfmMetadata?: Record<string, string>[];
 }): string {
     const newMetadatas: string[] = [];
 
-    if ((!addSystemMeta || !systemVars) && !addSourcePath && !resources) {
+    if (
+        (!addSystemMeta || !systemVars) &&
+        !addSourcePath &&
+        !resources &&
+        yfmMetadata.length === 0
+    ) {
         return fileContent;
     }
 
@@ -76,8 +86,21 @@ function getContentWithUpdatedStaticMetadata({
 
     if (matches && matches.length > 0) {
         const [, fileMetadata, , fileMainContent] = matches;
+        const parsed = load(fileMetadata) as any;
+
+        if (Array.isArray(parsed.metadata)) {
+            parsed.metadata = [...yfmMetadata, ...parsed.metadata];
+        } else if (parsed.metadata) {
+            parsed.metadata = [...yfmMetadata, parsed.metadata];
+        }
+
+        const patchedMetada = dump(parsed);
+
+        return `${getUpdatedMetadataString(newMetadatas, patchedMetada)}${fileMainContent}`;
+    }
 
-        return `${getUpdatedMetadataString(newMetadatas, fileMetadata)}${fileMainContent}`;
+    if (yfmMetadata.length) {
+        newMetadatas.push(dump({metadata: yfmMetadata}));
     }
 
     return `${getUpdatedMetadataString(newMetadatas)}${fileContent}`;

diff --git a/src/utils/markup.ts b/src/utils/markup.ts
@@ -1,34 +1,40 @@
 import {join} from 'path';
 import {platform} from 'process';
 
-import {CUSTOM_STYLE, Platforms, ResourceType} from '../constants';
-import {Resources, SinglePageResult} from '../models';
+import {CUSTOM_STYLE, Platforms} from '../constants';
+import {LeadingPage, Resources, SinglePageResult, TextItems} from '../models';
 import {ArgvService, PluginService} from '../services';
 import {preprocessPageHtmlForSinglePage} from './singlePage';
 
 import {DocInnerProps, DocPageData, render} from '@diplodoc/client/ssr';
 import manifest from '@diplodoc/client/manifest';
 
 const dst = (bundlePath: string) => (target: string) => join(bundlePath, target);
+export const сarriage = platform === Platforms.WINDOWS ? '\r\n' : '\n';
 
 export interface TitleMeta {
     title?: string;
 }
-export type Meta = TitleMeta & Resources;
+type YfmMetadata = {
+    metadata: Record<string, string>[];
+};
+
+export type Meta = TitleMeta & Resources & YfmMetadata;
 
 export function generateStaticMarkup(
     props: DocInnerProps<DocPageData>,
     pathToBundle: string,
 ): string {
-    const {title: metaTitle, style, script} = (props.data.meta as Meta) || {};
+    const {style, script, metadata, ...restYamlConfigMeta} = (props.data.meta as Meta) || {};
     const {title: tocTitle} = props.data.toc;
     const {title: pageTitle} = props.data;
 
     const title = getTitle({
-        metaTitle,
+        metaTitle: props.data.meta.title,
         tocTitle: tocTitle as string,
         pageTitle,
     });
+
     const resources = getResources({style, script});
 
     const {staticContent} = ArgvService.getConfig();
@@ -40,7 +46,7 @@ export function generateStaticMarkup(
         <html lang="${props.lang}">
             <head>
                 <meta charset="utf-8">
-                ${getMetadata(props.data.meta as Record<string, string>)}
+                ${getMetadata(metadata, restYamlConfigMeta)}
                 <meta name="viewport" content="width=device-width, initial-scale=1.0">
                 <title>${title}</title>
                 <style type="text/css">
@@ -93,21 +99,35 @@ function getTitle({tocTitle, metaTitle, pageTitle}: GetTitleOptions) {
     return resultPageTitle && tocTitle ? `${resultPageTitle} | ${tocTitle}` : '';
 }
 
-function getMetadata(metadata: Record<string, string>): string {
-    if (!metadata) {
-        return '';
+type Metadata = Record<string, string>[];
+
+function getMetadata(metadata: Metadata | undefined, restMeta: LeadingPage['meta']): string {
+    let result = '';
+
+    const addMetaTagsFromObject = (value: Record<string, string | boolean | TextItems>) => {
+        const args = Object.entries(value).reduce(
+            (acc, [field, content]) => acc + `${field}="${content}" `,
+            '',
+        );
+
+        if (args.length) {
+            result += `<meta ${args}/>` + сarriage;
+        }
+    };
+
+    if (metadata) {
+        metadata.forEach(addMetaTagsFromObject);
     }
 
-    // Exclude resources from meta, proceed them separately
-    const metaEntries = Object.entries(metadata).filter(
-        ([key]) => !Object.keys(ResourceType).includes(key),
-    );
+    if (restMeta) {
+        Object.entries(restMeta)
+            .map(([name, value]) => {
+                return {name, content: value};
+            })
+            .forEach(addMetaTagsFromObject);
+    }
 
-    return metaEntries
-        .map(([name, content]) => {
-            return `<meta name="${name}" content="${content}">`;
-        })
-        .join('\n');
+    return result;
 }
 
 function getResources({style, script}: Resources) {
@@ -130,8 +150,6 @@ function getResources({style, script}: Resources) {
     return resourcesTags.join('\n');
 }
 
-export const сarriage = platform === Platforms.WINDOWS ? '\r\n' : '\n';
-
 export function joinSinglePageResults(
     singlePageResults: SinglePageResult[],
     root: string,