CLI Deploy: Print helpful error messages for invalid spec (#863)

* print helpful error messages when an invalid spec is encountered * add changeset file * remove strict:false option * seems like doc.toJSON does not throw when there are errors * bump versions --------- Co-authored-by: Joe Clark <[email protected]>
OpenFn · Feb 7, 2025 · 9202fb2 · 9202fb2
1 parent 8b015bc
commit 9202fb2
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 2 deletions.
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @openfn/cli
 
+## 1.11.0
+
+### Minor Changes
+
+- 706124a: deploy: Print helpful error messages when an invalid spec is encountered
+
+### Patch Changes
+
+- Updated dependencies [706124a]
+  - @openfn/deploy@0.11.0
+
 ## 1.10.4
 
 ### Patch Changes

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.10.4",
+  "version": "1.11.0",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",

diff --git a/packages/deploy/CHANGELOG.md b/packages/deploy/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @openfn/deploy
 
+## 0.11.0
+
+### Minor Changes
+
+- 706124a: Print helpful error messages when an invalid spec is encountered
+
 ## 0.10.0
 
 ### Minor Changes

diff --git a/packages/deploy/package.json b/packages/deploy/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfn/deploy",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Deploy projects to Lightning instances",
   "type": "module",
   "exports": {

diff --git a/packages/deploy/src/pull.ts b/packages/deploy/src/pull.ts
@@ -4,6 +4,7 @@ import { Logger } from '@openfn/logger';
 import { writeFile } from 'fs/promises';
 import path from 'path';
 import { getState, getSpec } from './index';
+import { DeployError } from './deployError';
 
 async function getAllSpecJobs(
   config: DeployConfig,
@@ -103,6 +104,10 @@ async function extractJobsToDisk(
     },
   });
 
+  if (doc.errors.length > 0) {
+    throw new DeployError(doc.errors[0].message, 'SPEC_ERROR');
+  }
+
   return doc.toString();
 }