Inner Package Manager

Installation

npm i inner-package-manager

Description

The idea behind this project is to provide a way to handle dependencies that will be tracked by git.

How to use

First of all, you will need a file called inner-packages.json in the root of your project. This file will contain the dependencies of your project.

{
  "packages": [
    {
      "name": "your-package-name",
      "repo": "https://github.com/your-github-user/your-repo-name.git",
      "at": "master",
      "targetDir": "your/relative/target/directory"
    }
  ]
}

note: The at field is optional, you can use it to specify a branch, tag or commit hash. note: The targetDir field is optional, you can use it to specify a relative directory where the files will be copied else will be at the repos folder.

To create an inner-packages.json file for you if not exists you can run the following command.

npm inner init

Then run the following command to install the required dependencies.

npm inner install

To install a certain package you can run the following command.

npm inner install your-github-repo-url

Under the hood

The tool will clone the repository at the given branch, tag or commit hash. Then it will copy the files from the cloned repository to the root of your project. But excluding the .git This also will look for a package.json file (if exists) in the root of the cloned repository and will install the dependencies of the cloned repository. As well as the dependencies on an inner-packages.json file in the cloned repository.

Contributing

Contributions are welcome! If you'd like to contribute to this library, please fork the repository and submit a pull request.

How to Contribute Fork the repository.

• Create a new branch for your feature git checkout -b feature-name
• Commit your changes git commit -am 'Add new feature'
• Push to the branch git push origin feature-name
• Open a pull request. I'll be happy to review it!

License

This project is licensed under the GPL-3.0 License.

Author

Marcos Alvarez