feat: converting versionNumber to number

Author: April-Bates-Dev

src/generate-docs.ts

@@ -8,7 +8,7 @@ import { writeSchemaFile } from "./helpers/writeSchemaFile.js";
 
 //Note: contract file name must include term 'Contract' to be parsed
 const getContractFileNames = async (
-  pathToContracts: string,
+  pathToContracts: string
 ): Promise<string[]> => {
   const files = await readdir(pathToContracts);
 
@@ -17,34 +17,29 @@ const getContractFileNames = async (
 
 export const generateDocumentation = async (
   pathToContractsFolder: string,
-  pathToDocumentationFolder: string,
+  pathToDocumentationFolder: string
 ): Promise<void> => {
   const contractFileNames = await getContractFileNames(pathToContractsFolder);
 
   for (const contractFileName of contractFileNames) {
     const { detailType, detailVersion, schema } = generateSchemaDetails(
       pathToContractsFolder,
-      contractFileName,
+      contractFileName
     );
 
     const pathToContractDocumentationFolder = path.join(
-      `${pathToDocumentationFolder}/${detailType}/versioned/${detailVersion}`,
+      `${pathToDocumentationFolder}/${detailType}/versioned/${detailVersion}`
     );
 
     mkdirSync(pathToContractDocumentationFolder, { recursive: true });
 
     await writeIndexFile(
       pathToContractDocumentationFolder,
       detailType,
-      detailVersion,
+      detailVersion
     );
 
-    await writeSchemaFile(pathToContractDocumentationFolder, {
-      detailType,
-      detailVersion,
-      schema,
-    });
-
+    await writeSchemaFile(pathToContractDocumentationFolder, schema);
     console.log(`Created docs for ${contractFileName}`);
   }
 };

src/helpers/generateSchemaDetails.ts

@@ -8,7 +8,7 @@ import { SchemaDetails } from "../types.js";
 
 export const generateSchemaDetails = (
   pathToContractsFolder: string,
-  contractFilename: string,
+  contractFilename: string
 ): SchemaDetails => {
   const pathToContractFile = path.join(pathToContractsFolder, contractFilename);
 
@@ -20,17 +20,15 @@ export const generateSchemaDetails = (
   };
 
   const contractSchema = createGenerator(typeToSchemaConfig).createSchema(
-    typeToSchemaConfig.type,
+    typeToSchemaConfig.type
   );
 
   //TODO: validate that detailType would be a valid filename
   if (isValidJsonSchemaContract(contractSchema)) {
     return {
       detailType: contractSchema.properties["detail-type"].const,
       detailVersion:
-        contractSchema.properties.detail.properties[
-          "detail-version"
-        ].const.toString(),
+        contractSchema.properties.detail.properties["detail-version"].const,
       schema: contractSchema,
     };
   } else {

src/helpers/writeIndexFile.ts

@@ -21,15 +21,15 @@ const eventMarkdownTemplate =
 export const writeIndexFile = async (
   pathToContractDocumentationFolder: string,
   detailType: string,
-  detailVersion: string,
+  detailVersion: number,
 ): Promise<void> => {
   const markdownWithName = eventMarkdownTemplate.replace(
     "//name//",
     detailType,
   );
   const markdownWithVersion = markdownWithName.replace(
     "//version//",
-    detailVersion,
+    detailVersion.toString(),
   );
 
   await writeFile(

src/helpers/writeSchemaFile.ts

@@ -1,20 +1,20 @@
 import { writeFile } from "fs/promises";
 
-import { SchemaDetails } from "../types.js";
+import { ContractSchemaType } from "../types.js";
 
 export const writeSchemaFile = async (
   pathToContractDocumentationFolder: string,
-  schemaDetails: SchemaDetails,
+  schema: ContractSchemaType
 ): Promise<void> => {
   const jsonSchemaWhiteSpace = 2;
   const schemaString = JSON.stringify(
-    schemaDetails.schema,
+    schema,
     null,
-    jsonSchemaWhiteSpace,
+    jsonSchemaWhiteSpace
   );
 
   await writeFile(
     `${pathToContractDocumentationFolder}/schema.json`,
-    schemaString,
+    schemaString
   );
 };

src/types.ts

@@ -1,6 +1,6 @@
 export type SchemaDetails = {
   detailType: string;
-  detailVersion: string;
+  detailVersion: number;
   schema: ContractSchemaType;
 };