Release Notes
Released 6/13/2026
chalk-degit 1.0 is the first stable release of the combined project scaffolding and terminal styling toolkit. This release removes several internal APIs that were previously exposed publicly, including the `Chalk` class and utility functions. Developers integrating this library should review the breaking changes below before upgrading from the main branch.
Breaking changes
- Removed `Chalk` class and constructorThe `source.Chalk` class and its `constructor` method are no longer part of the public API. Previously, consumers could instantiate custom `Chalk` instances directly via `new source.Chalk(options)` to configure color support levels and other settings.Use the default pre-configured `chalk` instance exported by the package instead of instantiating `Chalk` directly. If you need a custom instance with specific options (e.g., forced color levels), use the `chalkFactory` or equivalent named export if available, or set the appropriate environment variables (e.g., `FORCE_COLOR`) to control color behavior at the environment level. ```js // Before (no longer supported) import { Chalk } from 'chalk-degit'; const customChalk = new Chalk({ level: 2 }); // After import chalk from 'chalk-degit'; // Use the default instance directly console.log(chalk.blue('Hello!')); ```
- Removed `stringReplaceAll` utility functionThe internal utility function `source/utilities.stringReplaceAll` has been removed from the public API surface.Use the native JavaScript `String.prototype.replaceAll()` method, which is available in Node.js 15+ and all modern environments, as a direct replacement. ```js // Before (no longer supported) import { stringReplaceAll } from 'chalk-degit/utilities'; const result = stringReplaceAll(str, '\n', '\r\n'); // After const result = str.replaceAll('\n', '\r\n'); ```
- Removed `stringEncaseCRLFWithFirstIndex` utility functionThe internal utility function `source/utilities.stringEncaseCRLFWithFirstIndex` has been removed from the public API surface.This was an internal formatting helper for CRLF-aware ANSI string wrapping. If your code depended on this function, you will need to implement equivalent CRLF-aware string encasing logic manually or restructure your output formatting to avoid relying on this internal utility. ```js // Before (no longer supported) import { stringEncaseCRLFWithFirstIndex } from 'chalk-degit/utilities'; // After — implement custom CRLF handling as needed in your own code function encaseWithCRLF(string, prefix, postfix) { return string .split(/\r?\n/) .map(line => `${prefix}${line}${postfix}`) .join('\r\n'); } ```
Improvements
- Stable 1.0 public APIThe removal of previously exposed internal utilities and the `Chalk` class narrows the public API surface to only intentional, user-facing exports, resulting in a cleaner and more maintainable integration contract for downstream consumers.
API surface
API removals
- classsource.Chalk
- methodsource.Chalk.constructor
- functionsource/utilities.stringReplaceAll
- functionsource/utilities.stringEncaseCRLFWithFirstIndex