@syncify/acquire

Resolves ESM and CJS config files. Based on Bundle Require by egoist, performs identical resolution with minor differences for appropriation and usage in the Syncify CLI. Supports the following extensions and file types:

• .ts
• .js
• .cjs
• .mjs

How this differs from bundle-require?

Bundle require performs some additional analysis that I did not need along with applied logic which Syncify will have already obtained before calling acquire, this runtime is more effecient. The main differences is that this variation does not perform package.json analysis nor does not provide .tsx or .jsx support. Module resolution is applied on the thenable. The return object are exposed as getters and lastly, resolve issues will throw custom errors which are an AcquireError instance.

Installation

Peer depedency on ESBuild.

1pnpm add @syncify/acquire -D

Usage

The module itself can be used in isolation in any node.js project, despite being design for usage within Syncify CLI. Similar configuration and setup bundle-require, though the following methods and options are provided.

1import { acquire, $import, $tsconfig, $require } from '@syncify/acquire';
2
3await acquire({
4
5  file: '/path/to/syncify.config.ts',  // Required (or whatever file)
6
7  cwd: process.cwd(),                  // Optional
8  type: 'module' | undefined,          // Optional
9  named: undefined,                    // Optional
10  preserve: false,                     // Optional
11  tsconfig: '/path/to/tsconfig.json',  // Optional
12
13  external: [],                        // Optional
14  extenalNodeModules: [],              // Optional
15  noExternal: [],                      // Optional
16
17  onError: (errors) => [],             // Optional - Bundle errors (if any)
18  onWarning: (errors) => [],           // Optional - Bundle warnings (if any)
19  onRebuild: ($module) => $module      // Optional - Bundle Module
20
21})
22
23acquire.isWatching: boolean;           // Whether or not acquire is watch file for changes
24

The module is throughly typed and annotated with JSDocs comment descriptions, which will describe each option and method in good detail.

Practical Usage

The most basic usage is as follows:

1import { acquire } from '@syncify/acquire';
2
3const config = await acquire({
4  file: '/path/to/syncify.config.ts',
5  onError: errors => console.error(...errors)
6});
7
8config; // Returns null is errors or module itself