@jungvonmatt/contentful-ssg 1.0.6 → 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,
-    preview: Boolean(cmd.preview),
-    verbose: Boolean(cmd.verbose),
+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

@@ -4,6 +4,7 @@ import { cosmiconfig } from 'cosmiconfig';
 import mergeOptionsModule from 'merge-options';
 import { dirname, isAbsolute, resolve } from 'path';
 import slash from 'slash';
+import { reduceAsync } from './array.js';
 import { createRequire } from './create-require.js';
 import { isObject, removeEmpty } from './object.js';
 const typescriptLoader = async (filePath) => {
@@ -79,11 +80,12 @@ 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',
         directory: resolve(process.cwd(), 'content'),
+        managedDirectories: [],
         plugins: [],
         resolvedPlugins: [],
     };
@@ -140,5 +142,10 @@ export const getConfig = async (args) => {
         ...result.resolvedPlugins,
         ...(await Promise.all((result.plugins || []).map(async (plugin) => resolvePlugin(plugin, result)))),
     ];
-    return { ...result, resolvedPlugins };
+    result.managedDirectories = [...result.managedDirectories, result.directory];
+    const hookedConfig = await reduceAsync(resolvedPlugins.filter((plugin) => typeof plugin.config === 'function'), async (prev, hooks) => {
+        const hook = hooks.config;
+        return hook(prev);
+    }, result);
+    return { ...hookedConfig, ...result, resolvedPlugins };
 };

package/dist/lib/file-manager.js

@@ -26,7 +26,11 @@ export class FileManager {
             const ignorePatterns = await readFile(gitignore);
             this.ignore = ignore().add(ignorePatterns.toString('utf8'));
         }
-        const existing = await globby([`${this.config.directory}/**/*.*`, `data/**/*.*`]);
+        const directories = [
+            ...new Set([...(this.config.managedDirectories || []), this.config.directory]),
+        ];
+        const globPattern = directories.map((directory) => resolve(this.config.rootDir || '', directory, '**/*.*'));
+        const existing = await globby(globPattern);
         this.files = new Set(existing.map((file) => resolve(file)));
     }
     async writeFile(file, data, options) {

package/dist/types.d.ts

@@ -30,10 +30,12 @@ export interface ContentfulRcConfig {
     activeEnvironmentId: string;
     host: string;
 }
+export declare type ConfigHook = (config: Config) => Config | Promise<Config>;
 export declare type RuntimeHook = (runtimeContext: RuntimeContext) => Promise<Partial<RuntimeContext>> | Partial<RuntimeContext> | void;
 export declare type TransformHook<T> = (transformContext: TransformContext, runtimeContext?: RuntimeContext, prev?: T) => Promise<T> | T;
 export declare type ValidateHook = (transformContext: TransformContext, runtimeContext?: RuntimeContext) => Promise<boolean> | boolean;
 export interface Hooks {
+    config?: ConfigHook;
     before?: RuntimeHook;
     after?: RuntimeHook;
     transform?: TransformHook<KeyValueMap>;
@@ -46,7 +48,9 @@ export interface Hooks {
 export declare type Config = Partial<ContentfulConfig> & Hooks & {
     rootDir?: string;
     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.0.6",
+  "version": "1.4.9",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -8,11 +8,14 @@
   "exports": {
     ".": "./dist/index.js",
     "./lib/object": "./dist/lib/object.js",
+    "./lib/config": "./dist/lib/config.js",
     "./lib/array": "./dist/lib/array.js",
     "./lib/utils": "./dist/lib/utils.js",
+    "./lib/ui": "./dist/lib/ui.js",
     "./lib/contentful": "./dist/lib/contentful.js",
     "./lib/hook-manager": "./dist/lib/hook-manager.js",
     "./lib/file-manager": "./dist/lib/file-manager.js",
+    "./converter": "./dist/converter/index.js",
     "./converter/json": "./dist/converter/json.js",
     "./converter/yaml": "./dist/converter/yaml.js",
     "./converter/toml": "./dist/converter/toml.js",
@@ -27,6 +30,12 @@
       "lib/utils": [
         "./dist/lib/utils.d.ts"
       ],
+      "lib/ui": [
+        "./dist/lib/ui.d.ts"
+      ],
+      "lib/config": [
+        "./dist/lib/config.d.ts"
+      ],
       "lib/object": [
         "./dist/lib/object.d.ts"
       ],
@@ -42,6 +51,9 @@
       "lib/file-manager": [
         "./dist/lib/file-manager.d.ts"
       ],
+      "converter": [
+        "./dist/converter/index.d.ts"
+      ],
       "converter/json": [
         "./dist/converter/json.d.ts"
       ],
@@ -79,7 +91,7 @@
     "dist"
   ],
   "author": "Jung von Matt TECH GmbH",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "@contentful/rich-text-html-renderer": "^15.6.2",
     "@contentful/rich-text-types": "^15.6.2",
@@ -143,5 +155,5 @@
       "module": "es2020"
     }
   },
-  "gitHead": "72fea365aa247c8942d01c499becf8548874b09d"
+  "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,
-  preview: Boolean(cmd.preview),
-  verbose: Boolean(cmd.verbose),
+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

@@ -14,6 +14,7 @@ import type {
   PluginInfo,
   PluginModule,
 } from '../types.js';
+import { reduceAsync } from './array.js';
 import { createRequire } from './create-require.js';
 import { isObject, removeEmpty } from './object.js';
 
@@ -121,11 +122,12 @@ 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',
     directory: resolve(process.cwd(), 'content'),
+    managedDirectories: [],
     plugins: [],
     resolvedPlugins: [],
   };
@@ -197,5 +199,17 @@ export const getConfig = async (args?: Partial<Config>): Promise<Config> => {
       (result.plugins || []).map(async (plugin) => resolvePlugin(plugin, result))
     )),
   ];
