V3! Re wrote initCliLoader function to be cleaner and use better data structure for constant time. Returning intervalId to clear the timer.

Author: cbmongithub

CHANGELOG.md

@@ -1,5 +1,14 @@
 # cli-loaders
 
+## 3.0.0
+
+### Major Changes
+
+- - Full and clean re write of initCliLoader function using constant time to access objects + tree shaking.
+  - Returning the intervalId so users can clear the loader with clearInterval(intervalId).
+  - Updated website to reflect changes in the examples sections.
+  - Site changes and loader updates with the current naming convention (permanent) to follow.
+
 ## 2.3.1
 
 ### Patch Changes
@@ -10,10 +19,10 @@
 
 ### Minor Changes
 
-- - Added new loader, 'emojis_10'.
-  - Some loaders have been renamed to follow the naming convention, final change.
-  - New loader, initCliLoader which takes in a loader name and optional speed and keyframes parameters for full customization.
-  - Updated data structure for tree shaking.
+- Added new loader, 'emojis_10'.
+- Some loaders have been renamed to follow the naming convention, final change.
+- New loader, initCliLoader which takes in a loader name and optional speed and keyframes parameters for full customization.
+- Updated data structure for tree shaking.
 
 ## 2.2.0
 

README.md

@@ -6,54 +6,71 @@ A collection of cli loaders for your command-line applications.
 
 Visit the [website](https://cliloaders.com) to see all loaders, copy keyframes, and more!
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Importing Loaders](#importing-loaders)
+  - [Initializing a Loader](#initializing-a-loader)
+  - [Customizing the Speed](#customizing-the-speed)
+  - [Customizing Everything](#customizing-everything)
+  - [Stopping the Loader](#stopping-the-loader)
+- [Available Loaders](#available-loaders)
+- [Performance](#performance)
+- [Contributing](#contributing)
+- [License](#license)
+- [Special Thanks](#special-thanks)
 
 ## Installation
 
 To install the package, use npm or yarn:
 
 ```bash
-npm install cli-loaders
+npm install cli-loaders;
 # or
-yarn add cli-loaders
+yarn add cli-loaders;
 # or
-bun install cli-loaders
+bun install cli-loaders;
 ```
 
 ## Usage
 
 ### Importing Loaders
 
-Import the loader initializer
+Import the loader initializer:
 
 ```typescript
-import { initLoader } from 'cli-loaders';
+import { initCliLoader } from 'cli-loaders';
 ```
 
 ### Initializing a Loader
 
-You can initialize any loader by its name using `initLoader`
+You can initialize any loader by its name using `initCliLoader`:
 
 ```typescript
-import { initLoader } from 'cli-loaders';
+import { initCliLoader, dots_1 } from 'cli-loaders';
 
 // Initialize by name
-initLoader('dots_1');
+initCliLoader('dots_1');
+
+// initCliLoader(dots_1);
 ```
 
 ### Customizing the Speed
 
 You can also customize the speed of the loader:
 
 ```typescript
-import { initLoader } from 'cli-loaders';
+import { initCliLoader, dots_1 } from 'cli-loaders';
 
 // Initialize with custom speed
-initLoader('dots_1', 100);
+initCliLoader('dots_1', 150);
+// initCliLoader(dots_1, 150);
 ```
 
-### Customizing everything
+### Customizing Everything
 
-New to v2.0+, you can import the cli loader initializer, `initCliLoader` for full customization
+New in v2.0+, you can import the cli loader initializer, `initCliLoader` for full customization:
 
 ```typescript
 import { initCliLoader, dots_14 } from 'cli-loaders';
@@ -69,9 +86,62 @@ initCliLoader(dots_14, 100); // Render loader with custom speed
 initCliLoader(dots_14, 100, ["⠋","⠙","⠹","⠸","⠼","⠴","⠦","⠧","⠇","⠏"]); // Render loader with speed and keyframes customized
 ```
 
-### Upgrading versions
+Or you could customize it with an object:
+
+```typescript
+const myAwesomeLoader = {
+    speed: 100,
+    keyframes: ["..", "."]
+};
+
+initCliLoader(myAwesomeLoader);
+```
+
+### Stopping the Loader
+
+To stop the loader, you can use `clearInterval` with the interval ID returned by `initCliLoader`:
+
+```typescript
+import { initCliLoader } from 'cli-loaders';
+
+const intervalId = initCliLoader('dots_1');
+
+// Stop the loader after some time
+setTimeout(() => {
+  clearInterval(intervalId);
+}, 5000);
+```
 
-Upgrading versions can be breaking. Double check the [website](https://cliloaders.com) first, to see if a loader has moved or is following a new naming convention. The website will always be updated with the most current version of cli-loaders.
+## Available Loaders
+
+Here are some of the available loaders you can use:
+
+- `arrows_1`
+- `arrows_2`
+- `bars_1`
+- `bars_2`
+- `circles_1`
+- `circles_2`
+- `dots_1`
+- `dots_2`
+- `emojis_1`
+- `emojis_2`
+- `lines_1`
+- `lines_2`
+- `numbers_1`
+- `numbers_2`
+- `squares_1`
+- `squares_2`
+- `symbols_1`
+- `symbols_2`
+- `togglers_1`
+- `togglers_2`
+
+For a full list of available loaders, please refer to the [source code](/src/cli-loaders.ts) or the [website](https://cliloaders.com).
+
+## Performance
+
+cli-loaders is, as it should be, very fast. It's tree shakable, and uses 0(1) time complexity to access the loader objects.
 
 ## Contributing
 

bun.lockb

@@ -1,6 +1,6 @@
 {
   "name": "cli-loaders",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "author": {
     "name": "Christian Martinez",
     "url": "http://christianbmartinez.com"
@@ -16,6 +16,9 @@
     "@changesets/cli": "^2.27.11",
     "@types/bun": "^1.1.14",
     "@types/node": "^22.10.5",
+    "babel-plugin-react-compiler": "^19.0.0-beta-27714ef-20250124",
+    "eslint-plugin-react-compiler": "^19.0.0-beta-27714ef-20250124",
+    "prettier": "^3.4.2",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2"
   },
@@ -51,7 +54,8 @@
     "start": "node dist/index.js",
     "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "build": "tsup src/index.ts --format cjs,esm --dts --minify",
-    "lint": "tsc"
+    "lint": "tsc",
+    "test": "bun test test/init-cli-loader.test.ts --watch"
   },
   "type": "module"
 }

package.json

@@ -481,14 +481,7 @@ export const togglers_14 = {
     keyframes: ['❂', '✪'],
 };
 
-type CliLoadersProps = {
-    [key: string]: {
-        speed: number;
-        keyframes: string[];
-    }
-};
-
-const cliLoaders: CliLoadersProps = {
+const cliLoaders = {
     arrows_1,
     arrows_2,
     arrows_3,

src/cli-loaders.ts

@@ -1,5 +1,4 @@
 export * from './cli-loaders';
 export { default as cliLoaders } from './cli-loaders';
-export { default as initCliLoader } from './init-cli-loader';
-export { default as initLoader } from './init-loader';
+export { default as initLoader } from './init-cli-loader';