@appsemble/node-utils 0.20.8 → 0.20.11

package/fs.test.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require(".");
+describe('isErrno', () => {
+    it('should return false for null', () => {
+        expect((0, _1.isErrno)(null)).toBe(false);
+    });
+    it('should return false for miscellaneous objects', () => {
+        expect((0, _1.isErrno)({})).toBe(false);
+    });
+    it('should return true if the object has a string property named code', () => {
+        expect((0, _1.isErrno)({ code: 'foo' })).toBe(true);
+    });
+    it('should return false if the object has a non-string property named code', () => {
+        expect((0, _1.isErrno)({ code: 42 })).toBe(false);
+    });
+    it('should allow to narrow down a specific code', () => {
+        expect((0, _1.isErrno)({ code: 'ENOENT' }, 'ENOENT')).toBe(true);
+        expect((0, _1.isErrno)({ code: 'invalid' }, 'ENOENT')).toBe(false);
+    });
+});
+describe('readData', () => {
+    it('should read and parse a JSON file', async () => {
+        const content = await (0, _1.readData)((0, _1.resolveFixture)('json.json'));
+        expect(content).toStrictEqual([{ json: 'json' }, '{ "json": "json" }\n']);
+    });
+    it('should read and parse a YAML file', async () => {
+        const content = await (0, _1.readData)((0, _1.resolveFixture)('yaml.yaml'));
+        expect(content).toStrictEqual([{ yaml: 'yaml' }, 'yaml: yaml\n']);
+    });
+    it('should throw an Appsemble error if file extension is unknown', async () => {
+        const path = (0, _1.resolveFixture)('hello.txt');
+        await expect((0, _1.readData)(path)).rejects.toThrow(new _1.AppsembleError(`Unknown file extension: ${path}`));
+    });
+    it('should throw an Appsemble error if the file can’t be read', async () => {
+        await expect((0, _1.readData)('non-existent.yaml')).rejects.toThrow(new _1.AppsembleError('Error reading file non-existent.yaml'));
+    });
+    it('should throw an Appsemble error if the file can’t be parsed', async () => {
+        const path = (0, _1.resolveFixture)('invalid-json.json');
+        await expect((0, _1.readData)(path)).rejects.toThrow(_1.AppsembleError);
+    });
+});
+describe('opendirSafe', () => {
+    it('should read a directory', async () => {
+        const onFile = jest.fn();
+        await (0, _1.opendirSafe)((0, _1.resolveFixture)('test'), onFile);
+        expect(onFile).toHaveBeenCalledTimes(3);
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/bar.txt'), expect.objectContaining({ name: 'bar.txt' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/foo.txt'), expect.objectContaining({ name: 'foo.txt' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/z'), expect.objectContaining({ name: 'z' }));
+    });
+    it('should read a directory recursively if specified', async () => {
+        const onFile = jest.fn();
+        await (0, _1.opendirSafe)((0, _1.resolveFixture)('test'), onFile, { recursive: true });
+        expect(onFile).toHaveBeenCalledTimes(5);
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/bar.txt'), expect.objectContaining({ name: 'bar.txt' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/foo.txt'), expect.objectContaining({ name: 'foo.txt' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/z'), expect.objectContaining({ name: 'z' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/z/baz.txt'), expect.objectContaining({ name: 'baz.txt' }));
+        expect(onFile).toHaveBeenCalledWith((0, _1.resolveFixture)('test/z/fooz.txt'), expect.objectContaining({ name: 'fooz.txt' }));
+    });
+    it('should throw if the path is not a directory', async () => {
+        const path = (0, _1.resolveFixture)('hello.txt');
+        await expect((0, _1.opendirSafe)(path, jest.fn())).rejects.toThrow(new _1.AppsembleError(`Expected ${path} to be a directory`));
+    });
+    it('should throw if the path doesn’t exist', async () => {
+        const path = (0, _1.resolveFixture)('non-existent');
+        await expect((0, _1.opendirSafe)(path, jest.fn())).rejects.toThrow(new _1.AppsembleError(`Expected ${path} to be a directory`));
+    });
+    it('should not throw if the path doesn’t exist and allowMissing is true', async () => {
+        const path = (0, _1.resolveFixture)('non-existent');
+        const result = await (0, _1.opendirSafe)(path, jest.fn(), { allowMissing: true });
+        expect(result).toBeUndefined();
+    });
+});
+//# sourceMappingURL=fs.test.js.map

