@visulima/ansi 4.0.0-alpha.1 → 4.0.0-alpha.2

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## @visulima/ansi [4.0.0-alpha.2](https://github.com/visulima/visulima/compare/@visulima/ansi@4.0.0-alpha.1...@visulima/ansi@4.0.0-alpha.2) (2025-12-06)
+
+### Bug Fixes
+
+* add new package image, fixed readme rendering on npm, fixed building of packages ([b790ba2](https://github.com/visulima/visulima/commit/b790ba253ea07fef83528fd822a678facf021b5f))
+
+### Miscellaneous Chores
+
+* update @anolilab/semantic-release-pnpm and @anolilab/semantic-release-preset to versions 3.2.2 and 12.1.2 across multiple package.json files for improved compatibility ([3921626](https://github.com/visulima/visulima/commit/3921626141fe5da398749bf0ba675f1596f18afb))
+
+
+### Dependencies
+
+* **@visulima/colorize:** upgraded to 2.0.0-alpha.2
+* **@visulima/path:** upgraded to 3.0.0-alpha.2
+
 ## @visulima/ansi [4.0.0-alpha.1](https://github.com/visulima/visulima/compare/@visulima/ansi@3.0.5...@visulima/ansi@4.0.0-alpha.1) (2025-12-05)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -1,15 +1,24 @@
-<div align="center">
-  <h3>visulima ansi</h3>
-  <p>
-  ANSI escape codes for some terminal swag.
-  </p>
-</div>
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
+
+<a href="https://www.anolilab.com/open-source" align="center">
+
+  <img src="__assets__/package-og.svg" alt="ansi" />
+
+</a>
+
+<h3 align="center">ANSI escape codes for some terminal swag.</h3>
+
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
 <br />
 
 <div align="center">
 
-[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
+[![typescript-image][typescript-badge]][typescript-url]
+[![mit licence][license-badge]][license]
+[![npm downloads][npm-downloads-badge]][npm-downloads]
+[![Chat][chat-badge]][chat]
+[![PRs Welcome][prs-welcome-badge]][prs-welcome]
 
 </div>
 
@@ -420,14 +429,23 @@ If you would like to help take a look at the [list of issues](https://github.com
 - [Daniel Bannert](https://github.com/prisis)
 - [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
 
+## Made with ❤️ at Anolilab
+
+This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
+
 ## License
 
-The visulima ansi is open-sourced software licensed under the [MIT][license-url]
+The visulima ansi is open-sourced software licensed under the [MIT][license]
 
-[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+<!-- badges -->
 
-[typescript-url]: https://www.typescriptlang.org/ "TypeScript" "typescript"
-[license-image]: https://img.shields.io/npm/l/@visulima/ansi?color=blueviolet&style=for-the-badge
-[license-url]: LICENSE.md "license"
-[npm-image]: https://img.shields.io/npm/v/@visulima/ansi/latest.svg?style=for-the-badge&logo=npm
-[npm-url]: https://www.npmjs.com/package/@visulima/ansi/v/latest "npm"
+[license-badge]: https://img.shields.io/npm/l/@visulima/ansi?style=for-the-badge
+[license]: https://github.com/visulima/visulima/blob/main/LICENSE
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@visulima/ansi?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@visulima/ansi
+[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-welcome]: https://github.com/visulima/visulima/blob/main/.github/CONTRIBUTING.md
+[chat-badge]: https://img.shields.io/discord/932323359193186354.svg?style=for-the-badge
+[chat]: https://discord.gg/TtFJY8xkFK
+[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: https://www.typescriptlang.org/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/ansi",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-alpha.2",
   "description": "ANSI escape codes for some terminal swag.",
   "keywords": [
     "alternative-screen",
@@ -153,18 +153,21 @@
     "README.md",
     "CHANGELOG.md"
   ],
+  "dependencies": {
+    "type-fest": "^5.3.0"
+  },
   "devDependencies": {
     "@anolilab/eslint-config": "16.4.4",
     "@anolilab/prettier-config": "^6.0.8",
-    "@anolilab/semantic-release-pnpm": "3.2.0",
-    "@anolilab/semantic-release-preset": "^12.1.0",
+    "@anolilab/semantic-release-pnpm": "3.2.2",
+    "@anolilab/semantic-release-preset": "^12.1.2",
     "@arethetypeswrong/cli": "^0.18.2",
     "@secretlint/secretlint-rule-preset-recommend": "^11.2.5",
     "@total-typescript/ts-reset": "^0.6.1",
     "@types/node": "24.10.1",
-    "@visulima/colorize": "2.0.0-alpha.1",
-    "@visulima/packem": "2.0.0-alpha.37",
-    "@visulima/path": "3.0.0-alpha.1",
+    "@visulima/colorize": "2.0.0-alpha.2",
+    "@visulima/packem": "2.0.0-alpha.40",
+    "@visulima/path": "3.0.0-alpha.2",
     "@vitest/coverage-v8": "^4.0.15",
     "@vitest/ui": "^4.0.15",
     "ansi-regex": "^6.2.2",
@@ -178,7 +181,6 @@
     "rimraf": "6.1.2",
     "secretlint": "11.2.5",
     "semantic-release": "^25.0.2",
-    "type-fest": "^5.3.0",
     "typescript": "5.9.3",
     "vitest": "^4.0.15"
   },

package/dist/alternative-screen.d.ts

@@ -1,74 +0,0 @@
-/**
- * ANSI escape sequence to enable the alternative screen buffer.
- *
- * This sequence (`CSI ?1049h`) instructs the terminal to switch to the alternative screen buffer.
- * This is a common practice for full-screen terminal applications (e.g., vim, less, htop)
- * to provide a separate screen area for their interface, leaving the original shell content
- * undisturbed and restoring it upon exit.
- * When this mode is activated, the original screen content is typically saved by the terminal,
- * and a blank screen is presented. Operations then occur on this alternative buffer.
- *
- * The specific behavior (like whether the screen is cleared on switch) can sometimes vary
- * slightly between terminal emulators. `?1049h` generally includes saving the cursor position
- * along with the screen content and clearing the alternative screen.
- * It is closely related to mode `?47h`, which also switches to an alternative buffer but might
- * have different semantics regarding screen clearing and cursor saving.
- * Mode `?1049h` is generally preferred for a more robust alternative screen experience.
- * @see {@link ALT_SCREEN_OFF} for the sequence to disable the alternative screen buffer.
- * @see {@link alternativeScreenOn} for a function that returns this sequence.
- * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer} Xterm Control Sequences documentation.
- * @see {@link https://vt100.net/docs/vt510-rm/DECSLPP.html} (related DEC modes, though 1049 is more common for this behavior).
- */
-export declare const ALT_SCREEN_ON: string;
-/**
- * ANSI escape sequence to disable the alternative screen buffer.
- *
- * This sequence (`CSI ?1049l`) instructs the terminal to switch back from the alternative
- * screen buffer to the main screen buffer. When this occurs, the terminal typically
- * restores the screen content and cursor position that were saved when the alternative
- * buffer was activated by {@link ALT_SCREEN_ON}.
- *
- * This is used when a full-screen application exits, allowing the user to return to their
- * previous shell session seamlessly.
- * @see {@link ALT_SCREEN_ON} for the sequence to enable the alternative screen buffer.
- * @see {@link alternativeScreenOff} for a function that returns this sequence.
- */
-export declare const ALT_SCREEN_OFF: string;
-/**
- * Returns the ANSI escape sequence to enable the alternative screen buffer.
- *
- * This function is a convenience wrapper around the {@link ALT_SCREEN_ON} constant.
- * It provides a more descriptive way to obtain the sequence for enabling the
- * alternative screen, often used at the initialization phase of a full-screen
- * terminal application.
- * @returns The ANSI escape sequence (`CSI ?1049h`) for enabling the alternative screen buffer.
- * @example
- * ```typescript
- * import { alternativeScreenOn } from '@visulima/ansi/alternative-screen';
- *
- * process.stdout.write(alternativeScreenOn());
- * // Terminal switches to the alternative screen buffer.
- * ```
- * @see {@link ALT_SCREEN_ON}
- * @see {@link alternativeScreenOff}
- */
-export declare const alternativeScreenOn: () => string;
-/**
- * Returns the ANSI escape sequence to disable the alternative screen buffer.
- *
- * This function is a convenience wrapper around the {@link ALT_SCREEN_OFF} constant.
- * It provides a more descriptive way to obtain the sequence for disabling the
- * alternative screen, typically used when a full-screen terminal application is exiting
- * to restore the user's original terminal state.
- * @returns The ANSI escape sequence (`CSI ?1049l`) for disabling the alternative screen buffer.
- * @example
- * ```typescript
- * import { alternativeScreenOff } from '@visulima/ansi/alternative-screen';
- *
- * process.stdout.write(alternativeScreenOff());
- * // Terminal switches back to the main screen buffer, restoring previous content.
- * ```
- * @see {@link ALT_SCREEN_OFF}
- * @see {@link alternativeScreenOn}
- */
-export declare const alternativeScreenOff: () => string;

package/dist/alternative-screen.js

@@ -1,8 +0,0 @@
-import { C as CSI } from './packem_shared/constants-CE7WkXh_.js';
-
-const ALT_SCREEN_ON = `${CSI}?1049h`;
-const ALT_SCREEN_OFF = `${CSI}?1049l`;
-const alternativeScreenOn = () => ALT_SCREEN_ON;
-const alternativeScreenOff = () => ALT_SCREEN_OFF;
-
-export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn };

package/dist/clear.d.ts

@@ -1,77 +0,0 @@
-/**
- * Moves the cursor to the top-left (0,0 in 0-indexed terms) and erases from the cursor to the end of the screen.
- *
- * This sequence is a combination of:
- * 1. {@link cursorTo}(0, 0): Moves the cursor to the first row, first column.
- * (Equivalent to `CSI 1;1H` as `cursorTo` uses 0-indexed arguments which are converted to 1-indexed for the sequence).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.ToEnd}): Erases from the cursor position to the end of the screen (`CSI 0J` or `CSI J`).
- *
- * Effective combined sequence: `CSI 1;1H CSI J` (or `CSI 1;1H CSI 0J`).
- * @see {@link cursorTo}
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.ToEnd}
- */
-export declare const clearScreenFromTopLeft: string;
-/**
- * Erases the entire current line and moves the cursor to the beginning of that line (column 1).
- *
- * This sequence is a combination of:
- * 1. {@link eraseInLine}({@link EraseLineMode.EntireLine}): Erases the entire current line (`CSI 2K`).
- * 2. `CSI G`: Moves the cursor to column 1 of the current line (Cursor Horizontal Absolute).
- * Alternatively, a carriage return (`\r`) could achieve a similar cursor move to the start of the line on many systems.
- *
- * Effective combined sequence: `CSI 2K CSI G`.
- * @see {@link eraseInLine}
- * @see {@link EraseLineMode.EntireLine}
- */
-export declare const clearLineAndHomeCursor: string;
-/**
- * Homes the cursor to the top-left position (row 1, column 1) and erases the entire screen.
- *
- * This sequence is a combination of:
- * 1. `CSI H`: Moves the cursor to the home position (top-left, equivalent to `CSI 1;1H`).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}): Erases the entire screen (`CSI 2J`).
- *
- * Effective combined sequence: `CSI H CSI 2J`.
- * @remarks This is a very common sequence for clearing the visible terminal window.
- * @see {@link cursorPosition} (which `CSI H` relates to)
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- */
-export declare const clearScreenAndHomeCursor: string;
-/**
- * Clears the entire terminal display, including the scrollback buffer on supported terminals,
- * and attempts to reset the terminal to its initial (or a more pristine) state.
- *
- * This is generally a more comprehensive and forceful clear operation than just erasing the
- * visible screen content (like {@link clearScreenAndHomeCursor}).
- *
- * The exact behavior and sequences used can vary by terminal and operating system:
- *
- * - **On Windows:**
- * It typically uses `CSI 2J` (erase entire screen) followed by `CSI 0f`.
- * `CSI 0f` (or `CSI ;f`, `CSI 0;0f`) is an SGR sequence that also often acts as a cursor home command,
- * though its standardization can be less consistent than `CSI H`.
- * The primary goal is to clear the screen and move the cursor to the top-left.
- *
- * - **On other platforms (e.g., Linux, macOS with XTerm-like terminals):**
- * A more robust combination is used:
- * 1. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}) (`CSI 2J`): Erases the entire visible screen.
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreenAndScrollback}) (`CSI 3J`): Erases the scrollback buffer (XTerm-specific, but widely supported).
- * 3. `CSI H`: Moves the cursor to the home position (top-left).
- * 4. `ESC c` (RIS - Reset to Initial State): This is the most powerful reset sequence. It typically resets the terminal
- * to its power-on state, clearing character sets, SGR attributes, modes, and more.
- * @returns A string containing the ANSI escape sequence(s) for resetting the terminal.
- * @example
- * ```typescript
- * import { resetTerminal } from '@visulima/ansi/clear';
- *
- * process.stdout.write(resetTerminal);
- * // The terminal attempts a full reset.
- * ```
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- * @see {@link EraseDisplayMode.EntireScreenAndScrollback}
- * @see {@link https://vt100.net/docs/vt510-rm/RIS.html} RIS documentation.
- */
-export declare const resetTerminal: string;

package/dist/clear.js

@@ -1,16 +0,0 @@
-import { C as CSI, E as ESC } from './packem_shared/constants-CE7WkXh_.js';
-import { s as cursorTo, A as isWindows } from './packem_shared/cursor-CHPvxMal.js';
-import { eraseDisplay, eraseInLine, EraseDisplayMode, EraseLineMode } from './erase.js';
-
-const clearScreenFromTopLeft = cursorTo(0, 0) + eraseDisplay(EraseDisplayMode.ToEnd);
-const clearLineAndHomeCursor = `${eraseInLine(EraseLineMode.EntireLine) + CSI}G`;
-const clearScreenAndHomeCursor = `${CSI}H${eraseDisplay(EraseDisplayMode.EntireScreen)}`;
-const resetTerminal = isWindows ? `${eraseDisplay(EraseDisplayMode.EntireScreen) + CSI}0f` : (
-  // 1. Erases the screen (as a fallback/part of comprehensive clear)
-  // 2. Erases the whole screen including scrollback buffer (XTerm)
-  // 3. Moves cursor to the top-left position
-  // 4. RIS - Hard Reset (most comprehensive reset)
-  `${eraseDisplay(EraseDisplayMode.EntireScreen) + eraseDisplay(EraseDisplayMode.EntireScreenAndScrollback) + CSI}H${ESC}c`
-);
-
-export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal };

package/dist/constants.d.ts

@@ -1,20 +0,0 @@
-/** Escape character (\u001B). */
-export declare const ESC: string;
-/** Control Sequence Introducer (ESC [). */
-export declare const CSI: string;
-/** Operating System Command (ESC ]). */
-export declare const OSC: string;
-/** Bell character (\u0007). Often used to terminate OSC sequences. */
-export declare const BEL: string;
-/** Separator used in some ANSI sequences, typically a semicolon. */
-export declare const SEP: string;
-/** Device Control String (ESC P). */
-export declare const DCS: string;
-/** String Terminator (ESC \\). Used to terminate DCS, SOS, PM, APC sequences. */
-export declare const ST: string;
-/** Application Program Command (ESC _). */
-export declare const APC: string;
-/** Start of String (ESC X). */
-export declare const SOS: string;
-/** Privacy Message (ESC ^). */
-export declare const PM: string;