@jungvonmatt/contentful-ssg 1.4.8 → 1.4.9

package/README.md

@@ -217,6 +217,11 @@ Fetch all content entries and store them as yaml in the configured directory
 npx cssg fetch
 ```
 
+To see all available command line options call
+```bash
+npx cssg help fetch
+```
+
 ## Example configuration
 
 ### Grow

package/dist/cli.js

@@ -14,10 +14,10 @@ import { getConfig, getEnvironmentConfig } from './lib/config.js';
 import { run } from './index.js';
 const env = dotenv.config();
 dotenvExpand(env);
-const parseArgs = (cmd) => ({
-    environment: cmd.env,
+const parseFetchArgs = (cmd) => ({
     preview: cmd.preview,
     verbose: cmd.verbose,
+    ignoreErrors: cmd.ignoreErrors,
 });
 const errorHandler = (error, silence) => {
     if (!silence) {
@@ -37,7 +37,7 @@ program
     .option('--typescript', 'Initialize typescript config')
     .action(actionRunner(async (cmd) => {
     const useTypescript = Boolean(cmd?.typescript ?? false);
-    const config = await getConfig(parseArgs(cmd || {}));
+    const config = await getConfig();
     const verified = await askAll(config);
     const environmentConfig = getEnvironmentConfig();
     const filePath = path.join(process.cwd(), `contentful-ssg.config.${useTypescript ? 'ts' : 'js'}`);
@@ -88,8 +88,9 @@ program
     .description('Fetch content objects')
     .option('-p, --preview', 'Fetch with preview mode')
     .option('-v, --verbose', 'Verbose output')
+    .option('--ignore-errors', 'No error return code when transform has errors')
     .action(actionRunner(async (cmd) => {
-    const config = await getConfig(parseArgs(cmd || {}));
+    const config = await getConfig(parseFetchArgs(cmd || {}));
     const verified = await askMissing(config);
     return run(verified);
 }));

package/dist/index.js

@@ -54,10 +54,7 @@ export const run = async (config) => {
         {
             title: 'Before Hook',
             skip: (ctx) => !ctx.hooks.has('before'),
-            task: async (ctx) => {
-                const result = await ctx.hooks.before();
-                ctx = { ...ctx, ...(result || {}) };
-            },
+            task: async (ctx) => ctx.hooks.before(),
         },
         {
             title: 'Writing files',
@@ -109,10 +106,7 @@ export const run = async (config) => {
         {
             title: 'After Hook',
             skip: (ctx) => !ctx.hooks.has('after'),
-            task: async (ctx) => {
-                const result = await ctx.hooks.after();
-                ctx = { ...ctx, ...(result || {}) };
-            },
+            task: async (ctx) => ctx.hooks.after(),
         },
         {
             title: 'Cleanup',
@@ -122,4 +116,7 @@ export const run = async (config) => {
     const ctx = await tasks.run();
     await ctx.stats.print();
     console.log('\n---------------------------------------------');
+    if (ctx.stats.errors?.length && !config.ignoreErrors) {
+        process.exit(1);
+    }
 };

package/dist/lib/config.js

@@ -80,7 +80,7 @@ export const getEnvironmentConfig = (strict = true) => removeEmpty({
     previewAccessToken: process.env.CONTENTFUL_PREVIEW_TOKEN,
     accessToken: process.env.CONTENTFUL_DELIVERY_TOKEN,
 }, strict);
-export const getConfig = async (args) => {
+export const getConfig = async (args = {}) => {
     const defaultOptions = {
         environmentId: 'master',
         host: 'api.contentful.com',

package/dist/types.d.ts

@@ -50,6 +50,7 @@ export declare type Config = Partial<ContentfulConfig> & Hooks & {
     directory: string;
     managedDirectories?: string[];
     verbose?: boolean;
+    ignoreErrors?: boolean;
     plugins?: Array<[string, KeyValueMap] | PluginInfo | string>;
     resolvedPlugins?: Hooks[];
     preset?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/contentful-ssg",
-  "version": "1.4.8",
+  "version": "1.4.9",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -155,5 +155,5 @@
       "module": "es2020"
     }
   },
-  "gitHead": "28da6d98d1ba37a9bbaf6f1b22157c226be6d477"
+  "gitHead": "17ccdcf1aedc0eea54740aa71279e5bd1cb77699"
 }

package/src/cli.ts

@@ -15,15 +15,15 @@ import { omitKeys } from './lib/object.js';
 
 import { getConfig, getEnvironmentConfig } from './lib/config.js';
 import { run } from './index.js';
-import { ContentfulConfig } from './types.js';
+import { Config, ContentfulConfig } from './types.js';
 
 const env = dotenv.config();
 dotenvExpand(env);
 
-const parseArgs = (cmd) => ({
-  environment: cmd.env as string,
+const parseFetchArgs = (cmd): Partial<Config> => ({
   preview: cmd.preview as boolean,
   verbose: cmd.verbose as boolean,
+  ignoreErrors: cmd.ignoreErrors as boolean,
 });
 
 type CommandError = Error & {
@@ -54,7 +54,7 @@ program
   .action(
     actionRunner(async (cmd) => {
       const useTypescript = Boolean(cmd?.typescript ?? false);
-      const config = await getConfig(parseArgs(cmd || {}));
+      const config = await getConfig();
       const verified = await askAll(config);
 
       const environmentConfig = getEnvironmentConfig();
@@ -148,9 +148,10 @@ program
   .description('Fetch content objects')
   .option('-p, --preview', 'Fetch with preview mode')
   .option('-v, --verbose', 'Verbose output')
+  .option('--ignore-errors', 'No error return code when transform has errors')
   .action(
     actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
+      const config = await getConfig(parseFetchArgs(cmd || {}));
       const verified = await askMissing(config);
 
       return run(verified);

package/src/index.test.ts

@@ -86,4 +86,62 @@ describe('Run', () => {
     expect(output).toMatch(`${chalk.cyan(0)} entries skipped due to validation issues`);
     expect(output).toMatch(`${chalk.red(0)} errors`);
   });
+
+  test('fails on exception before/after', async () => {
+    console.log = jest.fn();
+    const mockError = jest.fn().mockImplementation(() => {
+      throw new Error();
+    });
+
+    await expect(async () => {
+      await run({
+        directory: 'test',
+        before: mockError,
+      });
+    }).rejects.toThrowError();
+
+    await expect(async () => {
+      await run({
+        directory: 'test',
+        after: mockError,
+      });
+    }).rejects.toThrowError();
+  });
+
+  test('fails on transform exception', async () => {
+    console.log = jest.fn();
+    const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
+      throw new Error('process.exit: ' + number);
+    });
+
+    await expect(async () => {
+      await run({
+        directory: 'test',
+        transform: async () => {
+          throw new Error();
+        },
+      });
+    }).rejects.toThrowError();
+
+    expect(mockExit).toHaveBeenCalledWith(1);
+    mockExit.mockRestore();
+  });
+
+  test('does not fail on transform exception with ignoreErrors option', async () => {
+    console.log = jest.fn();
+    const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
+      throw new Error('process.exit: ' + number);
+    });
+
+    await run({
+      directory: 'test',
+      ignoreErrors: true,
+      transform: async () => {
+        throw new Error();
+      },
+    });
+
+    expect(mockExit).toBeCalledTimes(0);
+    mockExit.mockRestore();
+  });
 });

package/src/index.ts

@@ -73,10 +73,7 @@ export const run = async (config: Config): Promise<void> => {
       {
         title: 'Before Hook',
         skip: (ctx) => !ctx.hooks.has('before'),
-        task: async (ctx) => {
-          const result = await ctx.hooks.before();
-          ctx = { ...ctx, ...(result || {}) };
-        },
+        task: async (ctx) => ctx.hooks.before(),
       },
       {
         title: 'Writing files',
@@ -135,12 +132,8 @@ export const run = async (config: Config): Promise<void> => {
       {
         title: 'After Hook',
         skip: (ctx) => !ctx.hooks.has('after'),
-        task: async (ctx) => {
-          const result = await ctx.hooks.after();
-          ctx = { ...ctx, ...(result || {}) };
-        },
+        task: async (ctx) => ctx.hooks.after(),
       },
-
       {
         title: 'Cleanup',
         task: async (ctx) => ctx.fileManager.cleanup(),
@@ -152,4 +145,8 @@ export const run = async (config: Config): Promise<void> => {
   const ctx = await tasks.run();
   await ctx.stats.print();
   console.log('\n---------------------------------------------');
+
+  if (ctx.stats.errors?.length && !config.ignoreErrors) {
+    process.exit(1);
+  }
 };

package/src/lib/config.ts

@@ -122,7 +122,7 @@ export const getEnvironmentConfig = (strict = true): ContentfulConfig =>
  * Get configuration
  * @param {Object} args
  */
-export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
+export const getConfig = async (args: Partial<Config> = {}): Promise<Config> => {
   const defaultOptions: Config = {
     environmentId: 'master',
     host: 'api.contentful.com',

package/src/types.ts

@@ -85,6 +85,7 @@ export type Config = Partial<ContentfulConfig> &
     directory: string;
     managedDirectories?: string[];
     verbose?: boolean;
+    ignoreErrors?: boolean;
     plugins?: Array<[string, KeyValueMap] | PluginInfo | string>;
     resolvedPlugins?: Hooks[];
     preset?: string;