-  return { ...result, resolvedPlugins };
+
+  result.managedDirectories = [...result.managedDirectories, result.directory];
+
+  const hookedConfig = await reduceAsync(
+    resolvedPlugins.filter((plugin) => typeof plugin.config === 'function'),
+    async (prev: Config, hooks) => {
+      const hook = hooks.config;
+      return hook(prev);
+    },
+    result
+  );
+
+  return { ...hookedConfig, ...result, resolvedPlugins };
 };

package/src/lib/file-manager.ts

@@ -39,8 +39,15 @@ export class FileManager {
       this.ignore = ignore().add(ignorePatterns.toString('utf8'));
     }
 
+    const directories = [
+      ...new Set([...(this.config.managedDirectories || []), this.config.directory]),
+    ];
+
+    const globPattern = directories.map((directory) =>
+      resolve(this.config.rootDir || '', directory, '**/*.*')
+    );
     // Create set of existing files
-    const existing = await globby([`${this.config.directory}/**/*.*`, `data/**/*.*`]);
+    const existing = await globby(globPattern);
 
     this.files = new Set(existing.map((file) => resolve(file)));
   }

package/src/types.ts

@@ -52,6 +52,8 @@ export interface ContentfulRcConfig {
   host: string;
 }
 
+export type ConfigHook = (config: Config) => Config | Promise<Config>;
+
 export type RuntimeHook = (
   runtimeContext: RuntimeContext
 ) => Promise<Partial<RuntimeContext>> | Partial<RuntimeContext> | void;
@@ -66,6 +68,7 @@ export type ValidateHook = (
 ) => Promise<boolean> | boolean;
 
 export interface Hooks {
+  config?: ConfigHook;
   before?: RuntimeHook;
   after?: RuntimeHook;
   transform?: TransformHook<KeyValueMap>;
@@ -80,7 +83,9 @@ export type Config = Partial<ContentfulConfig> &
   Hooks & {
     rootDir?: string;
     directory: string;
+    managedDirectories?: string[];
     verbose?: boolean;
+    ignoreErrors?: boolean;
     plugins?: Array<[string, KeyValueMap] | PluginInfo | string>;
     resolvedPlugins?: Hooks[];
     preset?: string;