Skip to content

brioche-dev/brioche-packages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2,954 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Brioche Packages

This repo contains the sources for all published packages for Brioche. Every directory under packages/ will get built and published to the registry automatically when the repo is updated.

Repo structure

  • The repo itself is a Brioche workspace, meaning packages within this repo will directly reference other packages within this repo.
    • For development, this means you can make changes to multiple packages at once and publish the changes together.
  • Each directory under packages/ gets built and published to the registry.

Contributing new packages

To contribute a new package, check out this repo, create a new project under packages/, then submit it as a PR!

For example, if you were going to add a new package called "fizzbuzz", you would create the directory packages/fizzbuzz/, add the file project.bri, then write the build script. You could also test it locally by running brioche build -p ./packages/fizzbuzz.

Every published package must include a project export setting its name (and optionally a version number):

export const project = {
  name: "somepackage",
  version: "1.0.2",
};

Note: For the time being, all packages must have a default export that returns a recipe! For packages that shouldn't have a default export, you can add a dummy default export as a temporary measure

About

Brioche packages, which get auto-published to the Brioche Registry

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 12