package/fs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.test.js","sourceRoot":"","sources":["fs.test.ts"],"names":[],"mappings":";;AAAA,wBAAmF;AAEnF,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CAAC,IAAA,UAAO,EAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,IAAA,UAAO,EAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,CAAC,IAAA,UAAO,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,CAAC,IAAA,UAAO,EAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,IAAA,UAAO,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,MAAM,CAAC,IAAA,UAAO,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,OAAO,GAAG,MAAM,IAAA,WAAQ,EAAC,IAAA,iBAAc,EAAC,WAAW,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,OAAO,GAAG,MAAM,IAAA,WAAQ,EAAC,IAAA,iBAAc,EAAC,WAAW,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,IAAI,GAAG,IAAA,iBAAc,EAAC,WAAW,CAAC,CAAC;QACzC,MAAM,MAAM,CAAC,IAAA,WAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC1C,IAAI,iBAAc,CAAC,2BAA2B,IAAI,EAAE,CAAC,CACtD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,MAAM,CAAC,IAAA,WAAQ,EAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACzD,IAAI,iBAAc,CAAC,sCAAsC,CAAC,CAC3D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,IAAI,GAAG,IAAA,iBAAc,EAAC,mBAAmB,CAAC,CAAC;QACjD,MAAM,MAAM,CAAC,IAAA,WAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAc,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACzB,MAAM,IAAA,cAAW,EAAC,IAAA,iBAAc,EAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,cAAc,CAAC,EAC9B,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC7C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,cAAc,CAAC,EAC9B,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC7C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,QAAQ,CAAC,EACxB,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACzB,MAAM,IAAA,cAAW,EAAC,IAAA,iBAAc,EAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,cAAc,CAAC,EAC9B,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC7C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,cAAc,CAAC,EAC9B,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC7C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,QAAQ,CAAC,EACxB,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CACvC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,gBAAgB,CAAC,EAChC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAC7C,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,IAAA,iBAAc,EAAC,iBAAiB,CAAC,EACjC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAC9C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,IAAI,GAAG,IAAA,iBAAc,EAAC,WAAW,CAAC,CAAC;QACzC,MAAM,MAAM,CAAC,IAAA,cAAW,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACxD,IAAI,iBAAc,CAAC,YAAY,IAAI,oBAAoB,CAAC,CACzD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,IAAI,GAAG,IAAA,iBAAc,EAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,MAAM,CAAC,IAAA,cAAW,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACxD,IAAI,iBAAc,CAAC,YAAY,IAAI,oBAAoB,CAAC,CACzD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,IAAI,GAAG,IAAA,iBAAc,EAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAA,cAAW,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/fs.test.ts

