Ecosystem Overview
The Susee ecosystem centers on the public susee package — a TypeScript library bundler — and its dependency packages.
Package map
Core build pipeline in this repository (TypeScript)
The build engine is implemented in TypeScript under src/:
-
src/build.ts— thebuild()driver that loads config and runs the compiler -
src/bundler.ts— bundling wrapper (delegates to@suseejs/susee_bundler) -
src/compiler/index.ts— theCompilerclass that drives per-format compilation -
src/compiler/suseeCompiler.ts— in-memory TypeScript compilation host using@suseejs/ts6 -
src/compiler/tsoptions.ts— tsconfig resolution and compiler option generation -
src/config/index.ts— config loading, validation, and build option generation -
src/cli/index.ts— the CLI dispatcher -
src/cli/parse_args.ts— CLI argument parsing -
src/cli/init.ts— config file scaffolding -
src/cli/print_help.ts— help text -
src/cli/lint.ts— lint-only check command (delegates tosuseeLint) -
src/helpers/files.ts— file system operations and package.json updates -
src/helpers/minify.ts— oxc-minify wrapper
The package’s main entry point (src/index.ts) re-exports build, suseeBundle, SuSeeConfig, and CheckOptions.
Runtime dependencies
-
@suseejs/susee_bundler— dependency-aware source bundling (the core bundler engine), also providessuseeLint,logError/logWarning/logInfo, andLogTimer -
@suseejs/ts6— TypeScript compiler used for in-memory compilation -
oxc-minify— JavaScript minifier (compression + mangling)
Foundation packages
-
@suseejs/type— shared type definitions -
@suseejs/utilities— common utility helpers -
@suseejs/color— terminal color helpers
Note: These foundation packages are used internally by the
@suseejs/*ecosystem packages but are not direct dependencies of thesuseepackage itself.
How these pieces work together
A typical Susee build flow:
-
src/config/index.tsloads the config file and generatesBuildOptions. -
src/bundler.tscalls@suseejs/susee_bundlerto bundle the entry’s dependency tree into a single source string. -
src/compiler/tsoptions.tsresolves compiler options from tsconfig/defaults. -
src/compiler/suseeCompiler.tscompiles the bundled source using@suseejs/ts6into ESM/CJS output with declarations and source maps. -
src/helpers/minify.tsrunsoxc-minifywhen the entry’sminifyoption is enabled. -
src/helpers/files.tswrites output artifacts and optionally updatespackage.json.
Which page to read next
- For pipeline internals: Core Build Packages
- For shared primitives and types: Foundation Packages
- For contribution workflows: Contribution Overview
Install examples
Install the top-level tool:
sh
npm i -D susee
Install foundation packages:
sh
npm i @suseejs/type @suseejs/utilities @suseejs/color