island-build

0.0.11 verified Fri May 01 auth: no javascript

Build support module for island development, currently at v0.0.11. Provides tooling for building 'island' architectures (micro-frontends or isolated components) with minimal configuration. Differentiates by focusing on targeted builds for isolated UI islands. Early-stage package with breaking changes likely. Develops actively but version indicates pre-1.0.0 instability.

Common errors

error Error [ERR_MODULE_NOT_FOUND]: Cannot find module 'island-build' ↓

cause Missing installation or incorrect path.

fix

Run npm install island-build and ensure node_modules is present.

error TypeError: islandBuild is not a function ↓

cause Wrong import style: using named import for default export or CJS require.

fix

Use import islandBuild from 'island-build' (ESM default import).

error Unknown option: --entry. Use --help for usage. ↓

cause CLI is not supported; island-build is a programmatic API only.

fix

Remove CLI usage. Use JavaScript/TypeScript API.

Warnings

breaking API changed from v0.0.10: `createBuild` renamed to `buildIsland`. ↓

fix Use `buildIsland` instead of `createBuild`.

breaking Default export signature changed in v0.0.8: now accepts a config object instead of separate arguments. ↓

fix Pass single config object: `islandBuild({ entry: '...' })`.

gotcha CJS require fails: `require('island-build')` throws ERR_REQUIRE_ESM. ↓

fix Use `import` or dynamic import: `const island = await import('island-build')`.

deprecated `createConfig` is deprecated and will be removed in v1.0.0. ↓

fix Replace `createConfig` with `defineConfig`.

Install

npm install island-build

yarn add island-build

pnpm add island-build

Imports

islandBuild

wrong

const islandBuild = require('island-build')

correct

import islandBuild from 'island-build'

Default export; ESM-only since v0.1.0.

defineConfig

wrong

import defineConfig from 'island-build'

correct

import { defineConfig } from 'island-build'

Named export, not default.

buildIsland

wrong

import buildIsland from 'island-build'

correct

import { buildIsland } from 'island-build'

Named export.

Quickstart

Shows basic usage of both default and named exports to configure and build an island.

import islandBuild, { defineConfig, buildIsland } from 'island-build';

const config = defineConfig({
  entry: './src/island.tsx',
  outDir: './dist',
  format: 'esm',
});

await buildIsland(config);

// Or use the default export to run build directly
await islandBuild({ entry: './src/island.tsx' });