@@ -0,0 +1,120 @@
+import { AppsembleError, isErrno, opendirSafe, readData, resolveFixture } from '.';
+
+describe('isErrno', () => {
+  it('should return false for null', () => {
+    expect(isErrno(null)).toBe(false);
+  });
+
+  it('should return false for miscellaneous objects', () => {
+    expect(isErrno({})).toBe(false);
+  });
+
+  it('should return true if the object has a string property named code', () => {
+    expect(isErrno({ code: 'foo' })).toBe(true);
+  });
+
+  it('should return false if the object has a non-string property named code', () => {
+    expect(isErrno({ code: 42 })).toBe(false);
+  });
+
+  it('should allow to narrow down a specific code', () => {
+    expect(isErrno({ code: 'ENOENT' }, 'ENOENT')).toBe(true);
+    expect(isErrno({ code: 'invalid' }, 'ENOENT')).toBe(false);
+  });
+});
+
+describe('readData', () => {
+  it('should read and parse a JSON file', async () => {
+    const content = await readData(resolveFixture('json.json'));
+    expect(content).toStrictEqual([{ json: 'json' }, '{ "json": "json" }\n']);
+  });
+
+  it('should read and parse a YAML file', async () => {
+    const content = await readData(resolveFixture('yaml.yaml'));
+    expect(content).toStrictEqual([{ yaml: 'yaml' }, 'yaml: yaml\n']);
+  });
+
+  it('should throw an Appsemble error if file extension is unknown', async () => {
+    const path = resolveFixture('hello.txt');
+    await expect(readData(path)).rejects.toThrow(
+      new AppsembleError(`Unknown file extension: ${path}`),
+    );
+  });
+
+  it('should throw an Appsemble error if the file can’t be read', async () => {
+    await expect(readData('non-existent.yaml')).rejects.toThrow(
+      new AppsembleError('Error reading file non-existent.yaml'),
+    );
+  });
+
+  it('should throw an Appsemble error if the file can’t be parsed', async () => {
+    const path = resolveFixture('invalid-json.json');
+    await expect(readData(path)).rejects.toThrow(AppsembleError);
+  });
+});
+
+describe('opendirSafe', () => {
+  it('should read a directory', async () => {
+    const onFile = jest.fn();
+    await opendirSafe(resolveFixture('test'), onFile);
+    expect(onFile).toHaveBeenCalledTimes(3);
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/bar.txt'),
+      expect.objectContaining({ name: 'bar.txt' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/foo.txt'),
+      expect.objectContaining({ name: 'foo.txt' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/z'),
+      expect.objectContaining({ name: 'z' }),
+    );
+  });
+
+  it('should read a directory recursively if specified', async () => {
+    const onFile = jest.fn();
+    await opendirSafe(resolveFixture('test'), onFile, { recursive: true });
+    expect(onFile).toHaveBeenCalledTimes(5);
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/bar.txt'),
+      expect.objectContaining({ name: 'bar.txt' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/foo.txt'),
+      expect.objectContaining({ name: 'foo.txt' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/z'),
+      expect.objectContaining({ name: 'z' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/z/baz.txt'),
+      expect.objectContaining({ name: 'baz.txt' }),
+    );
+    expect(onFile).toHaveBeenCalledWith(
+      resolveFixture('test/z/fooz.txt'),
+      expect.objectContaining({ name: 'fooz.txt' }),
+    );
+  });
+
+  it('should throw if the path is not a directory', async () => {
+    const path = resolveFixture('hello.txt');
+    await expect(opendirSafe(path, jest.fn())).rejects.toThrow(
+      new AppsembleError(`Expected ${path} to be a directory`),
+    );
+  });
+
+  it('should throw if the path doesn’t exist', async () => {
+    const path = resolveFixture('non-existent');
+    await expect(opendirSafe(path, jest.fn())).rejects.toThrow(
+      new AppsembleError(`Expected ${path} to be a directory`),
+    );
+  });
+
+  it('should not throw if the path doesn’t exist and allowMissing is true', async () => {
+    const path = resolveFixture('non-existent');
+    const result = await opendirSafe(path, jest.fn(), { allowMissing: true });
+    expect(result).toBeUndefined();
+  });
+});

package/fs.ts

@@ -0,0 +1,144 @@
+import { Dirent, Stats } from 'fs';
+import { mkdir, opendir, readFile, stat, writeFile } from 'fs/promises';
+import { dirname, extname, join } from 'path';
+
+import { compareStrings } from '@appsemble/utils';
+import parseJson from 'parse-json';
+import sortKeys from 'sort-keys';
+import { Promisable } from 'type-fest';
+import { parse, stringify } from 'yaml';
+
+import { AppsembleError } from '.';
+
+/**
+ * Test if the error is a NodeJS errno exception.
+ *
+ * @param error The value to check
+ * @param code If specified, theck if the code matches
+ * @returns Whether or not the error is a NodeJS errno exception.
+ */
+export function isErrno(error: unknown, code?: string): error is NodeJS.ErrnoException {
+  if (!error || typeof error !== 'object') {
+    return false;
+  }
+  const err = error as NodeJS.ErrnoException;
+  if (code) {
+    return err.code === code;
+  }
+  return typeof err.code === 'string';
+}
+
+/**
+ * Read the content of a JSON or YAML file.
+ *
+ * @param path The path to the file to read.
+ * @returns A tuple of the parsed content and the content as a string.
+ */
+export async function readData<R>(path: string): Promise<[R, string]> {
+  let content: string;
+  const ext = extname(path);
+  try {
+    content = await readFile(path, 'utf8');
+  } catch {
+    throw new AppsembleError(`Error reading file ${path}`);
+  }
+  if (ext !== '.yaml' && ext !== '.yml' && ext !== '.json') {
+    throw new AppsembleError(`Unknown file extension: ${path}`);
+  }
+  try {
+    return [
+      ext === '.json' ? parseJson(content) : (parse(content, { maxAliasCount: 10_000 }) as R),
+      content,
+    ];
+  } catch (error: unknown) {
+    throw new AppsembleError(`Error parsing ${path}\n${(error as Error).message}`);
+  }
+}
+
+interface WriteDataOptions {
+  /**
+   * If false, don’t sort the object keys.
+   */
+  readonly sort?: boolean;
+
+  /**
+   * A comparison function to use for sorting keys.
+   *
+   * By default natural sorting will be used.
+   */
+  readonly compare?: ((a: string, b: string) => number) | null;
+}
+
+/**
+ * Write data to a file serialized as JSON or YAML.
+ *
+ * If `prettier` is available, the content is also formatted.
+ *
+ * @param path The file path to write the data to.
+ * @param data The data to write to the file.
+ * @param options Additional options for processing the data.
+ * @returns The formatted content.
+ */
+export async function writeData(
+  path: string,
+  data: unknown,
+  { compare = compareStrings, sort = true }: WriteDataOptions = {},
+): Promise<string> {
+  const sorted = sort ? sortKeys(data, { deep: true, compare: compare || undefined }) : data;
+  let buffer: string;
+  try {
+    const { format, getFileInfo, resolveConfig } = await import('prettier');
+    const { inferredParser } = await getFileInfo(path, { resolveConfig: true });
+    const prettierOptions = await resolveConfig(path, { editorconfig: true });
+    prettierOptions.parser = inferredParser;
+    buffer = inferredParser === 'yaml' ? stringify(sorted) : JSON.stringify(sorted, undefined, 2);
+    buffer = format(buffer, prettierOptions);
+  } catch {
+    const ext = extname(path);
+    buffer =
+      ext === '.yml' || ext === '.yaml' ? stringify(sorted) : JSON.stringify(sorted, undefined, 2);
+  }
+  await mkdir(dirname(path), { recursive: true });
+  await writeFile(path, buffer);
+  return buffer;
+}
+
+interface OpenDirSafeOptions {
+  allowMissing?: boolean;
+  recursive?: boolean;
+}
+
+/**
+ * Read the contents of a directory.
+ *
+ * @param directory The path of the directory to open.
+ * @param onFile A callback which will get called for every file. This will be called with the full
+ * file path as its first argument and its `Dirent` object as the second argument.
+ * @param options Additional options.
+ */
+export async function opendirSafe(
+  directory: string,
+  onFile: (fullpath: string, stat: Dirent) => Promisable<void>,
+  options: OpenDirSafeOptions = {},
+): Promise<void> {
+  let stats: Stats;
+  try {
+    stats = await stat(directory);
+  } catch (err: unknown) {
+    if (options.allowMissing && isErrno(err, 'ENOENT')) {
+      return;
+    }
+    throw new AppsembleError(`Expected ${directory} to be a directory`);
+  }
+  if (!stats.isDirectory()) {
+    throw new AppsembleError(`Expected ${directory} to be a directory`);
+  }
+  const dir = await opendir(directory);
+  for await (const file of dir) {
+    const fullPath = join(directory, file.name);
+    await onFile(fullPath, file);
+    if (options.recursive && file.isDirectory()) {
+      await opendirSafe(fullPath, onFile, options);
+    }
+  }
+}

package/{dist/getWorkspaces.d.ts → getWorkspaces.d.ts}

@@ -3,7 +3,7 @@
  *
  * Both Lerna and Yarn workspaces are supported.
  *
- * @param cwd - The project root in which to find workspaces.
+ * @param cwd The project root in which to find workspaces.
  * @returns Discovered Appsemble blocks.
  */
 export declare function getWorkspaces(cwd: string): Promise<string[]>;

package/{dist/getWorkspaces.js → getWorkspaces.js}

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWorkspaces = void 0;
-const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
 const path_1 = require("path");
 const fast_glob_1 = __importDefault(require("fast-glob"));
 /**
@@ -12,11 +12,11 @@ const fast_glob_1 = __importDefault(require("fast-glob"));
  *
  * Both Lerna and Yarn workspaces are supported.
  *
- * @param cwd - The project root in which to find workspaces.
+ * @param cwd The project root in which to find workspaces.
  * @returns Discovered Appsemble blocks.
  */
 async function getWorkspaces(cwd) {
-    const { workspaces = [] } = JSON.parse(await fs_1.promises.readFile((0, path_1.join)(cwd, 'package.json'), 'utf8'));
+    const { workspaces = [] } = JSON.parse(await (0, promises_1.readFile)((0, path_1.join)(cwd, 'package.json'), 'utf8'));
     const dirs = await (0, fast_glob_1.default)(workspaces, {
         cwd,
         absolute: true,

package/getWorkspaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkspaces.js","sourceRoot":"","sources":["getWorkspaces.ts"],"names":[],"mappings":";;;;;;AAAA,0CAAuC;AACvC,+BAA4B;AAE5B,0DAA2B;AAE3B;;;;;;;GAOG;AACI,KAAK,UAAU,aAAa,CAAC,GAAW;IAC7C,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,MAAM,IAAI,GAAG,MAAM,IAAA,mBAAE,EAAC,UAAU,EAAE;QAChC,GAAG;QACH,QAAQ,EAAE,IAAI;QACd,mBAAmB,EAAE,IAAI;QACzB,eAAe,EAAE,IAAI;KACtB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AATD,sCASC"}

package/getWorkspaces.ts

@@ -0,0 +1,23 @@
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+
+import fg from 'fast-glob';
+
+/**
+ * Discover Appsemble blocks based on workspaces in a monorepo.
+ *
+ * Both Lerna and Yarn workspaces are supported.
+ *
+ * @param cwd The project root in which to find workspaces.
+ * @returns Discovered Appsemble blocks.
+ */
+export async function getWorkspaces(cwd: string): Promise<string[]> {
+  const { workspaces = [] } = JSON.parse(await readFile(join(cwd, 'package.json'), 'utf8'));
+  const dirs = await fg(workspaces, {
+    cwd,
+    absolute: true,
+    followSymbolicLinks: true,
+    onlyDirectories: true,
+  });
+  return dirs.sort();
+}

package/{dist/handleError.d.ts → handleError.d.ts}

@@ -4,8 +4,8 @@ import { Argv } from 'yargs';
  *
  * HTTP errors are formatted nicely. For other errors, the stack trace is logged.
  *
- * @param message - Unused.
- * @param error - The error that was thrown.
- * @param yargs - The active yargs instance.
+ * @param message Unused.
+ * @param error The error that was thrown.
+ * @param yargs The active yargs instance.
  */
 export declare function handleError(message: string, error: Error, yargs: Argv): void;

package/{dist/handleError.js → handleError.js}

@@ -8,9 +8,9 @@ const logger_1 = require("./logger");
  *
  * HTTP errors are formatted nicely. For other errors, the stack trace is logged.
  *
- * @param message - Unused.
- * @param error - The error that was thrown.
- * @param yargs - The active yargs instance.
+ * @param message Unused.
+ * @param error The error that was thrown.
+ * @param yargs The active yargs instance.
  */
 function handleError(message, error, yargs) {
     if (typeof message === 'string') {

package/handleError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleError.js","sourceRoot":"","sources":["handleError.ts"],"names":[],"mappings":";;;AAEA,qDAAkD;AAClD,qCAAkC;AAElC;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,OAAe,EAAE,KAAY,EAAE,KAAW;IACpE,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,KAAK,CAAC,QAAQ,EAAE,CAAC;QACjB,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KACxB;SAAM,IAAI,KAAK,YAAY,+BAAc,EAAE;QAC1C,eAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KAC7B;SAAM;QACL,eAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACrB;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAXD,kCAWC"}

package/handleError.test.d.ts

@@ -0,0 +1 @@
+export {};

package/handleError.test.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AppsembleError_1 = require("./AppsembleError");
+const handleError_1 = require("./handleError");
+const logger_1 = require("./logger");
+let yargs;
+beforeEach(() => {
+    yargs = { showHelp: jest.fn() };
+    jest.spyOn(console, 'error').mockImplementation();
+    jest.spyOn(process, 'exit').mockImplementation();
+    jest.spyOn(logger_1.logger, 'error').mockImplementation();
+});
+it('should show the help message if it is passed a yargs message', () => {
+    (0, handleError_1.handleError)('Command foo not found', undefined, yargs);
+    // eslint-disable-next-line no-console
+    expect(console.error).toHaveBeenCalledWith('Command foo not found');
+    expect(yargs.showHelp).toHaveBeenCalledWith();
+    expect(logger_1.logger.error).not.toHaveBeenCalled();
+    expect(process.exit).toHaveBeenCalledWith(1);
+});
+it('should log the message of an Appsemble error', () => {
+    (0, handleError_1.handleError)(undefined, new AppsembleError_1.AppsembleError('Oh noez!'), yargs);
+    expect(yargs.showHelp).not.toHaveBeenCalled();
+    expect(logger_1.logger.error).toHaveBeenCalledWith('Oh noez!');
+    expect(process.exit).toHaveBeenCalledWith(1);
+});
+it('should log unknown errors raw', () => {
+    const error = new Error('Oh noez!');
+    (0, handleError_1.handleError)(undefined, error, yargs);
+    expect(yargs.showHelp).not.toHaveBeenCalled();
+    expect(logger_1.logger.error).toHaveBeenCalledWith(error);
+    expect(process.exit).toHaveBeenCalledWith(1);
+});
+//# sourceMappingURL=handleError.test.js.map

package/handleError.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleError.test.js","sourceRoot":"","sources":["handleError.test.ts"],"names":[],"mappings":";;AAEA,qDAAkD;AAClD,+CAA4C;AAC5C,qCAAkC;AAElC,IAAI,KAAW,CAAC;AAEhB,UAAU,CAAC,GAAG,EAAE;IACd,KAAK,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,EAA2B,CAAC;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAClD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACjD,IAAI,CAAC,KAAK,CAAC,eAAM,EAAE,OAAO,CAAC,CAAC,kBAAkB,EAAE,CAAC;AACnD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACtE,IAAA,yBAAW,EAAC,uBAAuB,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACvD,sCAAsC;IACtC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;IACpE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,oBAAoB,EAAE,CAAC;IAC9C,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC5C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;IACtD,IAAA,yBAAW,EAAC,SAAS,EAAE,IAAI,+BAAc,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;IAC9D,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC9C,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;IACvC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IACpC,IAAA,yBAAW,EAAC,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC9C,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC"}

package/handleError.test.ts

@@ -0,0 +1,38 @@
+import { Argv } from 'yargs';
+
+import { AppsembleError } from './AppsembleError';
+import { handleError } from './handleError';
+import { logger } from './logger';
+
+let yargs: Argv;
+
+beforeEach(() => {
+  yargs = { showHelp: jest.fn() } as Partial<Argv> as Argv;
+  jest.spyOn(console, 'error').mockImplementation();
+  jest.spyOn(process, 'exit').mockImplementation();
+  jest.spyOn(logger, 'error').mockImplementation();
+});
+
+it('should show the help message if it is passed a yargs message', () => {
+  handleError('Command foo not found', undefined, yargs);
+  // eslint-disable-next-line no-console
+  expect(console.error).toHaveBeenCalledWith('Command foo not found');
+  expect(yargs.showHelp).toHaveBeenCalledWith();
+  expect(logger.error).not.toHaveBeenCalled();
+  expect(process.exit).toHaveBeenCalledWith(1);
+});
+
+it('should log the message of an Appsemble error', () => {
+  handleError(undefined, new AppsembleError('Oh noez!'), yargs);
+  expect(yargs.showHelp).not.toHaveBeenCalled();
+  expect(logger.error).toHaveBeenCalledWith('Oh noez!');
+  expect(process.exit).toHaveBeenCalledWith(1);
+});
+
+it('should log unknown errors raw', () => {
+  const error = new Error('Oh noez!');
+  handleError(undefined, error, yargs);
+  expect(yargs.showHelp).not.toHaveBeenCalled();
+  expect(logger.error).toHaveBeenCalledWith(error);
+  expect(process.exit).toHaveBeenCalledWith(1);
+});

package/handleError.ts

@@ -0,0 +1,26 @@
+import { Argv } from 'yargs';
+
+import { AppsembleError } from './AppsembleError';
+import { logger } from './logger';
+
+/**
+ * Handle a fatal error.
+ *
+ * HTTP errors are formatted nicely. For other errors, the stack trace is logged.
+ *
+ * @param message Unused.
+ * @param error The error that was thrown.
+ * @param yargs The active yargs instance.
+ */
+export function handleError(message: string, error: Error, yargs: Argv): void {
+  if (typeof message === 'string') {
+    yargs.showHelp();
+    // eslint-disable-next-line no-console
+    console.error(message);
+  } else if (error instanceof AppsembleError) {
+    logger.error(error.message);
+  } else {
+    logger.error(error);
+  }
+  process.exit(1);
+}

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,mDAAiC;AACjC,8CAA4B;AAC5B,6CAA2B;AAC3B,kDAAgC;AAChC,gDAA8B;AAC9B,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,uCAAqB;AACrB,iDAA+B"}

package/index.ts

@@ -0,0 +1,11 @@
+export * from './logger';
+export * from './AppsembleError';
+export * from './basicAuth';
+export * from './formData';
+export * from './getWorkspaces';
+export * from './handleError';
+export * from './interceptors';
+export * from './loggerMiddleware';
+export * from './readFileOrString';
+export * from './fs';
+export * from './testFixtures';

package/{dist/interceptors.d.ts → interceptors.d.ts}

@@ -11,21 +11,21 @@ declare module 'axios' {
 /**
  * An {@link axios} request interceptor to add support for {@link form-data}.
  *
- * @param config - The axios request configuration.
+ * @param config The axios request configuration.
  * @returns The config with additional `multipart/form-data` headers if appropriate.
  */
 export declare function formData(config: AxiosRequestConfig): AxiosRequestConfig;
 /**
  * An {@link axios} request interceptor to log requests.
  *
- * @param config - The axios request configuration.
+ * @param config The axios request configuration.
  * @returns The original config.
  */
 export declare function requestLogger(config: AxiosRequestConfig): AxiosRequestConfig;
 /**
  * An {@link axios} response interceptor to log responses.
  *
- * @param response - The axios response.
+ * @param response The axios response.
  * @returns The original response.
  */
 export declare function responseLogger(response: AxiosResponse): AxiosResponse;
@@ -34,8 +34,8 @@ export declare function responseLogger(response: AxiosResponse): AxiosResponse;
  *
  * This applies the interceptors in this modules and sets the appropriate user agent string.
  *
- * @param name - A PascalCase representation of the client.
- * @param version - The version of the client to represent.
+ * @param name A PascalCase representation of the client.
+ * @param version The version of the client to represent.
  */
 export declare function configureAxios(name: string, version: string): void;
 export {};

package/{dist/interceptors.js → interceptors.js}

@@ -16,7 +16,7 @@ const id = Symbol('id');
 /**
  * An {@link axios} request interceptor to add support for {@link form-data}.
  *
- * @param config - The axios request configuration.
+ * @param config The axios request configuration.
  * @returns The config with additional `multipart/form-data` headers if appropriate.
  */
 function formData(config) {
@@ -29,7 +29,7 @@ exports.formData = formData;
 /**
  * An {@link axios} request interceptor to log requests.
  *
- * @param config - The axios request configuration.
+ * @param config The axios request configuration.
  * @returns The original config.
  */
 function requestLogger(config) {
@@ -45,7 +45,7 @@ exports.requestLogger = requestLogger;
 /**
  * An {@link axios} response interceptor to log responses.
  *
- * @param response - The axios response.
+ * @param response The axios response.
  * @returns The original response.
  */
 function responseLogger(response) {
@@ -60,8 +60,8 @@ exports.responseLogger = responseLogger;
  *
  * This applies the interceptors in this modules and sets the appropriate user agent string.
  *
- * @param name - A PascalCase representation of the client.
- * @param version - The version of the client to represent.
+ * @param name A PascalCase representation of the client.
+ * @param version The version of the client to represent.
  */
 function configureAxios(name, version) {
     const ua = `${name}/${version} (${(0, os_1.type)()} ${(0, os_1.arch)()}; Node ${process.version})`;

package/interceptors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interceptors.js","sourceRoot":"","sources":["interceptors.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgC;AAEhC,kDAAiE;AACjE,iDAA0C;AAC1C,0DAAiC;AAEjC,qCAAkC;AAElC;;GAEG;AACH,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAQxB;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,MAA0B;IACjD,IAAI,MAAM,CAAC,IAAI,YAAY,mBAAQ,EAAE;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;KACzD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AALD,4BAKC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAA0B;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACxB,eAAM,CAAC,OAAO,CACZ,KAAK,IAAI,IAAI,IAAA,yBAAS,EAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;QACxF,QAAQ,EAAE,MAAM;KACjB,CAAC,EAAE,CACL,CAAC;IACF,6CAA6C;IAC7C,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,sCAUC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,QAAuB;IACpD,eAAM,CAAC,OAAO,CACZ,KAAK,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,IAAA,yBAAS,EAAC,YAAY,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,EAAE;QAC1F,QAAQ,EAAE,MAAM;KACjB,CAAC,EAAE,CACL,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAPD,wCAOC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,IAAY,EAAE,OAAe;IAC1D,MAAM,EAAE,GAAG,GAAG,IAAI,IAAI,OAAO,KAAK,IAAA,SAAI,GAAE,IAAI,IAAA,SAAI,GAAE,UAAU,OAAO,CAAC,OAAO,GAAG,CAAC;IAC/E,eAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;IAEjD,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC9C,eAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AAClD,CAAC;AAPD,wCAOC"}

package/interceptors.test.d.ts

@@ -0,0 +1 @@
+export {};