@bekmurod6574/explain-deps 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,37 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @bekmurod6574/explain-deps
|
|
2
|
+
|
|
3
|
+
A lightweight Command Line Interface (CLI) tool designed to scan your project's dependencies and give you a clear, understandable breakdown of what each package does and why it's there. No more guessing why a mysterious library is sitting in your `package.json`.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Features
|
|
8
|
+
|
|
9
|
+
* **Dependency Breakdown:** Scans your project's `dependencies` and `devDependencies`.
|
|
10
|
+
* **Plain English Explanations:** Translates cryptic package names into clear descriptions of their purpose.
|
|
11
|
+
* **Fast & Local:** Powered by an internal cache system for lightning-fast execution without heavy API overhead.
|
|
12
|
+
* **Developer Friendly:** Zero-configuration required—just run it inside any Node.js project.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 📦 Installation
|
|
17
|
+
|
|
18
|
+
You can run this tool directly without installing it globally using `npx`:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @bekmurod6574/explain-deps
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Alternatively, install it globally on your machine:
|
|
25
|
+
```bash
|
|
26
|
+
npm install -g @bekmurod6574/explain-deps
|
|
27
|
+
```
|
|
28
|
+
### Usage
|
|
29
|
+
Simply navigate to the root directory of any Node.js project (where your package.json lives) and run the command:
|
|
30
|
+
```bash
|
|
31
|
+
explain-deps
|
|
32
|
+
```
|
|
33
|
+
## Project Structure
|
|
34
|
+
For developers looking to contribute or understand the internals:
|
|
35
|
+
- src/index.js - Main programmatic entry point. (empty - no need to consider)
|
|
36
|
+
- src/bin/cli.js - The executable script that handles terminal commands.
|
|
37
|
+
- src/data/cache.json - Core dictionary dataset mapping package names to explanations.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bekmurod6574/explain-deps",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "explain-deps is a lightweight CLI tool that brings clarity to your terminal. It scans your local package.json file, fetches your project's dependencies, and prints out a clean, plain-English summary of exactly what each package does—saving you from endless searching when trying to understand a new codebase.",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"bin": {
|