@hubspot/project-parsing-lib 0.11.0 → 0.11.1

package/README.md

@@ -1,38 +1,7 @@
-# project-translation-layer
+# @hubspot/project-parsing-lib
 
-## Description
-This project is a translation layer that can be used to translate a project to its immediate representation prior to being uploaded
-to the project v2 service.
+A parsing library for converting HubSpot project directory structures to their intermediate representation (IR).
 
-## Flow Chart
+## Description
 
-```mermaid
-sequenceDiagram
-    autonumber
-    
-    actor dev as External Developer
-    participant cli as HS CLI
-    participant ppl as Project Parsing Library
-    participant pv3 as Projects v3
-    
-    dev ->> cli: Developer runs `hs project upload`
-    cli ->> cli: Loads project config
-    cli ->> ppl: CLI calls `translate` function with the values required from the project config
-    ppl ->> ppl: Walks the project directory looking for the hsmeta files
-    loop For each hsmeta file
-        ppl ->> ppl: Checks if file is valid JSON
-        ppl ->> ppl: Checks if the file is in a valid location
-        ppl ->> ppl: Generates the IR
-    end
-    ppl ->> pv3: Fetch the schemas used to validate the generated IR
-    loop For each hsmeta file
-        ppl ->> ppl: Validate the IR config block against the schema
-    end
-    alt Validation successful for all schemas
-        ppl ->> cli: Pass the IR back to the CLI
-        cli ->> cli: Zip the project contents
-        cli ->> pv3: Upload the project and the IR
-    else Validation failed for 1+ schema(s)
-        ppl ->> cli: Log the error and exit the upload
-end
-```
+This library provides functionality to parse HubSpot project structures and convert them into an intermediate representation that can be uploaded to HubSpot. It walks through project directories, locates `.hsmeta.json` files, validates them, and generates the IR needed for project uploads.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.11.0",
+    "version": "0.11.1",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "type": "module",

package/src/lib/errors.d.ts

@@ -6,7 +6,7 @@ export declare class TranslationError extends Error {
     private errors;
     private translationContext;
     constructor(message: string, transformations: Transformation[], errors: (ErrorObject[] | null | undefined)[], translationContext: TranslationContext);
-    toString(): string;
+    toString(includeMessage?: boolean): string;
 }
 export declare function extractDotNotationValueFromTransformation(dotNotation: string, transformation: Transformation): unknown;
 export declare const AjvErrorKeyword: {

package/src/lib/errors.js

@@ -21,7 +21,7 @@ export class TranslationError extends Error {
         this.errors = transformations.map((transformation, index) => compileTranslationErrors(transformation, errors[index]));
     }
     // Returns a formatted string for all the errors in all the files
-    toString() {
+    toString(includeMessage = true) {
         const listOfErrors = this.errors.map(({ file, errors }) => {
             if (errors.length === 0) {
                 return null;
@@ -30,9 +30,11 @@ export class TranslationError extends Error {
             const relativePath = path.relative(projectRoot, path.join(this.translationContext.projectSourceDir, file));
             return errorMessages.validation.errorWithFileHeader(relativePath, errors);
         });
-        return `${this.message}:${listOfErrors
-            .filter(error => error !== null)
-            .join('')}`;
+        const errorString = listOfErrors.filter(error => error !== null).join('');
+        if (includeMessage) {
+            return `${this.message}:${errorString}`;
+        }
+        return errorString.trimStart();
     }
 }
 function generateDotNotationPath(error) {