console-toolkit 1.2.15 → 1.3.0

package/src/ansi/sgr-state.js

@@ -10,9 +10,6 @@ import {
   matchSgr
 } from './sgr.js';
 
-/** The fully reset SGR state with all properties set to `null`.
- * @type {object}
- */
 export const RESET_STATE = {
   bold: null,
   dim: null,
@@ -33,11 +30,6 @@ const defaultState = Symbol('defaultState');
 
 let toState;
 
-/** Extracts the cumulative SGR state from a string by parsing all SGR sequences.
- * @param {string} s - The string to parse.
- * @param {object} [initState] - Initial state to build upon.
- * @returns {object} The resulting SGR state.
- */
 export const extractState = (s, initState = defaultState) => {
   let state = toState(initState);
   matchSgr.lastIndex = 0;
@@ -48,7 +40,7 @@ export const extractState = (s, initState = defaultState) => {
 toState = value => {
   switch (typeof value) {
     case 'object':
-      if (!value) return RESET_STATE;
+      if (!value) return {...RESET_STATE};
       if (typeof value.getState == 'function') return value.getState();
       return value;
     case 'string':
@@ -59,22 +51,19 @@ toState = value => {
 };
 export {toState};
 
-const TOTAL_RESETS = Array.from(Object.keys(RESET_STATE)).length;
+const RESET_KEYS = Object.keys(RESET_STATE);
+const TOTAL_RESETS = RESET_KEYS.length;
 
 const getStateResets = state => {
   let resetCount = 0;
 
-  for (const name of Object.keys(RESET_STATE)) {
+  for (const name of RESET_KEYS) {
     if (state[name] === null) ++resetCount;
   }
 
   return resetCount;
 };
 
-/** Combines multiple SGR states, with later states overriding earlier ones.
- * @param {...(object|string)} states - States to combine.
- * @returns {object} The combined state.
- */
 export const combineStates = (...states) => {
   let state = {};
   for (const s of states) {
@@ -86,10 +75,6 @@ export const combineStates = (...states) => {
   return state;
 };
 
-/** Converts an array of SGR command strings into an SGR state object.
- * @param {string[]} commands - Array of SGR command strings.
- * @returns {object} The resulting state.
- */
 export const commandsToState = commands => {
   let state = {};
   for (let i = 0; i < commands.length; ++i) {
@@ -97,7 +82,7 @@ export const commandsToState = commands => {
     switch (currentCommand) {
       case '': // reset
       case Commands.RESET_ALL:
-        state = RESET_STATE;
+        state = {...RESET_STATE};
         continue;
       case Commands.BOLD:
         state.bold = currentCommand;
@@ -207,11 +192,6 @@ export const commandsToState = commands => {
   return state;
 };
 
-/** Adds SGR commands to an existing state.
- * @param {object} state - The current state.
- * @param {string[]} commands - Commands to add.
- * @returns {object} The updated state.
- */
 export const addCommandsToState = (state, commands) => combineStates(state, commandsToState(commands));
 
 const equalColors = (a, b) => {
@@ -238,10 +218,6 @@ const resetColorProperties = {
 
 const chainedStates = {bold: 1, dim: 1};
 
-/** Converts an SGR state to an array of SGR command strings.
- * @param {object|string} state - The state to convert.
- * @returns {string[]} The command strings.
- */
 export const stateToCommands = state => {
   state = toState(state);
   const commands = [];
@@ -282,11 +258,6 @@ export const stateToCommands = state => {
   return resetCount === TOTAL_RESETS ? [''] : commands;
 };
 
-/** Computes the minimal SGR commands needed to transition from one state to another.
- * @param {object|string} prev - The previous state.
- * @param {object|string} next - The next state.
- * @returns {string[]} The transition commands.
- */
 export const stateTransition = (prev, next) => {
   prev = toState(prev);
   next = toState(next);
@@ -315,7 +286,7 @@ export const stateTransition = (prev, next) => {
   if (next.bold === null) ++resetCount;
   if (next.dim === null) ++resetCount;
 
-  for (const name of Object.keys(RESET_STATE)) {
+  for (const name of RESET_KEYS) {
     if (chainedStates[name] === 1) continue; // skip chained states
     const value = next[name];
     if (resetColorProperties.hasOwnProperty(name)) {
@@ -348,11 +319,6 @@ export const stateTransition = (prev, next) => {
   return commands;
 };
 
-/** Computes the minimal SGR commands to reverse a state transition (from next back to prev).
- * @param {object|string} prev - The state to restore.
- * @param {object|string} next - The current state.
- * @returns {string[]} The reverse transition commands.
- */
 export const stateReverseTransition = (prev, next) => {
   prev = toState(prev);
   next = toState(next);
@@ -381,7 +347,7 @@ export const stateReverseTransition = (prev, next) => {
   if (prev.bold === null) ++resetCount;
   if (prev.dim === null) ++resetCount;
 
-  for (const name of Object.keys(RESET_STATE)) {
+  for (const name of RESET_KEYS) {
     if (chainedStates[name] === 1) continue; // skip chained states
     const value = prev[name];
     if (resetColorProperties.hasOwnProperty(name)) {
@@ -410,17 +376,8 @@ export const stateReverseTransition = (prev, next) => {
   return commands;
 };
 
-/** Converts an array of SGR commands to an escape sequence string, or empty string if no commands.
- * @param {string[]} commands
- * @returns {string}
- */
 export const stringifyCommands = commands => (commands?.length ? setCommands(commands) : '');
 
-/** Optimizes SGR sequences in a string by computing minimal state transitions.
- * @param {string} s - The string to optimize.
- * @param {object} [initState] - Initial state.
- * @returns {string} The optimized string.
- */
 export const optimize = (s, initState = defaultState) => {
   let state = toState(initState),
     result = '',