@savvy-web/rslib-builder 0.1.1 → 0.1.2

package/index.d.ts

@@ -12,7 +12,7 @@
  * - **Package.json Transformation**: Automatic path updates, PNPM catalog resolution
  * - **TypeScript Declaration Bundling**: Using tsgo and API Extractor
  * - **File Array Generation**: Automatic files array creation for package.json
- * - **API Model Generation**: Optional api.model.json for documentation tooling
+ * - **API Model Generation**: Optional `<packageName>.api.json` for documentation tooling
  *
  * @example
  * Basic usage in rslib.config.ts:
@@ -48,7 +48,7 @@ import type { SourceConfig } from '@rsbuild/core';
 
 /**
  * Options for API model generation.
- * When enabled, generates an api.model.json file using API Extractor.
+ * When enabled, generates an `<unscopedPackageName>.api.json` file using API Extractor.
  *
  * @remarks
  * API models are only generated for the main "index" entry point (the "." export).
@@ -66,15 +66,9 @@ export declare interface ApiModelOptions {
     enabled?: boolean;
     /**
      * Filename for the generated API model file.
-     * @defaultValue "api.model.json"
+     * @defaultValue `<unscopedPackageName>.api.json` (e.g., `rslib-builder.api.json`)
      */
     filename?: string;
-    /**
-     * Whether to add a .npmignore file that excludes the API model file.
-     * This is useful when the API model is for internal tooling only.
-     * @defaultValue true
-     */
-    npmIgnore?: boolean;
     /**
      * Local paths to copy the API model and package.json to.
      * Used for local testing with documentation systems.
@@ -82,7 +76,10 @@ export declare interface ApiModelOptions {
      * @remarks
      * Each path must be a directory. The parent directory must exist,
      * but the final directory will be created if it doesn't exist.
-     * Both api.model.json and the processed package.json will be copied.
+     * Both the API model and the processed package.json will be copied.
+     *
+     * The API model file is emitted to dist but excluded from npm publish
+     * (added as negated pattern `!<filename>` in the `files` array).
      *
      * @example
      * ```typescript
@@ -229,8 +226,10 @@ export declare interface DtsPluginOptions {
     buildTarget?: "dev" | "npm";
     /**
      * Options for API model generation.
-     * When enabled, generates an api.model.json file in the dist directory.
+     * When enabled, generates an `<unscopedPackageName>.api.json` file in the dist directory.
      * Only applies when bundle is true.
+     *
+     * The API model is excluded from npm publish (not added to `files` array).
      */
     apiModel?: ApiModelOptions | boolean;
 }
