feat: resolve vcsPath correctly when sourcePath was supplied befo…

…rehand, refactor metadata generation procedures
diplodoc-platform · Jul 11, 2024 · 568f43b · 568f43b
1 parent ad1b879
commit 568f43b
Show file tree

Hide file tree

Showing 23 changed files with 833 additions and 783 deletions.
diff --git a/src/models.ts b/src/models.ts
@@ -230,7 +230,6 @@ export interface MetaDataOptions {
     isContributorsEnabled?: boolean;
     vcsConnector?: VCSConnector;
     addSystemMeta?: boolean;
-    addSourcePath?: boolean;
     resources?: Resources;
     shouldAlwaysAddVCSPath?: boolean;
 }

diff --git a/src/resolvers/md2md.ts b/src/resolvers/md2md.ts
@@ -8,30 +8,32 @@ import {ArgvService, PluginService} from '../services';
 import {getVarsPerFile, logger} from '../utils';
 import {PluginOptions, ResolveMd2MdOptions} from '../models';
 import {PROCESSING_FINISHED} from '../constants';
-import {getContentWithUpdatedMetadata} from '../services/metadata';
 import {ChangelogItem} from '@diplodoc/transform/lib/plugins/changelog/types';
+import {enrichWithFrontMatter} from '../services/metadata';
 
 export async function resolveMd2Md(options: ResolveMd2MdOptions): Promise<void> {
     const {inputPath, outputPath, metadata: metadataOptions} = options;
     const {input, output, changelogs: changelogsSetting} = ArgvService.getConfig();
     const resolvedInputPath = resolve(input, inputPath);
 
-    const varsPreset = getVarsPerFile(inputPath);
+    const vars = getVarsPerFile(inputPath);
 
-    const content = await getContentWithUpdatedMetadata(
-        readFileSync(resolvedInputPath, 'utf8'),
+    const content = await enrichWithFrontMatter({
+        fileContent: readFileSync(resolvedInputPath, 'utf8'),
         metadataOptions,
-        varsPreset.__system as unknown,
-        varsPreset.__metadata,
-    );
+        resolvedFrontMatterVars: {
+            systemVars: vars.__system as unknown,
+            metadataVars: vars.__metadata,
+        },
+    });
 
     const {result, changelogs} = transformMd2Md(content, {
         path: resolvedInputPath,
         destPath: outputPath,
         root: resolve(input),
         destRoot: resolve(output),
         collectOfPlugins: PluginService.getCollectOfPlugins(),
-        vars: varsPreset,
+        vars: vars,
         log,
         copyFile,
     });

diff --git a/src/services/authors.ts b/src/services/authors.ts
@@ -1,12 +1,12 @@
-import {replaceDoubleToSingleQuotes} from '../utils';
+import {Contributor} from '../models';
 import {VCSConnector} from '../vcs-connector/connector-models';
 
-async function updateAuthorMetadataStringByAuthorLogin(
-    authorLogin: string,
+async function updateAuthorMetadataStringByAuthorData(
+    authorLogin: string | object,
     vcsConnector?: VCSConnector,
-): Promise<string> {
+): Promise<Contributor | null> {
     if (!vcsConnector) {
-        return '';
+        return null;
     }
 
     const user = await getAuthorDetails(vcsConnector, authorLogin);
@@ -15,52 +15,49 @@ async function updateAuthorMetadataStringByAuthorLogin(
         return user;
     }
 
-    return '';
+    return null;
 }
 
 async function updateAuthorMetadataStringByFilePath(
     filePath: string,
     vcsConnector?: VCSConnector,
-): Promise<string> {
+): Promise<Contributor | null> {
     if (!vcsConnector) {
-        return '';
+        return null;
     }
 
     const user = vcsConnector.getExternalAuthorByPath(filePath);
 
     if (user) {
-        const author = replaceDoubleToSingleQuotes(JSON.stringify(user));
-        return author;
+        return user;
     }
 
-    return '';
+    return null;
 }
 
 async function getAuthorDetails(
     vcsConnector: VCSConnector,
     author: string | object,
-): Promise<string | null> {
+): Promise<Contributor | null> {
     if (typeof author === 'object') {
-        // Avoiding problems when adding to html markup
-        return replaceDoubleToSingleQuotes(JSON.stringify(author));
+        return author as Contributor;
     }
 
     try {
-        JSON.parse(author);
-        return replaceDoubleToSingleQuotes(author);
+        return JSON.parse(author);
     } catch {
         const user = await vcsConnector.getUserByLogin(author);
 
         if (user) {
-            return replaceDoubleToSingleQuotes(JSON.stringify(user));
+            return user;
         }
 
         return null;
     }
 }
 
 export {
-    updateAuthorMetadataStringByAuthorLogin,
+    updateAuthorMetadataStringByAuthorData as updateAuthorMetadataStringByAuthorLogin,
     updateAuthorMetadataStringByFilePath,
     getAuthorDetails,
 };
diff --git a/src/services/contributors.ts b/src/services/contributors.ts
@@ -1,7 +1,5 @@
 import {readFile} from 'fs/promises';
 import {dirname, join} from 'path';
-
-import {replaceDoubleToSingleQuotes} from '../utils';
 import {REGEXP_INCLUDE_CONTENTS, REGEXP_INCLUDE_FILE_PATH} from '../constants';
 import {Contributor, Contributors} from '../models';
 import {FileContributors, VCSConnector} from '../vcs-connector/connector-models';
@@ -12,19 +10,10 @@ export interface ContributorsServiceFileData {
     fileContent: string;
 }
 
-async function getFileContributorsMetadata(
+export async function getFileContributors(
     fileData: ContributorsServiceFileData,
     vcsConnector: VCSConnector,
-): Promise<string> {
-    const contributors = await getFileContributorsString(fileData, vcsConnector);
-
-    return `contributors: ${contributors}`;
-}
-
-async function getFileContributorsString(
-    fileData: ContributorsServiceFileData,
-    vcsConnector: VCSConnector,
-): Promise<string> {
+): Promise<Contributor[]> {
     const {resolvedFilePath, inputFolderPathLength} = fileData;
 
     const relativeFilePath = resolvedFilePath.substring(inputFolderPathLength);
@@ -46,7 +35,7 @@ async function getFileContributorsString(
         fileContributorsWithContributorsIncludedFiles,
     ).map(([, contributor]) => contributor);
 
-    return replaceDoubleToSingleQuotes(JSON.stringify(contributorsArray));
+    return contributorsArray;
 }
 
 async function getContributorsForNestedFiles(
@@ -123,7 +112,7 @@ function getRelativeIncludeFilePaths(
     return relativeIncludeFilePaths;
 }
 
-async function getFileIncludes(fileData: ContributorsServiceFileData) {
+export async function getFileIncludes(fileData: ContributorsServiceFileData) {
     const {fileContent, inputFolderPathLength} = fileData;
 
     const results = new Set<string>();
@@ -161,5 +150,3 @@ async function getFileIncludes(fileData: ContributorsServiceFileData) {
 
     return Array.from(results.values());
 }
-
-export {getFileContributorsMetadata, getFileContributorsString, getFileIncludes};