feat: bump transform to 4.32.2, use transform metadata utilities

package.json

@@ -49,7 +49,7 @@
     "@diplodoc/mermaid-extension": "^1.2.1",
     "@diplodoc/openapi-extension": "^2.3.4",
     "@diplodoc/prettier-config": "^2.0.0",
-    "@diplodoc/transform": "^4.31.3",
+    "@diplodoc/transform": "^4.32.2",
     "@diplodoc/tsconfig": "^1.0.2",
     "@octokit/core": "4.2.4",
     "@types/async": "^3.2.15",

src/services/metadata/addSourcePath.ts

@@ -1,11 +1,19 @@
-import {parseExistingMetadata} from './parse';
-import {emplaceMetadata} from './utils';
+import {
+    emplaceFrontMatter,
+    separateAndExtractFrontMatter,
+} from '@diplodoc/transform/lib/frontmatter';
+import {normalizeLineEndings} from './utils';
 
 export const addSourcePath = (fileContent: string, sourcePath: string) => {
-    const {metadata, metadataStrippedContent} = parseExistingMetadata(fileContent, sourcePath);
-
-    return emplaceMetadata(metadataStrippedContent, {
-        ...metadata,
+    const {frontMatter, frontMatterStrippedContent} = separateAndExtractFrontMatter(
+        fileContent,
         sourcePath,
-    });
+    );
+
+    return normalizeLineEndings(
+        emplaceFrontMatter(frontMatterStrippedContent, {
+            ...frontMatter,
+            sourcePath,
+        }),
+    );
 };

src/services/metadata/enrich.ts

@@ -1,8 +1,12 @@
 import {MetaDataOptions, VarsMetadata} from '../../models';
-import {mergeMetadata} from './mergeMetadata';
-import {FileMetadata, parseExistingMetadata} from './parse';
-import {emplaceMetadata} from './utils';
+import {mergeFrontMatter} from './mergeMetadata';
+import {FrontMatter} from '@diplodoc/transform/lib/frontmatter/common';
 import {resolveVCSFrontMatter} from './vcsMetadata';
+import {
+    emplaceFrontMatter,
+    separateAndExtractFrontMatter,
+} from '@diplodoc/transform/lib/frontmatter';
+import {normalizeLineEndings} from './utils';
 
 type FrontMatterVars = {
     metadataVars?: VarsMetadata;
@@ -15,8 +19,8 @@ type EnrichWithFrontMatterOptions = {
     resolvedFrontMatterVars: FrontMatterVars;
 };
 
-const resolveVCSPath = (metadata: FileMetadata, relativeInputPath: string) => {
-    const maybePreProcessedSourcePath = metadata.sourcePath;
+const resolveVCSPath = (frontMatter: FrontMatter, relativeInputPath: string) => {
+    const maybePreProcessedSourcePath = frontMatter.sourcePath;
 
     return typeof maybePreProcessedSourcePath === 'string' && maybePreProcessedSourcePath.length > 0
         ? maybePreProcessedSourcePath
@@ -31,29 +35,29 @@ export const enrichWithFrontMatter = async ({
     const {systemVars, metadataVars} = resolvedFrontMatterVars;
     const {resources, addSystemMeta, shouldAlwaysAddVCSPath, pathData} = metadataOptions;
 
-    const {metadata, metadataStrippedContent} = parseExistingMetadata(
+    const {frontMatter, frontMatterStrippedContent} = separateAndExtractFrontMatter(
         fileContent,
         pathData.pathToFile,
     );
 
     const vcsFrontMatter = metadataOptions.isContributorsEnabled
-        ? await resolveVCSFrontMatter(metadata, metadataOptions, fileContent)
+        ? await resolveVCSFrontMatter(frontMatter, metadataOptions, fileContent)
         : undefined;
 
-    const mergedMetadata = mergeMetadata({
-        existingMetadata: metadata,
+    const mergedFrontMatter = mergeFrontMatter({
+        existingMetadata: frontMatter,
         resources,
         metadataVars,
         systemVars: addSystemMeta ? systemVars : undefined,
         additionalMetadata: {
             vcsPath:
-                metadata.vcsPath ??
+                frontMatter.vcsPath ??
                 (shouldAlwaysAddVCSPath
-                    ? resolveVCSPath(metadata, pathData.pathToFile)
+                    ? resolveVCSPath(frontMatter, pathData.pathToFile)
                     : undefined),
             ...vcsFrontMatter,
         },
     });
 
-    return emplaceMetadata(metadataStrippedContent, mergedMetadata);
+    return normalizeLineEndings(emplaceFrontMatter(frontMatterStrippedContent, mergedFrontMatter));
 };

src/services/metadata/mergeMetadata.ts

@@ -1,21 +1,21 @@
 import {Resources, VarsMetadata} from '../../models';
 import {isObject} from '../utils';
-import {FileMetadata} from './parse';
+import {FrontMatter} from '@diplodoc/transform/lib/frontmatter/common';
 
-export const mergeMetadata = ({
+export const mergeFrontMatter = ({
     existingMetadata,
     resources,
     systemVars,
     metadataVars = [],
     additionalMetadata,
 }: {
-    existingMetadata: FileMetadata;
+    existingMetadata: FrontMatter;
     metadataVars?: VarsMetadata;
     resources?: Resources;
     systemVars?: unknown;
     additionalMetadata?: Record<string, unknown>;
-}): FileMetadata => {
-    const mergedInnerMetadata: FileMetadata['metadata'] = [
+}): FrontMatter => {
+    const mergedInnerMetadata: FrontMatter['metadata'] = [
         ...(existingMetadata.metadata ?? []),
         ...metadataVars,
     ];
@@ -28,7 +28,7 @@ export const mergeMetadata = ({
     const innerMetadataToSpread =
         mergedInnerMetadata.length > 0 ? {metadata: mergedInnerMetadata} : undefined;
 
-    const mergedMetadata: FileMetadata = {
+    const mergedMetadata: FrontMatter = {
         ...existingMetadata,
         ...resources,
         ...systemVarsMetadataToSpread,

src/services/metadata/utils.ts

@@ -1,10 +1,6 @@
 import {carriageReturn} from '../../utils';
-import {FileMetadata, serializeMetadata} from './parse';
 
 // IMO, we should just always apply this at the end of the whole processing pipeline,
 // not when dumping meta/front matter
 export const normalizeLineEndings = (input: string): string =>
     input.replace(/\r?\n/g, carriageReturn);
-
-export const emplaceMetadata = (metadataStrippedContent: string, metadata: FileMetadata) =>
-    normalizeLineEndings(`${serializeMetadata(metadata)}${metadataStrippedContent}`);

src/services/metadata/vcsMetadata.ts

@@ -8,7 +8,7 @@ import {
 } from '../authors';
 import {ContributorsServiceFileData, getFileContributors, getFileIncludes} from '../contributors';
 import {isObject} from '../utils';
-import {FileMetadata} from './parse';
+import {FrontMatter} from '@diplodoc/transform/lib/frontmatter/common';
 
 const getFileDataForContributorsService = (
     pathData: PathData,
@@ -103,7 +103,7 @@ export const getVCSMetadata = async (
 };
 
 export const resolveVCSFrontMatter = async (
-    existingMetadata: FileMetadata,
+    existingMetadata: FrontMatter,
     options: MetaDataOptions,
     fileContent: string,
 ) => {