Local Package Helper

local_package_helper is a Node.js tool designed to help you synchronize your local Node.js projects with external repositories and local frameworks. It fetches or clones a repository, installs the necessary dependencies, and runs the build process to keep everything up to date. It also supports refreshing the project by reinstalling the packages and rebuilding them.

Features

• Clone or fetch updates from a remote repository
• Find and manage package.json files within a specified depth in the repository
• Automatically install and build packages
• Refresh mode to uninstall and reinstall packages if needed
• Compatible with both Windows and Linux/macOS environments

Installation

You can run this tool directly with npx:

npx local_package_helper <gitUrl> <gitToken> <gitDir> [refresh] [debug]

Alternatively, you can install it globally via npm:

npm install -g local_package_helper

Usage

Basic Command

To use the helper, simply run:

npx local_package_helper <gitUrl> <gitToken> <gitDir>

Arguments

• <gitUrl>: The URL of the Git repository to clone or fetch updates from.
• <gitToken>: The token to authenticate with the Git repository (if required).
• <gitDir>: The directory in which to clone or fetch the repository (within AppData/Roaming on Windows or the home directory on Linux/macOS).
• [refresh]: Optional. Add this flag to refresh the project, forcing uninstallation and reinstallation of all packages.
• [debug]: Optional. Add this flag to enable verbose output and error tracing.

Example

npx local_package_helper https://github.com/example/repo.git myToken repoDir refresh debug

This will:

1. Clone or fetch updates from https://github.com/example/repo.git into AppData/Roaming/repoDir on Windows or ~/repoDir on Linux/macOS.
2. Find all package.json files within two directory levels.
3. Install the dependencies and run the build process for each package.
4. If the refresh flag is present, uninstall and reinstall the packages.

Debug Mode

If you run the tool with the debug flag, you will get detailed output of every command executed, along with any potential errors.

npx local_package_helper https://github.com/example/repo.git myToken repoDir debug

License

This project is licensed under the ISC License.

Author

Developed by Hugo MATHIEU, also known as guedesite.