https://github.com/qeffects/pluto-packages
Architecture repository, holding all the pluto packages as submodules
https://github.com/qeffects/pluto-packages
Last synced: 9 months ago
JSON representation
Architecture repository, holding all the pluto packages as submodules
- Host: GitHub
- URL: https://github.com/qeffects/pluto-packages
- Owner: qeffects
- License: mit
- Created: 2024-03-20T14:22:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T18:40:22.000Z (over 1 year ago)
- Last Synced: 2025-03-22T13:23:21.532Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pluto Package repository
This repo acts as the list of all global pluto packages that can be installed through the CLI tool
## To add a new package:
Some pre-requisites:
1. Git locally
2. Your lua library that you want to put on the package manager
3. The library doesn't use absolute require paths
- Create a project to contain your package (with the module.json) etc files.
- Push that project to github or another public accessible git hosting site
- Note this link:
- Fork this project and clone it locally
- Create a new branch "add-my-package-123"
- Add a git submodule with the link that you copied from above, then running `git submodule add ./packages/My-Package-Name/module https://github.com/qeffects/Placeholder-Package-4.git`
- If all is successful, push the branch changes to your fork
- And finally create a pull request pointing to this project
- After approval your package should show up in everyone's pluto package lists and be available for installation
## Adapting a library to work with pluto
When your library gets installed to another project it will get put inside an arbitrary folder, this means that you **can't**
use absolute requires like `require("path.to.whatever")`, if your library is divided in multiple files, you *need* to use relative requires
If you have other pluto modules as dependencies you just need to use the pluto shim file that was generated automatically in your project like `require("pluto")`
this way no matter the structure of the parent project you can just do `require("someOtherPackageName")`
If you have a single entrypoint file it can be named init.lua and later users can just `require("packageName")`
Alternatively `require("packageName.arbitraryFile")` will also work
## Template repo
I made a template repository to initiate a basic pluto module here: https://github.com/qeffects/plutoTemplate, feel free to use it