print-project - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

package.json

 {
   "name": "print-project",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A simple CLI tool to print the project tree structure and file contents",
   "main": "dist/index.js",
   "bin": {
-    "print-project": "./dist/index.js"
+    "print-project": "./dist/index.js",
+    "pp": "./dist/index.js"
   },
@@ -9,0 +10,0 @@ "types": "dist/index.d.ts",

README.md

 # Print-Project
 
-The `print-project` command-line tool scans a specified directory and generates a report including the tree structure and content of files that do not match given ignore patterns. It is useful for documenting or analyzing the file layout of projects, especially in development environments.
+The `print-project` command-line tool scans a specified directory and generates a report including the tree structure
+and content of files that do not match given ignore patterns. It is useful for documenting or analyzing the file layout
+of projects, especially in development environments.
 
@@ -30,2 +32,16 @@ ## Installation
 
+### Command Aliases
+
+You can use either `print-project` or `pp` to run the tool:
+
+```bash
+print-project <startPath> [ignorePatterns]
+```
+
+or
+
+```bash
+pp <startPath> [ignorePatterns]
+```
+
 ### Using Default Ignore Patterns
@@ -60,2 +76,6 @@
   ```
+  or
+  ```bash
+  pp ./src
+  ```
 
@@ -67,2 +87,6 @@ - **Ignore specific patterns**:
   ```
+  or
+  ```bash
+  pp ./src "node_modules,*.log,dist,coverage"
+  ```
 
@@ -74,2 +98,6 @@ - **Use default ignore patterns**:
   ```
+  or
+  ```bash
+  pp ./src --ignore-default
+  ```
 
@@ -81,2 +109,6 @@ - **Use default ignore patterns and add custom ones**:
   ```
+  or
+  ```bash
+  pp ./src "*.tmp,*.bak" --ignore-default
+  ```
 
@@ -89,4 +121,5 @@ ## Features
 - **Output Generation**: Creates a text file `project-print.txt` in the current working directory containing:
-  - The structured list of non-ignored files and directories.
-  - The content of non-empty files.
+    - The structured list of non-ignored files and directories.
+    - The content of non-empty files.
+- **Command Alias**: Can be run using either `print-project` or `pp` for convenience.
 
@@ -113,2 +146,3 @@ ## How It Works
 
-Contributions are welcome. Please open an issue first to discuss what you would like to change, or directly submit a pull request.
+Contributions are welcome. Please open an issue first to discuss what you would like to change, or directly submit a
+pull request.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39140

increased by1.34%

Number of lines in readme file

141

increased by31.78%

No dependency changes