JavaScript Registry

Usage

Add https://npm.pkg.github.com/talon as a registry in your .npmrc. See the GitHub documentation for more info

echo "registry=https://npm.pkg.github.com/talon" >> .npmrc

then browse the registry and npm install @talon/<package> the packages you want

Contributing

Yarn

The registry uses Yarn Workspaces to manage it's dependencies

install all dependencies

npx yarn install

manage an individual project's dependencies

npx yarn workspace @talon/<package> [add|remove] <dependency>

manage the registry's dependencies

npx yarn -W [add|remove] <dependency>

Note: @talon/sip tries to keep your dependencies up to date by automatically adding and removing them as you use them in your source code!

Gulp

Every package is managed with gulp using @talon/sip. See the Sip README for more info

The monorepo is managed with lerna. To run gulp for every package in the registry use

npx lerna exec -- gulp [test|develop|build]

For one or a few packages, apply a scope

npx lerna exec --scope @talon/<package> -- gulp [test|develop|build]

VS Code

These commands are also made available (and a bit more friendly) as tasks for VS Code users. Try it: ctrl+shift+b!

GitHub

Pull requests must pass the Build Workflow before being merged

Packages are automatically released using semantic release by the CI Workflow and published to the GitHub Registry upon merge to the master branch