@reliverse/dler 1.7.16 → 1.7.18

package/bin/libs/sdk/sdk-impl/config/types.d.ts

@@ -0,0 +1,533 @@
+/**
+ * Defines the configuration for building and publishing packages. This includes: versioning,
+ * build settings, publishing options, libraries-dler-plugin built-in plugin, and more.
+ * It customizes the build and publish pipeline for both NPM and JSR registries.
+ */
+export interface DlerConfig {
+    /**
+     * When `true`, disables version bumping.
+     * Useful when retrying a failed publish with an already bumped version.
+     *
+     * @default false
+     */
+    bumpDisable: boolean;
+    /**
+     * Controls which files will have their version numbers updated during version bumping.
+     *
+     * Accepts:
+     * - Standard file types like "package.json"
+     * - Relative paths like "src/constants.ts"
+     * - [Globbing patterns](https://github.com/mrmlnc/fast-glob#pattern-syntax)
+     *
+     * When empty, falls back to only updating "package.json".
+     * Respects: .gitignore patterns, hidden files, .git & node_modules.
+     *
+     * @default ["package.json", ".config/rse.ts"]
+     */
+    bumpFilter: string[];
+    /**
+     * Specifies how the version number should be incremented:
+     * - `patch`: Increments the patch version for backwards-compatible bug fixes (1.2.3 → 1.2.4)
+     * - `minor`: Increments the minor version for new backwards-compatible features (1.2.3 → 1.3.0)
+     * - `major`: Increments the major version for breaking changes (1.2.3 → 2.0.0)
+     * - `auto`: Automatically determine the appropriate bump type
+     * - `manual`: Set a specific version (requires bumpSet to be set)
+     *
+     * Please note: `dler` infers the version from the `package.json` file.
+     *
+     * @default "patch"
+     */
+    bumpMode: BumpMode;
+    /**
+     * Custom version to set when bumpMode is "manual".
+     * Must be a valid semver version (e.g., "1.2.3").
+     *
+     * @default ""
+     */
+    bumpSet: string;
+    /**
+     * When `true`, stops after building and retains distribution folders.
+     * Useful for development or inspecting the build output.
+     *
+     * @default true
+     */
+    commonPubPause: boolean;
+    /**
+     * Specifies which package registries to publish to:
+     * - `npm`: Publish only to the NPM commonPubRegistry.
+     * - `jsr`: Publish only to the JSR commonPubRegistry.
+     * - `npm-jsr`: Publish to both NPM and JSR registries.
+     *
+     * @default "npm"
+     */
+    commonPubRegistry: "jsr" | "npm" | "npm-jsr";
+    /**
+     * When `true`, enables detailed logs during the build and publish process.
+     * Useful for debugging or understanding the build flow.
+     *
+     * @default false
+     */
+    commonVerbose: boolean;
+    /**
+     * When `true`, generates TypeScript declaration files (.d.ts) for NPM packages.
+     * Essential for providing type intranspileFormation to TypeScript users.
+     *
+     * To reduce bundle size you can set this to `false` if your main project
+     * is planned to be used only as a global CLI tool (e.g. `bunx dler`).
+     *
+     * @default true
+     */
+    coreDeclarations: boolean;
+    /**
+     * Path to the project's main entry file.
+     * Used as the entry point for the NPM package.
+     *
+     * @default "mod.ts"
+     */
+    coreEntryFile: string;
+    /**
+     * Base directory containing the source entry files.
+     * All paths are resolved relative to this directory.
+     * Set to `"."` if entry files are in the project root.
+     *
+     * @default "src"
+     */
+    coreEntrySrcDir: string;
+    /**
+     * Directory where built files will be placed within the distribution directory.
+     * For example, if set to "bin", CLI scripts will be placed in "dist-npm/bin" or "dist-jsr/bin".
+     *
+     * @default "bin"
+     */
+    coreBuildOutDir: string;
+    /**
+     * Configuration for CLI functionality:
+     * - enabled: When `true`, indicates that the package has CLI capabilities
+     * - scripts: Map of CLI script names to their entry file paths
+     *   The key will be used as the command name in package.json's bin field
+     *   The value should be the path to the executable script (e.g. "cli.ts")
+     *
+     * **The source scripts should be in your "coreEntrySrcDir" directory (by default "src")**
+     *
+     * @example
+     * {
+     *   enabled: true,
+     *   scripts: {
+     *     "mycli": "cli.ts",
+     *     "othercmd": "other-cmd.ts"
+     *   }
+     * }
+     *
+     * @default { enabled: false, scripts: {} }
+     */
+    coreIsCLI: {
+        enabled: boolean;
+        scripts: Record<string, string>;
+    };
+    /**
+     * Optional description that overrides the description from package.json.
+     * When provided, this description will be used in the dist's package.json.
+     * If not provided, the description from the original package.json will be used.
+     *
+     * @default `package.json`'s "description"
+     */
+    coreDescription: string;
+    /**
+     * When `true`, allows JSR publishing even with uncommitted changes.
+     * Use with caution, as it may lead to inconsistent published versions.
+     *
+     * It is `true` by default to make it easier for new `dler` users to publish their projects.
+     *
+     * @default true
+     */
+    distJsrAllowDirty: boolean;
+    /**
+     * The bundler to use for creating JSR-compatible packages.
+     * JSR's native bundler is recommended for best compatibility.
+     *
+     * @default "jsr"
+     */
+    distJsrBuilder: BundlerName;
+    /**
+     * Directory where JSR build artifacts are generated.
+     * This directory will contain the package ready for JSR publishing.
+     *
+     * @default "dist-jsr"
+     */
+    distJsrDirName: string;
+    /**
+     * When `true`, simulates the publishing process without actually publishing.
+     * Useful for testing the build and publish pipeline without side effects.
+     *
+     * @default false
+     */
+    distJsrDryRun: boolean;
+    /**
+     * When `true`, fails the build if warnings are detected.
+     * Use with caution, as it may lead to inconsistent published versions.
+     *
+     * @default false
+     */
+    distJsrFailOnWarn: boolean;
+    /**
+     * When `true`, generates a `jsconfig.json` file for JSR's dist.
+     *
+     * @default false
+     */
+    distJsrGenTsconfig: boolean;
+    /**
+     * The file extension for output files in JSR packages.
+     *
+     * @default "ts"
+     */
+    distJsrOutFilesExt: NpmOutExt;
+    /**
+     * When `true`, enables JSR to process complex types, which may impact performance.
+     * Enable this only if you cannot simplify or explicitly define exported types.
+     *
+     * JSR requires exported functions, classes, variables, and type aliases to have
+     * explicitly written or easily inferred types. Otherwise, it may be unable to
+     * generate documentation, type declarations for npm compatibility, or efficient
+     * type checking for consumers.
+     *
+     * If "slow types" are present, type checking performance may degrade, and some
+     * features may not work as expected.
+     *
+     * It is `true` by default to make it easier for new `dler` users to publish their projects.
+     *
+     * @see https://jsr.io/docs/about-slow-types
+     * @default true
+     */
+    distJsrSlowTypes: boolean;
+    /**
+     * The bundler to use for creating NPM-compatible packages.
+     *
+     * @default "mkdist"
+     */
+    distNpmBuilder: BundlerName;
+    /**
+     * Directory where NPM build artifacts are generated.
+     * This directory will contain the package ready for NPM publishing.
+     *
+     * @default "dist-npm"
+     */
+    distNpmDirName: string;
+    /**
+     * Specifies the file extension for output files in NPM packages.
+     * Determines the extension of compiled files in the NPM distribution.
+     * We strongly recommend using `"js"` with the `"esm"` transpileFormat.
+     *
+     * @default "js"
+     */
+    distNpmOutFilesExt: NpmOutExt;
+    /**
+     * !! EXPERIMENTAL !!
+     * Controls which parts of the project are built and published:
+     * - `main-project-only`: Builds/publishes only the main package.
+     * - `main-and-libs`: Builds/publishes both the main package and libraries.
+     * - `libs-only`: Builds/publishes only the libraries.
+     *
+     * @default "main-project-only"
+     */
+    libsActMode: "libs-only" | "main-and-libs" | "main-project-only";
+    /**
+     * The directory where built libraries are stored before publishing.
+     *
+     * @default "dist-libs"
+     */
+    libsDirDist: string;
+    /**
+     * The directory containing library source files.
+     *
+     * @default "src/libs"
+     */
+    libsDirSrc: string;
+    /**
+     * !! EXPERIMENTAL !!
+     * Configuration for building and publishing multiple libraries.
+     * Each key represents a package name, and its value contains the configuration.
+     *
+     * @example
+     * {
+     *   "@myorg/ml1": { main: "my-lib-1/mod.ts" },
+     *   "@myorg/ml2": { main: "my-lib-2/ml2-mod.ts" },
+     *   "@myorg/ml3": { main: "src/libs/my-lib-3/index.js" }
+     * }
+     */
+    libsList: Record<string, LibConfig>;
+    /**
+     * The name of the log file. dler uses `@reliverse/relinka` for logging.
+     *
+     * @default ".logs/relinka.log"
+     */
+    logsFileName: string;
+    /**
+     * When `true`, cleans up the log file from previous runs.
+     *
+     * @default false
+     */
+    logsFreshFile: boolean;
+    /**
+     * Configuration for dependency removal/injection patterns.
+     * Controls which dependencies are excluded from (or injected into) the final package.
+     *
+     * Pattern types:
+     * - Regular patterns: Exclude deps that match the pattern
+     * - Negation patterns (starting with !): Don't exclude deps that match the pattern
+     * - Add patterns (starting with +): Inject deps into specific dists even if original package.json doesn't have them
+     *
+     * Structure (dist-specific patterns are merged with global):
+     * - `global`: Patterns that are always applied to all builds
+     * - `dist-npm`: NPM-specific patterns
+     * - `dist-jsr`: JSR-specific patterns
+     * - `dist-libs`: Library-specific patterns
+     *   Each library can have separate NPM and JSR patterns
+     *
+     * @example
+     * {
+     *   global: ["@types", "eslint"],
+     *   "dist-npm": ["npm-specific"],
+     *   "dist-jsr": ["+bun"], // Explicitly include 'bun' in JSR builds
+     *   "dist-libs": {
+     *     "@myorg/lib1": {
+     *       npm: ["lib1-npm-specific"],
+     *       jsr: ["+bun"] // Explicitly include 'bun' in this lib's JSR build
+     *     }
+     *   }
+     * }
+     */
+    filterDepsPatterns: {
+        global: string[];
+        "dist-npm": string[];
+        "dist-jsr": string[];
+        "dist-libs": Record<string, {
+            npm: string[];
+            jsr: string[];
+        }>;
+    };
+    /**
+     * When `true`, fails the build if warnings are detected.
+     * Use with caution, as it may lead to inconsistent published versions.
+     *
+     * @default false
+     */
+    transpileFailOnWarn: boolean;
+    /**
+     * The transpileTarget runtime environment for the built package.
+     *
+     * @default "es2023"
+     */
+    transpileEsbuild: Esbuild;
+    /**
+     * Output module transpileFormat for built files:
+     * - `esm`: ECMAScript modules (import/export)
+     * - `cjs`: CommonJS modules (require/exports)
+     * - `iife`: Immediately Invoked Function Expression (for browsers)
+     *
+     * @default "esm"
+     */
+    transpileFormat: transpileFormat;
+    /**
+     * When `true`, minifies the output to reduce bundle size.
+     * Recommended for production builds but may increase build time.
+     *
+     * @default true
+     */
+    transpileMinify: boolean;
+    /**
+     * The base URL for loading assets in the built package.
+     * Important for packages that include assets like images or fonts.
+     *
+     * @default "/"
+     */
+    transpilePublicPath: string;
+    /**
+     * Controls source map generation for debugging (experimental):
+     * - `true/false`: Enable/disable source maps.
+     * - `"inline"`: Include source maps within output files.
+     * - `"none"`: Do not generate source maps.
+     * - `"linked"`: Generate separate source map files with links.
+     * - `"external"`: Generate separate source map files.
+     *
+     * @default false
+     */
+    transpileSourcemap: Sourcemap;
+    /**
+     * When `true`, enables code transpileSplitting for improved load-time performance.
+     * Useful for large applications but may not be needed for small projects.
+     *
+     * @default false
+     */
+    transpileSplitting: boolean;
+    /**
+     * Stub the package for JIT compilation.
+     *
+     * @default false
+     */
+    transpileStub: boolean;
+    /**
+     * Defines the transpileTarget runtime environment:
+     * - `node`: Optimized for Node.js.
+     * - `bun`: Optimized for Bun.
+     * - `browser`: Optimized for web browsers.
+     *
+     * @default "node"
+     */
+    transpileTarget: transpileTarget;
+    /**
+     * Watch the src dir and rebuild on change (experimental).
+     *
+     * @default false
+     */
+    transpileWatch: boolean;
+    /**
+     * Specifies what resources to send to npm and jsr registries.
+     * coreBuildOutDir (e.g. "bin") dir is automatically included.
+     * The following is also included if publishArtifacts is {}:
+     * - global: ["package.json", "README.md", "LICENSE"]
+     * - dist-jsr,dist-libs/jsr: ["jsr.json"]
+     *
+     * Structure:
+     * - `global`: Files to include in all distributions
+     * - `dist-jsr`: Files specific to JSR distribution
+     * - `dist-npm`: Files specific to NPM distribution
+     * - `dist-libs`: Library-specific files for each distribution type
+     *
+     * Useful for including additional files like configuration or documentation.
+     * Pro tip: set jsr.jsonc to generate jsr.jsonc instead of jsr.json config.
+     *
+     * @default
+     * {
+     *   global: ["bin", "package.json", "README.md", "LICENSE"],
+     *   "dist-jsr": ["jsr.json"],
+     *   "dist-npm": [],
+     *   "dist-libs": {
+     *     "@myorg/lib1": {
+     *       jsr: ["jsr.json"],
+     *       npm: []
+     *     }
+     *   }
+     * }
+     */
+    publishArtifacts?: {
+        global: string[];
+        "dist-jsr": string[];
+        "dist-npm": string[];
+        "dist-libs": Record<string, {
+            jsr: string[];
+            npm: string[];
+        }>;
+    };
+}
+export type BumpMode = "patch" | "minor" | "major" | "auto" | "manual";
+/**
+ * Supported bundler names for building packages:
+ * - bun: Bun's built-in bundler for fast builds
+ * - copy: A simple file copy without bundling
+ * - jsr: Similar to copy but optimized for the JSR commonPubRegistry
+ * - mkdist: A lightweight bundler focused on TypeScript/ESM
+ * - rollup: A traditional bundler with an extensive plugin ecosystem
+ * - untyped: Types and markdown generation from a config object
+ */
+export type BundlerName = "bun" | "copy" | "jsr" | "mkdist" | "rollup" | "untyped";
+export type NpmOutExt = "cjs" | "cts" | "js" | "mjs" | "mts" | "ts";
+/**
+ * Configuration for a library to be built and published as a separate package.
+ * Used when publishing multiple packages from a single repository.
+ */
+export interface LibConfig {
+    /**
+     * When `true`, generates TypeScript declaration files (.d.ts) for NPM packages.
+     */
+    libDeclarations: boolean;
+    /**
+     * An optional description of the library, included in the dist's package.json.
+     * Provides users with an overview of the library's purpose.
+     *
+     * @example "Utility functions for data manipulation"
+     * @example "Core configuration module for the framework"
+     *
+     * @default `package.json`'s "description"
+     */
+    libDescription: string;
+    /**
+     * The directory where the library's dist files are stored.
+     *
+     * @default name is derived from the library's name after slash
+     */
+    libDirName: string;
+    /**
+     * The path to the library's main entry file.
+     * This file serves as the primary entry point for imports.
+     * The path should be relative to the project root.
+     * The full path to the library's main file is derived by joining `libsDirDist` with `main`.
+     *
+     * @example "my-lib-1/mod.ts"
+     * @example "my-lib-2/ml2-mod.ts"
+     * @example "src/libs/my-lib-3/index.js"
+     */
+    libMainFile: string;
+    /**
+     * Dependencies to include in the dist's package.json.
+     * The final output may vary based on `filterDepsPatterns`.
+     * Defines how dependencies are handled during publishing:
+     * - `string[]`: Includes only the specified dependencies.
+     * - `true`: Includes all dependencies from the main package.json.
+     * - `false` or `undefined`: Automatically determines dependencies based on imports.
+     *
+     * @example ["@reliverse/pathkit", "@reliverse/relifso"] - Only will include these specific dependencies.
+     * @example true - Include all `dependencies` from the main package.json.
+     */
+    libPkgKeepDeps: boolean | string[];
+    /**
+     * When `true`, minifies the output to reduce bundle size.
+     * Recommended for production builds but may increase build time.
+     *
+     * @default true
+     */
+    libTranspileMinify: boolean;
+    /**
+     * When true, pauses publishing for this specific library (overridden by commonPubPause).
+     * If true, this library will be built but not published, even if other libs are published.
+     *
+     * @default false
+     */
+    libPubPause?: boolean;
+    /**
+     * The registry to publish the library to.
+     *
+     * @default "npm"
+     */
+    libPubRegistry?: "jsr" | "npm" | "npm-jsr";
+    /**
+     * Optional version override for the library.
+     * If not provided, falls back to the version from the main package.json.
+     *
+     * @default `package.json`'s "version"
+     */
+    version?: string;
+}
+export type Esbuild = "es2019" | "es2020" | "es2021" | "es2022" | "es2023";
+/**
+ * Supported output module transpileFormats for built packages.
+ * - esm: ECMAScript modules (import/export)
+ * - cjs: CommonJS modules (require/exports)
+ * - iife: Immediately Invoked Function Expression (for browsers)
+ */
+export type transpileFormat = "cjs" | "esm" | "iife";
+/**
+ * Supported source map options for built packages.
+ * - boolean: Enable/disable source maps.
+ * - "inline": Include source maps within output files.
+ * - "none": Do not generate source maps.
+ * - "linked": Generate separate source map files with links.
+ * - "external": Generate separate source map files.
+ */
+export type Sourcemap = "external" | "inline" | "linked" | "none" | boolean;
+/**
+ * Supported transpileTarget runtime environments for built packages.
+ * - node: Optimized for Node.js.
+ * - bun: Optimized for Bun.
+ * - browser: Optimized for web browsers.
+ */
+export type transpileTarget = "browser" | "bun" | "node";

