Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 1.38 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.38 KB

Framework

Install

Usage

Develop

This is a mono repository, managed with Nx.

  1. git clone this repo & cd into it as usual
  2. run pnpm setup from the top-level:
    • installs all external dependencies
    • links all internal dependencies

To add a new package to the repo:

  • install slimer
  • run slimer new <package name>

Run

  • pnpm dev

Test

  • pnpm lint runs oxlint across all packages
  • pnpm format formats js/ts/json/md files with oxfmt
  • pnpm format:check checks formatting without writing
  • pnpm test runs tests (most packages also run lint in posttest)

Publish

  1. run one of the release commands in the top-level framework directory:
    • pnpm ship:patch
    • pnpm ship:minor
    • pnpm ship:major
    • for initial Nx bootstrap in long-unreleased repos: pnpm ship:first-release
  2. this runs tests, versions packages, and creates/pushes release commit + tags
    • creates the version commit and pushes tags to main
  3. CI automatically publishes packages via .github/workflows/publish.yml:
    • authenticates to npm using NPM_TOKEN
    • checks each packages/* package version against npm
    • runs npm publish only for versions that are not already published

Copyright & License

Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license.