tonto-package-manager v0.2.9
📝 About The Project
Tonto Package Manager is a Package Manager created to help you manage your Tonto projects. With
it, it's possible to modularize your OntoUML projects, creating a better organization and
separation of contexts. Each tonto project needs a tonto.json
manifest file that provides
necessary information to TPM works properly. All dependencies are installed in the tonto_dependencies
folder.
The manifest file tonto.json
{
"projectName": "Aguiar2019ooco",
"displayName": "Aguiar 2019 Object Oriented Example",
"publisher": "Aguiar",
"version": "1.0.0",
"license": "MIT",
"dependencies": {
"SWO": {
"url": "https://github.com/matheuslenke/tonto-example-models.git",
"directory": "SWO",
"branch": "feature/test-tonto-reference"
},
"SPO": {
"url": "https://github.com/matheuslenke/tonto-example-models.git",
"directory": "SPO"
}
},
"outFolder": "outDirectory"
}
Here, you can see how you can define your project and it's dependencies. You can define dependencies using a branch or a version tag created on the repository, and even defining a directory in case you have multiple projects in the same repository.
Dependency definition
"dependencies": {
"DependencyA": {
"url": "https://github.com/name/repo-name.git",
"directory": "A",
"branch": "feature/testA"
},
"DependencyB": {
"url": "https://github.com/name/repo-name.git",
"directory": "B",
"version": "1.0.1"
},
"DependencyC": {
"url": "https://github.com/name/repo-name.git",
"directory": "C"
},
"DependencyD": {
"url": "https://github.com/name/repo-name.git"
}
Observations:
- In case you don't define any version or branch, it get's the master branch of your repository.
- If you define a version, there must exist a tag in this repository with the exact same name
- Sometimes you might need to delete the tonto_modules folder and install everything again
🔨 Commands
Description of the available commands at TPM
Install
The first and most important one is the install command. With it, TPM will download your dependencies from a github repository. You can use it like that at the root directory of your project, the same containing the tonto.json file.
tpm install
Add dependency
This command adds a dependency. The commands inside of "<>" are required, however the commands inside of "[]" are optional.
tpm add -n <dependencyName> -u <gitUrl> -v [projectVersion] -d [DependencyDirectory]
Help
This command shows help for any command if you need to get more info
tpm help
tpm install help
tpm add help
🔐 License
Distributed under the MIT License. See LICENSE.txt
for more information.
✉️ Contact
Matheus Lenke Coutinho - matheus.l.coutinho@edu.ufes.br - Linkedin - Github