package/bin/libs/sdk/sdk-impl/library-flow.d.ts

@@ -1,4 +1,5 @@
-import type { BundlerName, Esbuild, LibConfig, NpmOutExt, Sourcemap, transpileFormat, transpileTarget, DlerConfig, PerfTimer } from "../sdk-types.js";
+import type { BundlerName, Esbuild, LibConfig, NpmOutExt, Sourcemap, transpileFormat, transpileTarget, DlerConfig } from "./config/types.js";
+import { type PerfTimer } from "../sdk-mod.js";
 /**
  * Processes libraries based on build mode.
  */

package/bin/libs/sdk/sdk-impl/regular-flow.d.ts

@@ -1,4 +1,5 @@
-import type { DlerConfig, PerfTimer } from "../sdk-types.js";
+import type { DlerConfig } from "./config/types.js";
+import type { PerfTimer } from "../sdk-types.js";
 /**
  * Processes the main project based on build mode and commonPubRegistry.
  */

package/bin/libs/sdk/sdk-impl/rules/reliverse/dler-config-health/dler-config-health.js

@@ -1,9 +1,9 @@
-import { loadConfig } from "../../../cfg/load.js";
+import { getConfigDler } from "../../../config/load.js";
 export async function checkDlerConfigHealth() {
   const startTime = Date.now();
   const issues = [];
   try {
-    const config = await loadConfig();
+    const config = await getConfigDler();
     const libsList = config.libsList || {};
     for (const [, libConfig] of Object.entries(libsList)) {
       const typedConfig = libConfig;

package/bin/libs/sdk/sdk-impl/rules/reliverse/missing-deps/deps-types.d.ts

@@ -1,12 +1,12 @@
 export type FileType = ".js" | ".jsx" | ".ts" | ".tsx";
-export type PackageJson = {
+export interface PackageJson {
     name?: string;
     dependencies?: Record<string, string>;
     devDependencies?: Record<string, string>;
     peerDependencies?: Record<string, string>;
     optionalDependencies?: Record<string, string>;
-};
-export type FinderOptions = {
+}
+export interface FinderOptions {
     directory: string;
     showAll: boolean;
     ignorePatterns: string[];
@@ -17,12 +17,12 @@ export type FinderOptions = {
     optional: boolean;
     fix: boolean;
     depth: number;
-};
-export type DependencyResult = {
+}
+export interface DependencyResult {
     missingDependencies: string[];
     allDependencies: string[];
     listedDependencies: string[];
     builtinModules: string[];
     devOnlyDependencies: string[];
     duplicateDependencies: string[];
-};
+}

package/bin/libs/sdk/sdk-impl/rules/reliverse/missing-deps/filesystem.js

@@ -1,5 +1,5 @@
+import path from "@reliverse/pathkit";
 import fs from "@reliverse/relifso";
-import path from "node:path";
 import { glob } from "tinyglobby";
 export const findSourceFiles = async (directory, ignorePatterns) => {
   const pattern = `${directory}/**/*.{js,jsx,ts,tsx}`;

package/bin/libs/sdk/sdk-impl/rules/reliverse/no-index-files/no-index-files.js

@@ -1,4 +1,4 @@
-import path from "node:path";
+import path from "@reliverse/pathkit";
 import { glob } from "tinyglobby";
 export async function checkNoIndexFiles(options) {
   const { directory } = options;

package/bin/libs/sdk/sdk-impl/rules/reliverse/self-include/self-include.js

@@ -1,7 +1,7 @@
 import { getFileImportsExports, extname } from "@reliverse/pathkit";
 import fs from "@reliverse/relifso";
 import { relinka } from "@reliverse/relinka";
-import { loadConfig } from "../../../cfg/load.js";
+import { getConfigDler } from "../../../config/load.js";
 import { getAllFiles, getLineNumber } from "../../rules-utils.js";
 export async function checkSelfInclude(options) {
   const startTime = Date.now();
@@ -11,7 +11,7 @@ export async function checkSelfInclude(options) {
   try {
     const packageJson = JSON.parse(await fs.readFile("package.json", "utf8"));
     const packageName = packageJson.name;
-    const config = await loadConfig();
+    const config = await getConfigDler();
     const libsList = config.libsList || {};
     let forbiddenImports = [];
     if (dirPath === "dist-npm" || dirPath === "dist-jsr" || dirPath === "src") {

package/bin/libs/sdk/sdk-impl/spell/applyMagicSpells.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Spell runner – walks a directory tree, finds
+ * magic-comment directives and executes them.
+ *
+ * Usage example:
+ *   await applyMagicSpells(["dist-jsr"]);
+ *   await applyMagicSpells(["dist-libs/sdk"]);
+ *   await applyMagicSpells(["dist-npm", "dist-jsr", "dist-libs"]);
+ */
+export interface ApplyMagicSpellsOptions {
+    /** Absolute or cwd-relative root directory to process */
+    dir: string;
+    /** Number of files to process in parallel */
+    concurrency?: number;
+    /** Number of files to process in each batch */
+    batchSize?: number;
+    /** Whether to stop on first error */
+    stopOnError?: boolean;
+    /** Whether to copy files from src before processing */
+    copyFileWithDirectivesFromSrcBeforeProcessing?: boolean;
+}
+export interface ApplyMagicSpellsResult {
+    /** All processed files */
+    processedFiles: string[];
+}
+/**
+ * Processes files in specified distribution directories by applying magic directives
+ * First scans src directory for files with magic directives, then processes corresponding dist files
+ * @param targets Array of distribution targets in format "dist-npm", "dist-jsr", "dist-libs" or "dist-libs/lib-name"
+ * @param options Configuration options for processing
+ * @returns Object containing arrays of processed files and processed .d.ts files
+ */
+export declare function applyMagicSpells(targets: string[], options?: Partial<ApplyMagicSpellsOptions>): Promise<ApplyMagicSpellsResult>;
+/**
+ * Gets all available registries across all libraries
+ * @returns Array of unique registry names found across all libraries
+ */
+export declare function getAllAvailableRegistries(): Promise<string[]>;