@visulima/packem 1.19.0 → 1.19.2

package/CHANGELOG.md

@@ -1,3 +1,40 @@
+## @visulima/packem [1.19.2](https://github.com/visulima/packem/compare/@visulima/packem@1.19.1...@visulima/packem@1.19.2) (2025-05-28)
+
+### Bug Fixes
+
+* added a new test file for the fixDynamicImportExtension plugin to ensure correct functionality. ([ef9e2da](https://github.com/visulima/packem/commit/ef9e2da28a96d035041604d8b959e2f01a811430))
+* fixed dynamic imports ([1fc3676](https://github.com/visulima/packem/commit/1fc3676039da0d116419e3babd3abd7a687fcf53))
+* **packem:** update rollup to v4.41 ([d5ddfe1](https://github.com/visulima/packem/commit/d5ddfe1a4bb464e5b7de618fd32a1b038c63f4b2))
+* **svg-encoder:** implement SVG encoding utility and update URL plugin ([407bc3e](https://github.com/visulima/packem/commit/407bc3e8f03d1f26c7e9ef1e6f6bd25eda38b3d7))
+* **tests:** enhance assertions in fixDynamicImportExtension test ([1d122ac](https://github.com/visulima/packem/commit/1d122acd288d752ab3f7ca9c4508cb6c43ba3fce))
+* **tests:** improve integration tests for file URL resolution and TypeScript error handling ([cb19cc3](https://github.com/visulima/packem/commit/cb19cc344acdbe6132b716c0290a625b9ad322c6))
+* **tests:** update SVG data URIs to Base64 format in snapshots ([11a84c0](https://github.com/visulima/packem/commit/11a84c002fd07cc5976b2a2ad917900db194bad8))
+* update dependencies and improve compatibility ([1c3b34a](https://github.com/visulima/packem/commit/1c3b34ab8d1aa3d6eff631cba468daefaf9df312))
+
+### Styles
+
+* cs fixes ([b67ff06](https://github.com/visulima/packem/commit/b67ff065b1d4012333ed860afe7c628e413f9e29))
+* cs fixes ([d604e41](https://github.com/visulima/packem/commit/d604e413d5c8da285e8a0ddb82924483bf35cfbc))
+
+### Miscellaneous Chores
+
+* upgraded eslint to v9, removed prettier ([#147](https://github.com/visulima/packem/issues/147)) ([6b5b991](https://github.com/visulima/packem/commit/6b5b991589797b861eee370550bae73e8471cbf2))
+
+### Code Refactoring
+
+* **tests:** improve test assertions and add svg encoder utility ([0123f5c](https://github.com/visulima/packem/commit/0123f5c20b42e4aed2434fe7d32001f20d113e07))
+* **tests:** rename execPackemSync to execPackem in test files ([ed33237](https://github.com/visulima/packem/commit/ed3323722d3141e11c4c4594ebb00a78e08c7ee0))
+
+### Continuous Integration
+
+* update configuration and test setup ([#146](https://github.com/visulima/packem/issues/146)) ([2c07594](https://github.com/visulima/packem/commit/2c07594b70b2a2db992d31c895b5a32feaccb0fa))
+
+## @visulima/packem [1.19.1](https://github.com/visulima/packem/compare/@visulima/packem@1.19.0...@visulima/packem@1.19.1) (2025-03-05)
+
+### Bug Fixes
+
+* fixed dts only out generation, fixed compatibility mode if the value is true ([a22c132](https://github.com/visulima/packem/commit/a22c1325bfffb6b3d17d745a1cc53c4d9559f04c))
+
 ## @visulima/packem [1.19.0](https://github.com/visulima/packem/compare/@visulima/packem@1.18.6...@visulima/packem@1.19.0) (2025-03-04)
 
 ### Features

package/README.md

@@ -37,28 +37,28 @@ It uses the `exports` configuration in `package.json` and recognizes entry file
 
 ## Features
 
--   ✅ package.json#exports, package.json#main, package.json#module to define entry-points
--   ✅ package.json#bin to define executables
--   ✅ package.json#types to define types
--   ✅ Generates package.json#typeVersions to support node 10
--   ✅ Dependency externalization
--   ✅ Minification
--   ✅ TypeScript support + .d.ts bundling
--   ✅ Watch mode
--   ✅ CLI outputs (auto hashbang insertion)
--   ✅ Validator
+- ✅ package.json#exports, package.json#main, package.json#module to define entry-points
+- ✅ package.json#bin to define executables
+- ✅ package.json#types to define types
+- ✅ Generates package.json#typeVersions to support node 10
+- ✅ Dependency externalization
+- ✅ Minification
+- ✅ TypeScript support + .d.ts bundling
+- ✅ Watch mode
+- ✅ CLI outputs (auto hashbang insertion)
+- ✅ Validator
     - Validates package.json and checks if all fields that are needed to publish your package are configured correctly
     - Bundle size validation
--   ✅ Supports multiple runtimes (default, react-server, edge-light, browser and node)
--   ✅ Supports react server and client components
--   ✅ Supports shared modules
--   ✅ Supports dynamic import
--   ✅ Supports `tsconfig.json` paths and `package.json` imports resolution
--   ✅ ESM ⇄ CJS interoperability
--   ✅ Supports isolated declaration types (experimental) (Typescript version 5.5 or higher)
--   ✅ Supports wasm [WebAssembly modules](http://webassembly.org)
--   ✅ Supports css, [sass](https://github.com/sass/sass), [less](https://github.com/less/less.js), [stylus](https://github.com/stylus/stylus) and Up-to-date [CSS Modules](https://github.com/css-modules/css-modules) (experimental)
--   ✅ [TypeDoc](https://github.com/TypeStrong/TypeDoc) documentation generation
+- ✅ Supports multiple runtimes (default, react-server, edge-light, browser and node)
+- ✅ Supports react server and client components
+- ✅ Supports shared modules
+- ✅ Supports dynamic import
+- ✅ Supports `tsconfig.json` paths and `package.json` imports resolution
+- ✅ ESM ⇄ CJS interoperability
+- ✅ Supports isolated declaration types (experimental) (Typescript version 5.5 or higher)
+- ✅ Supports wasm [WebAssembly modules](http://webassembly.org)
+- ✅ Supports css, [sass](https://github.com/sass/sass), [less](https://github.com/less/less.js), [stylus](https://github.com/stylus/stylus) and Up-to-date [CSS Modules](https://github.com/css-modules/css-modules) (experimental)
+- ✅ [TypeDoc](https://github.com/TypeStrong/TypeDoc) documentation generation
 
 And more...
 
@@ -181,7 +181,7 @@ You can validate your package.json exports configuration with [are the types wro
 
 Links:
 
--   https://github.com/frehner/modern-guide-to-packaging-js-library#set-the-main-field
+- https://github.com/frehner/modern-guide-to-packaging-js-library#set-the-main-field
 
 ## Usage
 
@@ -213,8 +213,8 @@ For example: `src/index.ts` will match the exports name `"."` or the only main e
 Now just run `npm run build` or `pnpm build` / `yarn build` if you're using these package managers, `packem` will find the entry files and build them.
 The output format will be based on the exports condition and also the file extension. Given an example:
 
--   It's CommonJS for `require` and ESM for `import` based on the exports condition.
--   It's CommonJS for `.cjs` and ESM for `.mjs` based on the extension regardless the exports condition. Then for export condition like "node" you could choose the format with your extension.
+- It's CommonJS for `require` and ESM for `import` based on the exports condition.
+- It's CommonJS for `.cjs` and ESM for `.mjs` based on the extension regardless the exports condition. Then for export condition like "node" you could choose the format with your extension.
 
 > [!NOTE]
 > All the `dependencies` and `peerDependencies` will be marked as external automatically and not included in the bundle. If you want to include them in the bundle, you can use the `--no-external` option.
@@ -248,8 +248,8 @@ For instance:
 
 If you need to separate the `production` and `development` exports condition, `packem` provides `process.env.NODE_ENV` injected by default if present that you don't need to manually inject yourself.
 
--   When the `production` exports condition is defined and the file ends with `*.production.*` in the package.json, the bundle will be minified.
--   When the `development` exports condition is defined and the file ends with `*.development.*` in the package.json, the bundle will not be minified.
+- When the `production` exports condition is defined and the file ends with `*.production.*` in the package.json, the bundle will be minified.
+- When the `development` exports condition is defined and the file ends with `*.development.*` in the package.json, the bundle will not be minified.
 
 ```json
 {
@@ -328,6 +328,9 @@ There are always cases that you need to share code among bundles, but they don't
 
 ```js
 // src/util.shared-runtime.js
+/**
+ *
+ */
 export function sharedUtil() {
     /* ... */
 }
@@ -337,12 +340,12 @@ Then you can use them in different entry files:
 
 ```js
 // src/index.js
-import { sharedUtil } from "./util.shared-runtime";
+import { sharedUtil as sharedUtility } from "./util.shared-runtime";
 ```
 
 ```js
 // src/lite.js
-import { sharedUtil } from "./util.shared-runtime";
+import { sharedUtil as sharedUtility } from "./util.shared-runtime";
 ```
 
 `packem` will bundle the shared module into a separate **layer** which matches the file name convention, in the above case it's "shared", and that bundle will be referenced by the different entry bundles.
@@ -356,6 +359,7 @@ With multiple runtime bundles, such as having `default` and `react-server` toget
 
 ```js
 "use client";
+
 // src/app-context.shared-runtime.js
 export const AppContext = React.createContext(null);
 ```
@@ -396,7 +400,7 @@ Use the `--visualize` flag to generate a `packem-bundle-analyze.html` file at bu
 `packem` supports building module workers with the `--workers` flag, which are a special type of bundle that can be used to run code in a web worker.
 
 ```js
-worker = new Worker(new URL("./worker.js", import.meta.url), { type: "module" });
+worker = new Worker(new URL("worker.js", import.meta.url), { type: "module" });
 // or simply:
 worker = new Worker("./worker.js", { type: "module" });
 ```
@@ -411,17 +415,17 @@ The value of `type` can be either `"build"` or `"dts"`, where `"build"` is the d
 
 The resolved plugins will be in the following order:
 
--   Alias
--   User plugins with enforce: 'pre'
--   Rollup core plugins
--   User plugins without enforce value
--   Rollup build plugins
--   User plugins with enforce: 'post'
--   Rollup post build plugins (minify, manifest, copy, reporting)
+- Alias
+- User plugins with enforce: 'pre'
+- Rollup core plugins
+- User plugins without enforce value
+- Rollup build plugins
+- User plugins with enforce: 'post'
+- Rollup post build plugins (minify, manifest, copy, reporting)
 
 ```typescript
-import { defineConfig } from "@visulima/packem/config";
 import { optimizeLodashImports } from "@optimize-lodash/rollup-plugin";
+import { defineConfig } from "@visulima/packem/config";
 
 export default defineConfig({
     // ...
@@ -450,13 +454,13 @@ Native Node.js import mapping supports conditional imports (eg. resolving differ
 {
     // ...
 
-    imports: {
+    "imports": {
         // Mapping '~utils' to './src/utils.js'
         "~utils": "./src/utils.js",
 
         // Native Node.js import mapping (can't reference ./src)
-        "#internal-package": "./vendors/package/index.js",
-    },
+        "#internal-package": "./vendors/package/index.js"
+    }
 }
 ```
 
@@ -500,43 +504,45 @@ packem build --env.NODE_ENV=production
 You can use Packem programmatically in your Node.js applications without the CLI:
 
 ```typescript
-import { packem } from '@visulima/packem';
+import { packem } from "@visulima/packem";
 
 // Basic usage
-await packem('./src', {
-    mode: 'build',
-    environment: 'production'
+await packem("./src", {
+    environment: "production",
+    mode: "build",
 });
 
 // With custom options
-await packem('./src', {
-    mode: 'build',
-    environment: 'development',
+await packem("./src", {
     declaration: true,
-    minify: true,
-    sourcemap: true,
+    environment: "development",
     logger: {
         // Custom logger options
-        level: 'debug'
-    }
+        level: "debug",
+    },
+    minify: true,
+    mode: "build",
+    sourcemap: true,
 });
 ```
 
 The `packem` function accepts the following parameters:
+
 - `rootDirectory` (string): The root directory of your project to bundle
 - `options` (PackemOptions): Configuration options that extend the BuildConfig interface
-  - `mode`: The build mode ('build' | 'watch')
-  - `environment`: The target environment ('development' | 'production')
-  - `declaration`: Enable/disable TypeScript declaration file generation
-  - `minify`: Enable/disable code minification
-  - `sourcemap`: Enable/disable source map generation
-  - `logger`: Logger configuration options
+    - `mode`: The build mode ('build' | 'watch')
+    - `environment`: The target environment ('development' | 'production')
+    - `declaration`: Enable/disable TypeScript declaration file generation
+    - `minify`: Enable/disable code minification
+    - `sourcemap`: Enable/disable source map generation
+    - `logger`: Logger configuration options
 
 For more detailed configuration options, refer to the [Configuration](#configuration) section.
 
 ## Validators
 
 ### Package.json Validation
+
 `Packem` validates your `package.json` file and checks if all fields are configured correctly, that are needed to publish your package.
 
 > [!NOTE]
@@ -556,10 +562,10 @@ export default defineConfig({
             limit: 1024 * 1024, // 1MB
             // or / and limits per file
             limits: {
-                "index.cjs": 1024 * 1024, // 1MB
-                "test.mjs": "1MB",
                 // Glob pattern
                 "**/*.mjs": "1MB",
+                "index.cjs": 1024 * 1024, // 1MB
+                "test.mjs": "1MB",
             },
         },
     },
@@ -634,21 +640,20 @@ export default defineConfig({
 
 You need to choose of the supported transformer to use isolated declaration types.
 
--   [oxc](https://github.com/oxc-project/oxc)
--   [@swc/core](https://github.com/swc-project/swc)
--   [typescript](https://github.com/microsoft/TypeScript)
+- [oxc](https://github.com/oxc-project/oxc)
+- [@swc/core](https://github.com/swc-project/swc)
+- [typescript](https://github.com/microsoft/TypeScript)
 
 Default is `typescript`.
 
 ```ts
 import { defineConfig } from "@visulima/packem/config";
-import transformer from "@visulima/packem/transformer/esbuild";
 import isolatedDeclarationTransformer from "@visulima/packem/dts/isolated/transformer/typescript";
+import transformer from "@visulima/packem/transformer/esbuild";
 
-// eslint-disable-next-line import/no-unused-modules
 export default defineConfig({
-    transformer,
     isolatedDeclarationTransformer,
+    transformer,
 });
 ```
 
@@ -658,22 +663,22 @@ export default defineConfig({
 
 `packem` supports:
 
--   [PostCSS](https://github.com/postcss/postcss)
--   [Sass](https://github.com/sass/sass)
--   [Less](https://github.com/less/less.js)
--   [Stylus](https://github.com/stylus/stylus)
--   Up-to-date [CSS Modules](https://github.com/css-modules/css-modules) implementation
--   URL resolving/rewriting with asset handling
--   Ability to use `@import` statements inside regular CSS
--   Built-in assets handler
--   Ability to emit pure CSS for other plugins
--   Complete code splitting support, with respect for multiple entries, `preserveModules` and `manualChunks`
--   Multiple instances support, with check for already processed files
--   Proper sourcemaps, with included sources content by default
--   Respects `assetFileNames` for CSS file names
--   Respects sourcemaps from loaded files
--   Support for implementation forcing for Sass
--   Support for partials and `~` in Less import statements
+- [PostCSS](https://github.com/postcss/postcss)
+- [Sass](https://github.com/sass/sass)
+- [Less](https://github.com/less/less.js)
+- [Stylus](https://github.com/stylus/stylus)
+- Up-to-date [CSS Modules](https://github.com/css-modules/css-modules) implementation
+- URL resolving/rewriting with asset handling
+- Ability to use `@import` statements inside regular CSS
+- Built-in assets handler
+- Ability to emit pure CSS for other plugins
+- Complete code splitting support, with respect for multiple entries, `preserveModules` and `manualChunks`
+- Multiple instances support, with check for already processed files
+- Proper sourcemaps, with included sources content by default
+- Respects `assetFileNames` for CSS file names
+- Respects sourcemaps from loaded files
+- Support for implementation forcing for Sass
+- Support for partials and `~` in Less import statements
 
 ### PostCSS
 
@@ -698,17 +703,17 @@ Add the loader to your `packem.config.ts`:
 
 ```typescript
 import { defineConfig } from "@visulima/packem/config";
-import transformer from "@visulima/packem/transformer/esbuild";
 import postcssLoader from "@visulima/packem/css/loader/postcss";
 import sourceMapLoader from "@visulima/packem/css/loader/sourcemap";
+import transformer from "@visulima/packem/transformer/esbuild";
 
 export default defineConfig({
-    transformer,
     rollup: {
         css: {
             loaders: [postcssLoader, sourceMapLoader],
         },
     },
+    transformer,
 });
 ```
 
@@ -744,18 +749,18 @@ Add the loader to your `packem.config.ts`:
 
 ```typescript
 import { defineConfig } from "@visulima/packem/config";
-import transformer from "@visulima/packem/transformer/esbuild";
 import postcssLoader from "@visulima/packem/css/loader/postcss";
 import sassLoader from "@visulima/packem/css/loader/sass";
 import sourceMapLoader from "@visulima/packem/css/loader/sourcemap";
+import transformer from "@visulima/packem/transformer/esbuild";
 
 export default defineConfig({
-    transformer,
     rollup: {
         css: {
             loaders: [postcssLoader, sassLoader, sourceMapLoader],
         },
     },
+    transformer,
 });
 ```
 
@@ -779,18 +784,18 @@ Add the loader to your `packem.config.ts`:
 
 ```typescript
 import { defineConfig } from "@visulima/packem/config";
-import transformer from "@visulima/packem/transformer/esbuild";
-import postcssLoader from "@visulima/packem/css/loader/postcss";
 import lessLoader from "@visulima/packem/css/loader/less";
+import postcssLoader from "@visulima/packem/css/loader/postcss";
 import sourceMapLoader from "@visulima/packem/css/loader/sourcemap";
+import transformer from "@visulima/packem/transformer/esbuild";
 
 export default defineConfig({
-    transformer,
     rollup: {
         css: {
             loaders: [postcssLoader, lessLoader, sourceMapLoader],
         },
     },
+    transformer,
 });
 ```
 
@@ -814,18 +819,18 @@ Add the loader to your `packem.config.ts`:
 
 ```typescript
 import { defineConfig } from "@visulima/packem/config";
-import transformer from "@visulima/packem/transformer/esbuild";
 import postcssLoader from "@visulima/packem/css/loader/postcss";
-import stylusLoader from "@visulima/packem/css/loader/stylus";
 import sourceMapLoader from "@visulima/packem/css/loader/sourcemap";
+import stylusLoader from "@visulima/packem/css/loader/stylus";
+import transformer from "@visulima/packem/transformer/esbuild";
 
 export default defineConfig({
-    transformer,
     rollup: {
         css: {
             loaders: [postcssLoader, stylusLoader, sourceMapLoader],
         },
     },
+    transformer,
 });
 ```
 
@@ -890,7 +895,7 @@ Will look for `_custom` first (_with the appropriate extension(s)_), and then fo
 styles({
     mode: "inject", // Unnecessary, set by default
     // ...or with custom options for injector
-    mode: ["inject", { container: "body", singleTag: true, prepend: true, attributes: { id: "global" } }],
+    mode: ["inject", { attributes: { id: "global" }, container: "body", prepend: true, singleTag: true }],
     // ...or with custom injector
     mode: ["inject", (varname, id) => `console.log(${varname},${JSON.stringify(id)})`],
 });
@@ -943,10 +948,12 @@ import { defineConfig } from "@visulima/packem/config";
 export default defineConfig({
     // ...
     onSuccess() {
-        const server = http.createServer((req, res) => {
+        const server = http.createServer((request, res) => {
             res.end("Hello World!");
         });
+
         server.listen(3000);
+
         return () => {
             server.close();
         };
@@ -964,10 +971,10 @@ The packem configuration file is a JavaScript file that exports an object with t
 
 You choose which one of the three supported transformer to use.
 
--   [esbuild](https://github.com/evanw/esbuild)
--   [@swc/core](https://github.com/swc-project/swc)
--   [sucrase](https://github.com/alangpierce/sucrase)
--   [OXC](https://www.npmjs.com/package/oxc-transform)
+- [esbuild](https://github.com/evanw/esbuild)
+- [@swc/core](https://github.com/swc-project/swc)
+- [sucrase](https://github.com/alangpierce/sucrase)
+- [OXC](https://www.npmjs.com/package/oxc-transform)
 
 ### File types
 
@@ -998,10 +1005,12 @@ This will provide the following type shims:
 > To override the default typing, add a type definition file that contains your typings. Then, add the type reference before `@visulima/packem/files`.
 >
 > packem-env-override.d.ts (the file that contains your typings):
+>
 > ```ts
-> declare module '*.svg' {
->  const content: React.FC<React.SVGProps<SVGElement>>
->  export default content
+> declare module "*.svg" {
+>     const content: React.FC<React.SVGProps<SVGElement>>;
+>
+>     export default content;
 > }
 > ```
 >
@@ -1014,12 +1023,12 @@ This will provide the following type shims:
 
 ## Related
 
--   [bunchee](https://github.com/huozhi/bunchee) - Zero config bundler for ECMAScript and TypeScript packages
--   [unbuild](https://github.com/unjs/unbuild) - 📦 An unified javascript build system
--   [pkgroll](https://github.com/privatenumber/pkgroll) - 📦 Zero-config package bundler for Node.js + TypeScript
--   [siroc](https://github.com/danielroe/siroc) - Zero-config build tooling for Node
--   [tsup](https://github.com/egoist/tsup) - The simplest and fastest way to bundle your TypeScript libraries
--   [microbundle](https://github.com/developit/microbundle) - Zero-configuration bundler for tiny JS libs, powered by Rollup.
+- [bunchee](https://github.com/huozhi/bunchee) - Zero config bundler for ECMAScript and TypeScript packages
+- [unbuild](https://github.com/unjs/unbuild) - 📦 An unified javascript build system
+- [pkgroll](https://github.com/privatenumber/pkgroll) - 📦 Zero-config package bundler for Node.js + TypeScript
+- [siroc](https://github.com/danielroe/siroc) - Zero-config build tooling for Node
+- [tsup](https://github.com/egoist/tsup) - The simplest and fastest way to bundle your TypeScript libraries
+- [microbundle](https://github.com/developit/microbundle) - Zero-configuration bundler for tiny JS libs, powered by Rollup.
 
 ## Supported Node.js Versions
 
@@ -1034,8 +1043,8 @@ If you would like to help take a look at the [list of issues](https://github.com
 
 ## Credits
 
--   [Daniel Bannert](https://github.com/prisis)
--   [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
+- [Daniel Bannert](https://github.com/prisis)
+- [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
 
 ## License
 

package/dist/builder/typedoc/index.cjs

@@ -1,3 +1,3 @@
-"use strict";var v=Object.defineProperty;var g=(e,t)=>v(e,"name",{value:t,configurable:!0});const P=require("@visulima/colorize"),h=require("@visulima/path"),k=require("../../packem_shared/create-or-update-key-storage-mzqiq3Nk.cjs"),A=require("node:fs"),y=require("@visulima/fs"),F=require("typedoc");var $=Object.defineProperty,b=g((e,t)=>$(e,"name",{value:t,configurable:!0}),"w");const q=b(async(e,t,r,a)=>{if(t.length===0)return;const{format:n,marker:o,output:R,plugin:j,readmePath:s,jsonFileName:p,...w}=e;if(n==="inline"&&s===void 0)throw new Error("The `readmePath` option is required when using the `inline` format.");if(n!=="inline"&&typeof s=="string"&&a.warn({message:"The `readmePath` option is only used when the `inline` format is used.",prefix:"typedoc"}),n==="json"){if(p===void 0)throw new Error("The `jsonFileName` option is required when using the `json` format.");if(p.endsWith(".json")===!1)throw new Error("The `jsonFileName` option must end with `.json`.")}n!=="json"&&typeof p=="string"&&a.warn({message:"The `jsonFileName` option is only used when the `json` format is used.",prefix:"typedoc"});const E=t.map(f=>f.input),u=j??[];u.push("typedoc-plugin-rename-defaults"),(n==="inline"||n==="markdown")&&u.push("typedoc-plugin-markdown");const l=await F.Application.bootstrapWithPlugins({...w,compilerOptions:{allowJs:!0,declaration:!1,declarationMap:!1,esModuleInterop:!0,module:99,moduleResolution:100,noEmit:!0,noImplicitAny:!1,skipLibCheck:!0,sourceMap:!1,target:99,...w.compilerOptions},entryPoints:E,hideGenerator:!0,plugin:u,out:r,...n==="inline"?{hideBreadcrumbs:!0,hidePageHeader:!0,navigation:!1,outputFileStrategy:"modules",useCodeBlocks:!0}:{}},[]),d=await l.convert();if(d){if(n==="json")await l.generateJson(d,p);else if(n==="html")await l.generateDocs(d,r);else if(await l.generateOutputs(d),n==="inline"){if(o===void 0)throw new Error("The `marker` option is required when using the `inline` format.");const f=A.readdirSync(r,{withFileTypes:!0}).filter(i=>i.isFile());let m="";for(const i of f)i.name==="README.md"&&t.length>1||(m+=y.readFileSync(h.join(r,i.name)).replaceAll(`<!-- ${o}`,`<!-- _REPLACE_${o}`).replaceAll("<!-- ${marker}",`<!-- _REPLACE_\\${o}`));if(m!==""){const i=y.readFileSync(s),c=k.g(i,o,`
-`+m);if(!c){a.error({message:`Could not find the typedoc marker: <!-- ${o} --><!-- /${o} --> in ${s}`,prefix:"typedoc"});return}if(i===c)return;c&&y.writeFileSync(s,c.replaceAll(`<!-- _REPLACE_${o}`,`<!-- ${o}`).replaceAll(`<!-- _REPLACE_\\${o}`,"<!-- ${marker}"),{overwrite:!0})}}}},"generateReferenceDocumentation");var _=Object.defineProperty,T=g((e,t)=>_(e,"name",{value:t,configurable:!0}),"r");const C=T(async(e,t,r,a)=>{if(e.options.typedoc&&e.options.typedoc.format!==void 0){let n="unknown";e.pkg.dependencies?.typedoc?n=e.pkg.dependencies.typedoc:e.pkg.devDependencies?.typedoc&&(n=e.pkg.devDependencies.typedoc),t&&k.d("typedoc",t,e.logger,!0),a&&e.logger.raw(`
-`),e.logger.info({message:"Using "+P.cyan("typedoc")+" "+n+" to generate reference documentation",prefix:"typedoc"}),await e.hooks.callHook("typedoc:before",e);let o=e.options.rootDir;e.options.typedoc.output?o=e.options.typedoc.output:e.options.typedoc.format==="inline"&&t?o=h.join(t,"typedoc"):e.options.typedoc.format!=="json"&&(o=h.join(o,"api-docs")),await q(e.options.typedoc,e.options.entries,o,e.logger),await e.hooks.callHook("typedoc:done",e)}},"builder");module.exports=C;
+"use strict";var v=Object.defineProperty;var g=(e,o)=>v(e,"name",{value:o,configurable:!0});const $=require("@visulima/colorize"),h=require("@visulima/path"),k=require("../../packem_shared/create-or-update-key-storage-DKcZnYd5.cjs"),P=require("node:fs"),y=require("@visulima/fs"),A=require("typedoc");var F=Object.defineProperty,b=g((e,o)=>F(e,"name",{value:o,configurable:!0}),"w");const q=b(async(e,o,a,s)=>{if(o.length===0)return;const{format:t,jsonFileName:n,marker:i,output:R,plugin:j,readmePath:p,...w}=e;if(t==="inline"&&p===void 0)throw new Error("The `readmePath` option is required when using the `inline` format.");if(t!=="inline"&&typeof p=="string"&&s.warn({message:"The `readmePath` option is only used when the `inline` format is used.",prefix:"typedoc"}),t==="json"){if(n===void 0)throw new Error("The `jsonFileName` option is required when using the `json` format.");if(!n.endsWith(".json"))throw new Error("The `jsonFileName` option must end with `.json`.")}t!=="json"&&typeof n=="string"&&s.warn({message:"The `jsonFileName` option is only used when the `json` format is used.",prefix:"typedoc"});const E=o.map(f=>f.input),u=j??[];u.push("typedoc-plugin-rename-defaults"),(t==="inline"||t==="markdown")&&u.push("typedoc-plugin-markdown");const l=await A.Application.bootstrapWithPlugins({...w,compilerOptions:{allowJs:!0,declaration:!1,declarationMap:!1,esModuleInterop:!0,module:99,moduleResolution:100,noEmit:!0,noImplicitAny:!1,skipLibCheck:!0,sourceMap:!1,target:99,...w.compilerOptions},entryPoints:E,hideGenerator:!0,out:a,plugin:u,...t==="inline"?{hideBreadcrumbs:!0,hidePageHeader:!0,navigation:!1,outputFileStrategy:"modules",useCodeBlocks:!0}:{}},[]),d=await l.convert();if(d){if(t==="json")await l.generateJson(d,n);else if(t==="html")await l.generateDocs(d,a);else if(await l.generateOutputs(d),t==="inline"){if(i===void 0)throw new Error("The `marker` option is required when using the `inline` format.");const f=P.readdirSync(a,{withFileTypes:!0}).filter(r=>r.isFile());let m="";for(const r of f)r.name==="README.md"&&o.length>1||(m+=y.readFileSync(h.join(a,r.name)).replaceAll(`<!-- ${i}`,`<!-- _REPLACE_${i}`).replaceAll("<!-- ${marker}",`<!-- _REPLACE_\\${i}`));if(m!==""){const r=y.readFileSync(p),c=k.g(r,i,`
+${m}`);if(!c){s.error({message:`Could not find the typedoc marker: <!-- ${i} --><!-- /${i} --> in ${p}`,prefix:"typedoc"});return}if(r===c)return;c&&y.writeFileSync(p,c.replaceAll(`<!-- _REPLACE_${i}`,`<!-- ${i}`).replaceAll(`<!-- _REPLACE_\\${i}`,"<!-- ${marker}"),{overwrite:!0})}}}},"generateReferenceDocumentation");var _=Object.defineProperty,T=g((e,o)=>_(e,"name",{value:o,configurable:!0}),"r");const C=T(async(e,o,a,s)=>{if(e.options.typedoc&&e.options.typedoc.format!==void 0){let t="unknown";e.pkg.dependencies?.typedoc?t=e.pkg.dependencies.typedoc:e.pkg.devDependencies?.typedoc&&(t=e.pkg.devDependencies.typedoc),o&&k.d("typedoc",o,e.logger,!0),s&&e.logger.raw(`
+`),e.logger.info({message:`Using ${$.cyan("typedoc")} ${t} to generate reference documentation`,prefix:"typedoc"}),await e.hooks.callHook("typedoc:before",e);let n=e.options.rootDir;e.options.typedoc.output?n=e.options.typedoc.output:e.options.typedoc.format==="inline"&&o?n=h.join(o,"typedoc"):e.options.typedoc.format!=="json"&&(n=h.join(n,"api-docs")),await q(e.options.typedoc,e.options.entries,n,e.logger),await e.hooks.callHook("typedoc:done",e)}},"builder");module.exports=C;

package/dist/builder/typedoc/index.mjs

@@ -1,3 +1,3 @@
-var j=Object.defineProperty;var g=(e,t)=>j(e,"name",{value:t,configurable:!0});import{cyan as v}from"@visulima/colorize";import{join as h}from"@visulima/path";import{g as P,d as A}from"../../packem_shared/create-or-update-key-storage-Bm-Xu0uJ.mjs";import{readdirSync as $}from"node:fs";import{readFileSync as w,writeFileSync as F}from"@visulima/fs";import{Application as b}from"typedoc";var T=Object.defineProperty,_=g((e,t)=>T(e,"name",{value:t,configurable:!0}),"w");const C=_(async(e,t,r,a)=>{if(t.length===0)return;const{format:n,marker:o,output:x,plugin:k,readmePath:s,jsonFileName:p,...y}=e;if(n==="inline"&&s===void 0)throw new Error("The `readmePath` option is required when using the `inline` format.");if(n!=="inline"&&typeof s=="string"&&a.warn({message:"The `readmePath` option is only used when the `inline` format is used.",prefix:"typedoc"}),n==="json"){if(p===void 0)throw new Error("The `jsonFileName` option is required when using the `json` format.");if(p.endsWith(".json")===!1)throw new Error("The `jsonFileName` option must end with `.json`.")}n!=="json"&&typeof p=="string"&&a.warn({message:"The `jsonFileName` option is only used when the `json` format is used.",prefix:"typedoc"});const E=t.map(m=>m.input),u=k??[];u.push("typedoc-plugin-rename-defaults"),(n==="inline"||n==="markdown")&&u.push("typedoc-plugin-markdown");const l=await b.bootstrapWithPlugins({...y,compilerOptions:{allowJs:!0,declaration:!1,declarationMap:!1,esModuleInterop:!0,module:99,moduleResolution:100,noEmit:!0,noImplicitAny:!1,skipLibCheck:!0,sourceMap:!1,target:99,...y.compilerOptions},entryPoints:E,hideGenerator:!0,plugin:u,out:r,...n==="inline"?{hideBreadcrumbs:!0,hidePageHeader:!0,navigation:!1,outputFileStrategy:"modules",useCodeBlocks:!0}:{}},[]),d=await l.convert();if(d){if(n==="json")await l.generateJson(d,p);else if(n==="html")await l.generateDocs(d,r);else if(await l.generateOutputs(d),n==="inline"){if(o===void 0)throw new Error("The `marker` option is required when using the `inline` format.");const m=$(r,{withFileTypes:!0}).filter(i=>i.isFile());let f="";for(const i of m)i.name==="README.md"&&t.length>1||(f+=w(h(r,i.name)).replaceAll(`<!-- ${o}`,`<!-- _REPLACE_${o}`).replaceAll("<!-- ${marker}",`<!-- _REPLACE_\\${o}`));if(f!==""){const i=w(s),c=P(i,o,`
-`+f);if(!c){a.error({message:`Could not find the typedoc marker: <!-- ${o} --><!-- /${o} --> in ${s}`,prefix:"typedoc"});return}if(i===c)return;c&&F(s,c.replaceAll(`<!-- _REPLACE_${o}`,`<!-- ${o}`).replaceAll(`<!-- _REPLACE_\\${o}`,"<!-- ${marker}"),{overwrite:!0})}}}},"generateReferenceDocumentation");var R=Object.defineProperty,D=g((e,t)=>R(e,"name",{value:t,configurable:!0}),"r");const B=D(async(e,t,r,a)=>{if(e.options.typedoc&&e.options.typedoc.format!==void 0){let n="unknown";e.pkg.dependencies?.typedoc?n=e.pkg.dependencies.typedoc:e.pkg.devDependencies?.typedoc&&(n=e.pkg.devDependencies.typedoc),t&&A("typedoc",t,e.logger,!0),a&&e.logger.raw(`
-`),e.logger.info({message:"Using "+v("typedoc")+" "+n+" to generate reference documentation",prefix:"typedoc"}),await e.hooks.callHook("typedoc:before",e);let o=e.options.rootDir;e.options.typedoc.output?o=e.options.typedoc.output:e.options.typedoc.format==="inline"&&t?o=h(t,"typedoc"):e.options.typedoc.format!=="json"&&(o=h(o,"api-docs")),await C(e.options.typedoc,e.options.entries,o,e.logger),await e.hooks.callHook("typedoc:done",e)}},"builder");export{B as default};
+var j=Object.defineProperty;var g=(e,o)=>j(e,"name",{value:o,configurable:!0});import{cyan as v}from"@visulima/colorize";import{join as h}from"@visulima/path";import{g as $,d as P}from"../../packem_shared/create-or-update-key-storage-BATQud1F.mjs";import{readdirSync as A}from"node:fs";import{readFileSync as w,writeFileSync as F}from"@visulima/fs";import{Application as b}from"typedoc";var T=Object.defineProperty,_=g((e,o)=>T(e,"name",{value:o,configurable:!0}),"w");const C=_(async(e,o,a,s)=>{if(o.length===0)return;const{format:t,jsonFileName:n,marker:i,output:x,plugin:k,readmePath:p,...y}=e;if(t==="inline"&&p===void 0)throw new Error("The `readmePath` option is required when using the `inline` format.");if(t!=="inline"&&typeof p=="string"&&s.warn({message:"The `readmePath` option is only used when the `inline` format is used.",prefix:"typedoc"}),t==="json"){if(n===void 0)throw new Error("The `jsonFileName` option is required when using the `json` format.");if(!n.endsWith(".json"))throw new Error("The `jsonFileName` option must end with `.json`.")}t!=="json"&&typeof n=="string"&&s.warn({message:"The `jsonFileName` option is only used when the `json` format is used.",prefix:"typedoc"});const E=o.map(m=>m.input),u=k??[];u.push("typedoc-plugin-rename-defaults"),(t==="inline"||t==="markdown")&&u.push("typedoc-plugin-markdown");const l=await b.bootstrapWithPlugins({...y,compilerOptions:{allowJs:!0,declaration:!1,declarationMap:!1,esModuleInterop:!0,module:99,moduleResolution:100,noEmit:!0,noImplicitAny:!1,skipLibCheck:!0,sourceMap:!1,target:99,...y.compilerOptions},entryPoints:E,hideGenerator:!0,out:a,plugin:u,...t==="inline"?{hideBreadcrumbs:!0,hidePageHeader:!0,navigation:!1,outputFileStrategy:"modules",useCodeBlocks:!0}:{}},[]),d=await l.convert();if(d){if(t==="json")await l.generateJson(d,n);else if(t==="html")await l.generateDocs(d,a);else if(await l.generateOutputs(d),t==="inline"){if(i===void 0)throw new Error("The `marker` option is required when using the `inline` format.");const m=A(a,{withFileTypes:!0}).filter(r=>r.isFile());let f="";for(const r of m)r.name==="README.md"&&o.length>1||(f+=w(h(a,r.name)).replaceAll(`<!-- ${i}`,`<!-- _REPLACE_${i}`).replaceAll("<!-- ${marker}",`<!-- _REPLACE_\\${i}`));if(f!==""){const r=w(p),c=$(r,i,`
+${f}`);if(!c){s.error({message:`Could not find the typedoc marker: <!-- ${i} --><!-- /${i} --> in ${p}`,prefix:"typedoc"});return}if(r===c)return;c&&F(p,c.replaceAll(`<!-- _REPLACE_${i}`,`<!-- ${i}`).replaceAll(`<!-- _REPLACE_\\${i}`,"<!-- ${marker}"),{overwrite:!0})}}}},"generateReferenceDocumentation");var R=Object.defineProperty,D=g((e,o)=>R(e,"name",{value:o,configurable:!0}),"r");const B=D(async(e,o,a,s)=>{if(e.options.typedoc&&e.options.typedoc.format!==void 0){let t="unknown";e.pkg.dependencies?.typedoc?t=e.pkg.dependencies.typedoc:e.pkg.devDependencies?.typedoc&&(t=e.pkg.devDependencies.typedoc),o&&P("typedoc",o,e.logger,!0),s&&e.logger.raw(`
+`),e.logger.info({message:`Using ${v("typedoc")} ${t} to generate reference documentation`,prefix:"typedoc"}),await e.hooks.callHook("typedoc:before",e);let n=e.options.rootDir;e.options.typedoc.output?n=e.options.typedoc.output:e.options.typedoc.format==="inline"&&o?n=h(o,"typedoc"):e.options.typedoc.format!=="json"&&(n=h(n,"api-docs")),await C(e.options.typedoc,e.options.entries,n,e.logger),await e.hooks.callHook("typedoc:done",e)}},"builder");export{B as default};

package/dist/cli/commands/build.d.mts

@@ -2,9 +2,7 @@ import type { Cli } from "@visulima/cerebro";
 /**
  * Creates and registers the build command with the CLI.
  * Handles various build modes, environment variables, and build configurations.
- *
- * @param cli - CLI instance to register the command with
- *
+ * @param cli CLI instance to register the command with
  * @example
  * ```typescript
  * // Usage from command line:
@@ -17,7 +15,6 @@ import type { Cli } from "@visulima/cerebro";
  * // With custom environment variables:
  * // packem build --env.API_URL=http://api.example.com
  * ```
- *
  * @internal
  */
 declare const createBuildCommand: (cli: Cli) => void;