sonda 0.8.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.9.0
+
+### Minor Changes
+
+- 87d59f9: Add `include` and `exclude` options
+
+## 0.8.2
+
+### Patch Changes
+
+- 3ec00ae: (Performance) Prevent duplicate resolution of some imports in Rollup
+- 9f34bbf: Add a search field to the Treemap view for filtering inputs
+- 1c14126: Log report path after generation
+- 5ae02e5: Fix edge case in Treemap where items fail to sort in descending order by size
+- 9d25830: Always show input code when available, even if CSS Custom Highlighting API is unsupported
+- b230643: Allow filtering inputs by "type" when inspecting asset in Treemap view
+- ab2f385: Reintroduce the `filename` configuration option
+
 ## 0.8.1
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # Sonda
 
-Sonda is a universal visualizer and analyzer for JavaScript and CSS bundles. It generates an interactive HTML report that is more accurate and detailed than some alternatives. The accuracy is achieved by analyzing source maps and showing the size of each module after tree-shaking and minification.
+Sonda is a universal bundle analyzer and visualizer. It generates an interactive HTML report that is more accurate and detailed than some alternatives. The accuracy is achieved by analyzing source maps and showing the size of each module after tree-shaking and minification.
 
 Sonda works with the following tools:
 

package/bin/sonda-angular.js