@@ -414,6 +413,14 @@ export declare function generateTsgoArgs(options: {
  */
 export declare function getTsgoBinPath(): string;
 
+/**
+ * Extracts the unscoped package name from a potentially scoped package name.
+ * @param name - The package name (e.g., `@scope/package` or `package`)
+ * @returns The unscoped name (e.g., `package`)
+ * @internal
+ */
+export declare function getUnscopedPackageName(name: string): string;
+
 /**
  * @public
  * Node library builder class
@@ -564,13 +571,13 @@ export declare interface NodeLibraryBuilderOptions {
     transform?: TransformPackageJsonFn;
     /**
      * Options for API model generation.
-     * When enabled, generates an api.model.json file in the dist directory.
+     * When enabled, generates an `<unscopedPackageName>.api.json` file in the dist directory.
      * Only applies when target is "npm".
      *
      * @remarks
-     * The generated api.model.json file contains the full API documentation
+     * The generated API model file contains the full API documentation
      * in a machine-readable format for use by documentation generators.
-     * A .npmignore file is also generated to exclude the API model from npm publish.
+     * The file is emitted to dist but excluded from npm publish (added as negated pattern in `files` array).
      *
      * @example
      * ```typescript

package/index.js

@@ -394,6 +394,9 @@ const TSConfigs = {
         }
     }
 };
+function getUnscopedPackageName(name) {
+    return name.startsWith("@") ? name.split("/")[1] ?? name : name;
+}
 function getTsgoBinPath() {
     const cwd = process.cwd();
     const localTsgoBin = (0, external_node_path_.join)(cwd, "node_modules", ".bin", "tsgo");
@@ -446,7 +449,7 @@ async function bundleDtsFiles(options) {
     const bundledFiles = new Map();
     let apiModelPath;
     const apiModelEnabled = true === apiModel || "object" == typeof apiModel && (void 0 === apiModel.enabled || true === apiModel.enabled);
-    const apiModelFilename = "object" == typeof apiModel && apiModel.filename ? apiModel.filename : "api.model.json";
+    const apiModelFilename = "object" == typeof apiModel && apiModel.filename ? apiModel.filename : "api.json";
     getApiExtractorPath();
     const { Extractor, ExtractorConfig } = await import("@microsoft/api-extractor");
     for (const [entryName, sourcePath] of entryPoints){
@@ -742,20 +745,13 @@ function runTsgo(options) {
                             }
                             core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted ${emittedCount} bundled declaration file${1 === emittedCount ? "" : "s"} through asset pipeline`);
                             if (apiModelPath) {
-                                const apiModelFilename = "object" == typeof options.apiModel && options.apiModel.filename ? options.apiModel.filename : "api.model.json";
+                                const defaultApiModelFilename = packageJson.name ? `${getUnscopedPackageName(packageJson.name)}.api.json` : "api.json";
+                                const apiModelFilename = "object" == typeof options.apiModel && options.apiModel.filename ? options.apiModel.filename : defaultApiModelFilename;
                                 const apiModelContent = await promises_readFile(apiModelPath, "utf-8");
                                 const apiModelSource = new context.sources.OriginalSource(apiModelContent, apiModelFilename);
                                 context.compilation.emitAsset(apiModelFilename, apiModelSource);
-                                if (filesArray) filesArray.add(apiModelFilename);
-                                core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted API model: ${apiModelFilename}`);
-                                const shouldAddNpmIgnore = true === options.apiModel || "object" == typeof options.apiModel && false !== options.apiModel.npmIgnore;
-                                if (shouldAddNpmIgnore) {
-                                    const npmIgnoreContent = `# Exclude API model from npm publish (used by internal tooling)\n${apiModelFilename}\n`;
-                                    const npmIgnoreSource = new context.sources.OriginalSource(npmIgnoreContent, ".npmignore");
-                                    context.compilation.emitAsset(".npmignore", npmIgnoreSource);
-                                    if (filesArray) filesArray.add(".npmignore");
-                                    core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted .npmignore to exclude ${apiModelFilename}`);
-                                }
+                                if (filesArray) filesArray.add(`!${apiModelFilename}`);
+                                core_logger.info(`${picocolors.dim(`[${envId}]`)} Emitted API model: ${apiModelFilename} (excluded from npm publish)`);
                                 const isCI = "true" === process.env.GITHUB_ACTIONS || "true" === process.env.CI;
                                 const localPaths = "object" == typeof options.apiModel ? options.apiModel.localPaths : void 0;
                                 if (localPaths && localPaths.length > 0 && !isCI) for (const localPath of localPaths){
@@ -1518,4 +1514,4 @@ const PackageJsonTransformPlugin = (options = {})=>{
         });
     }
 }
-export { AutoEntryPlugin, DtsPlugin, EntryExtractor, FilesArrayPlugin, NodeLibraryBuilder, PackageJsonTransformPlugin, PackageJsonTransformer, PnpmCatalog, collectDtsFiles, ensureTempDeclarationDir, findTsConfig, generateTsgoArgs, getTsgoBinPath, stripSourceMapComment };
+export { AutoEntryPlugin, DtsPlugin, EntryExtractor, FilesArrayPlugin, NodeLibraryBuilder, PackageJsonTransformPlugin, PackageJsonTransformer, PnpmCatalog, collectDtsFiles, ensureTempDeclarationDir, findTsConfig, generateTsgoArgs, getTsgoBinPath, getUnscopedPackageName, stripSourceMapComment };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/rslib-builder",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"private": false,
 	"description": "RSlib-based build system for Node.js libraries with automatic package.json transformation, TypeScript declaration bundling, and multi-target support",
 	"homepage": "https://github.com/savvy-web/rslib-builder",
@@ -72,10 +72,9 @@
 		]
 	},
 	"files": [
-		".npmignore",
+		"!rslib-builder.api.json",
 		"LICENSE",
 		"README.md",
-		"api.model.json",
 		"index.d.ts",
 		"index.js",
 		"package.json",

package/.npmignore

@@ -1,2 +0,0 @@
-# Exclude API model from npm publish (used by internal tooling)
-api.model.json