https://github.com/qeffects/pluto-packages

https://github.com/qeffects/pluto-packages

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/qeffects/pluto-packages
• Owner: qeffects
• License: mit
• Created: 2024-03-20T14:22:04.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T16:57:39.000Z (about 2 months ago)
• Last Synced: 2024-11-07T17:51:24.642Z (about 2 months ago)
• Language: JavaScript
• Size: 32.2 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:

![image](https://github.com/user-attachments/assets/f35e2e95-0b94-420f-af4b-7443f00c9c76)

- 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