@@ -8,6 +8,7 @@ const { values } = parseArgs( {
     config: { type: 'string' },
     projects: { type: 'string', multiple: true },
     format: { type: 'string' },
+    filename: { type: 'string' },
     outputDir: { type: 'string' },
     'no-open': { type: 'boolean' },
     deep: { type: 'boolean' },

package/dist/entrypoints/angular.js

@@ -6,7 +6,7 @@ import { Config, processEsbuildMetafile } from "sonda";
 async function SondaAngular({ config = "angular.json", projects = [],...userOptions }) {
 	const options = new Config(userOptions, {
 		integration: "angular",
-		filename: "sonda_[project]"
+		filename: "sonda_[env]_[index]"
 	});
 	const angularConfig = loadJson(config);
 	const projectsToGenerate = projects.length ? projects : Object.keys(angularConfig.projects);
@@ -18,7 +18,7 @@ async function SondaAngular({ config = "angular.json", projects = [],...userOpti
 		paths.server = resolve(paths.base, paths.server || "server");
 		const metafile = updateMetafile(loadJson(resolve(paths.base, "stats.json")), paths.base);
 		const sondaOptions = options.clone();
-		sondaOptions.filename = sondaOptions.filename.replace("[project]", project);
+		sondaOptions.filename = sondaOptions.filename.replace("[env]", project);
 		sondaOptions.sourcesPathNormalizer = (path) => resolve(process.cwd(), path);
 		await processEsbuildMetafile(metafile, sondaOptions);
 	}

package/dist/entrypoints/astro.js

@@ -4,20 +4,23 @@ import { Config, SondaVitePlugin } from "sonda";
 function SondaAstroPlugin(userOptions = {}) {
 	const options = new Config(userOptions, {
 		integration: "astro",
-		filename: "sonda_[env]"
+		filename: "sonda_[env]_[index]"
 	});
 	if (!options.enabled) return {
-		name: "sonda-astro",
+		name: "sonda/astro",
 		hooks: {}
 	};
 	return {
-		name: "sonda-astro",
+		name: "sonda/astro",
 		hooks: { "astro:build:setup"({ vite, target }) {
 			if (target === "server" && !options.server) return;
 			const sondaOptions = options.clone();
 			sondaOptions.filename = sondaOptions.filename.replace("[env]", target);
 			vite.plugins ??= [];
-			vite.plugins.push(SondaVitePlugin(sondaOptions));
+			vite.plugins.push({
+				...SondaVitePlugin(sondaOptions),
+				name: "sonda/astro"
+			});
 		} }
 	};
 }

package/dist/entrypoints/next.js

@@ -5,7 +5,7 @@ function SondaNextPlugin(userOptions = {}) {
 	return function Sonda(nextConfig = {}) {
 		const options = new Config(userOptions, {
 			integration: "next",
-			filename: "sonda_[env]"
+			filename: "sonda_[env]_[index]"
 		});
 		if (!options.enabled) return nextConfig;
 		return Object.assign({}, nextConfig, { webpack(config, { nextRuntime, isServer }) {

package/dist/entrypoints/nuxt.js

@@ -5,7 +5,7 @@ function SondaNuxtPlugin(userOptions = {}) {
 	return function SondaNuxtPlugin$1(_, nuxt) {
 		const options = new Config(userOptions, {
 			integration: "nuxt",
-			filename: "sonda_[env]"
+			filename: "sonda_[env]_[index]"
 		});
 		if (!options.enabled) return;
 		nuxt.hook("vite:extendConfig", (config, { isClient, isServer }) => {
@@ -14,7 +14,10 @@ function SondaNuxtPlugin(userOptions = {}) {
 			const sondaOptions = options.clone();
 			sondaOptions.filename = sondaOptions.filename.replace("[env]", env);
 			config.plugins ??= [];
-			config.plugins.push(SondaVitePlugin(sondaOptions));
+			config.plugins.push({
+				...SondaVitePlugin(sondaOptions),
+				name: "sonda/nuxt"
+			});
 		});
 	};
 }

package/dist/entrypoints/rolldown.js

@@ -3,10 +3,10 @@ import { Config, SondaRollupPlugin } from "sonda";
 //#region src/entrypoints/rolldown.ts
 function RolldownPlugin(userOptions = {}) {
 	const options = new Config(userOptions, { integration: "rolldown" });
-	if (!options.enabled) return { name: "sonda-rolldown" };
+	if (!options.enabled) return { name: "sonda/rolldown" };
 	return {
 		...SondaRollupPlugin(options),
-		name: "sonda-rolldown"
+		name: "sonda/rolldown"
 	};
 }
 

package/dist/entrypoints/sveltekit.js

@@ -4,12 +4,12 @@ import { Config, SondaVitePlugin } from "sonda";
 function SondaSvelteKitPlugin(userOptions = {}) {
 	const options = new Config(userOptions, {
 		integration: "sveltekit",
-		filename: "sonda_[env]"
+		filename: "sonda_[env]_[index]"
 	});
-	if (!options.enabled) return { name: "sonda-sveltekit" };
+	if (!options.enabled) return { name: "sonda/sveltekit" };
 	return {
 		...SondaVitePlugin(options),
-		name: "sonda-sveltekit",
+		name: "sonda/sveltekit",
 		configResolved(config) {
 			const env = config.build.ssr ? "server" : "client";
 			const generateForServer = userOptions.server ?? false;

package/dist/index.d.ts

@@ -11,7 +11,10 @@ declare class Config implements Required<IntegrationOptions> {
   constructor(options: Partial<IntegrationOptions> | Config, defaults: IntegrationOptions);
   clone(): Config;
   get enabled(): boolean;
+  get include(): AssetFilter;
+  get exclude(): AssetFilter;
   get format(): Format;
+  get filename(): string;
   get outputDir(): string;
   get open(): boolean;
   get deep(): boolean;
@@ -20,7 +23,6 @@ declare class Config implements Required<IntegrationOptions> {
   get brotli(): boolean;
   get server(): boolean;
   get integration(): Integration;
-  get filename(): string;
   get sourcesPathNormalizer(): SourcesPathNormalizer;
   set filename(filename: string);
   set sourcesPathNormalizer(normalizer: SourcesPathNormalizer);
@@ -33,13 +35,60 @@ interface UserOptions {
   */
   enabled?: boolean;
   /**
-  * Specifies the output format of the report.
+  * Specifies a list of RegExp patterns used to match output assets to include in the report.
+  * By default, all assets are included.
+  *
+  * Patterns are matched against the relative asset paths as displayed in the report. For example,
+  * to include only JavaScript files, use `[ /\.js$/ ]`.
+  *
+  * @default null
+  */
+  include?: AssetFilter;
+  /**
+  * Specifies a list of RegExp patterns used to match output assets to exclude from the report.
+  * By default, no assets are excluded, except for those with `.map` and `.d.ts` extensions, which
+  * are always excluded regardless of this setting.
+  *
+  * This option takes precedence over `include`.
+  *
+  * Patterns are matched against the relative asset paths as shown in the report. For example, to exclude all CSS files, use `[ /\.css$/ ]`.
+  *
+  * @default null
+  */
+  exclude?: AssetFilter;
+  /**
+  * Specifies the output format of the report. Supported formats include:
+  *
+  * - `'html'` - An HTML file with a treemap visualization.
+  * - `'json'` - A JSON file.
   *
   * @default 'html'
   */
   format?: Format;
   /**
-  * Specifies the name of the directory where the report will be saved.
+  * Specifies the filename of the generated report. If this value is an absolute path,
+  * it overrides the `outputDir` option.
+  *
+  * The default value includes placeholders like `[index]` and `[env]`, which are replaced
+  * during report generation.
+  *
+  * The `[index]` placeholder is replaced with a version number that increments each time
+  * a new report is generated. This allows you to keep multiple revisions of the report without
+  * overwriting previous ones. If you want to generate only a single report and always overwrite
+  * the previous one, you can set this option to a static value, such as `'sonda'`.
+  *
+  * Additionally, framework integrations that can generate reports for both the client and server
+  * (with the `server` option) will include the `[env]` placeholder in the filename. This is replaced with
+  * the environment name (e.g., `client`, `server`), allowing you to distinguish between client and server reports.
+  *
+  * @default `'sonda_[index]'` for bundler integrations and `'sonda_[env]_[index]'` for framework integrations.
+  */
+  filename?: string;
+  /**
+  * Specifies the directory where the report will be saved. This can be a relative or absolute path. By default,
+  * the report is saved in a `.sonda` directory relative to the current working directory.
+  *
+  * The directory is created if it does not exist.
   *
   * @default '.sonda'
   */
@@ -53,47 +102,47 @@ interface UserOptions {
   */
   open?: boolean;
   /**
-  * Specifies whether to read the source maps of imported modules.
+  * Specifies whether to read source maps of imported modules.
   *
-  * By default, external dependencies bundled into a single file appear as a single
-  * asset in the report. When this option is enabled, the report includes the source
-  * files of imported modules, if source maps are available.
+  * By default, external dependencies bundled into a single file appear as a single asset. When this option
+  * is enabled, the report includes the source files of imported modules, if their source maps are available.
   *
-  * Enabling this option may increase the time needed to generate the report and reduce
-  * the accuracy of estimated GZIP and Brotli sizes for individual files.
+  * Enabling this option may increase report generation time and reduce the accuracy of estimated GZIP
+  * and Brotli sizes.
   *
   * @default false
   */
   deep?: boolean;
   /**
-  * Specifies whether to include source maps of the assets in the report to visualize
-  * which parts of the code contribute to the final asset size.
+  * Specifies whether to include source maps of generated assets in the report to visualize which parts of
+  * the code contribute to the final asset size.
   *
-  * ⚠️ This option significantly increases the size of the report and embeds the
-  * **source code** of the assets. If you are working with proprietary code, ensure
-  * you share the report responsibly. ⚠️
+  * ⚠️
+  * This option significantly increases the report size and embeds the **source code** of the assets.
+  * If you are working with proprietary code, ensure you share the report responsibly.
+  * ⚠️
   *
   * @default false
   */
   sources?: boolean;
   /**
-  * Specifies whether to calculate the sizes of assets after compression with GZIP.
+  * Specifies whether to calculate asset sizes after compression with GZIP.
   *
-  * The report includes estimated compressed sizes for each file within an asset.
-  * However, these estimates are approximate and should be used as a general reference.
+  * The report also includes estimated compressed sizes for each file within an asset. These estimates are
+  * approximate and intended for general reference.
   *
-  * Enabling this option may increase the time required to generate the report.
+  * Enabling this option may increase report generation time.
   *
   * @default false
   */
   gzip?: boolean;
   /**
-  * Specifies whether to calculate the sizes of assets after compression with Brotli.
+  * Specifies whether to calculate asset sizes after compression with Brotli.
   *
-  * The report includes estimated compressed sizes for each file within an asset.
-  * However, these estimates are approximate and should be used as a general reference.
+  * The report also includes estimated compressed sizes for each file within an asset. These estimates are
+  * approximate and intended for general reference.
   *
-  * Enabling this option may increase the time required to generate the report.
+  * Enabling this option may increase report generation time.
   *
   * @default false
   */
@@ -101,7 +150,7 @@ interface UserOptions {
   /**
   * Specifies whether to generate a report for the server build.
   *
-  * This option is only available for meta-framework integrations.
+  * This option is only available for framework integrations.
   *
   * @default false
   */
@@ -113,18 +162,16 @@ interface IntegrationOptions extends UserOptions {
   */
   integration: Integration;
   /**
-  * Specifies the name of the file where the report will be saved.
-  *
-  * @default 'sonda'
-  */
-  filename?: string;
-  /**
   * Normalizes the paths in source maps to a consistent format.
   *
   * @default null
   */
   sourcesPathNormalizer?: SourcesPathNormalizer;
 }
+/**
+* Filter for including or excluding assets based on their paths.
+*/
+type AssetFilter = Array<RegExp> | null;
 type Format = "html" | "json";
 type Integration = "angular" | "astro" | "esbuild" | "next" | "nuxt" | "rolldown" | "rollup" | "rspack" | "sveltekit" | "vite" | "webpack" | "unknown";
 //#endregion
@@ -412,7 +459,7 @@ declare class Report {
   addResource(resource: Resource): void;
   addConnection(connection: Connection): void;
   addAsset(name: string, entrypoints?: Array<string>): void;
-  generate(): Promise<void>;
+  generate(): Promise<string>;
   addSourceMap(asset: string, sourcemap: DecodedReportSourceMap): void;
 }
 //#endregion