@karaoke-cms/migrate
v0.9.0
Published
Migrate a karaoke-cms fork-and-go repo to npm package model
Readme
@karaoke-cms/migrate
Migration tool for karaoke-cms. Helps existing fork-and-go karaoke-cms repos adopt the npm package model.
Where it belongs
packages/migrate/ in the monorepo. Intended to run once in an existing project directory:
npx @karaoke-cms/migrateWhat it does
Planned: rewrites an existing fork-based project (where the framework code lived directly in src/) to the npm-package model (where all framework code is in @karaoke-cms/astro and a theme package).
Specific operations (to be implemented):
- Detects the existing framework version and structure
- Removes framework source files that are now owned by
@karaoke-cms/astro - Writes a
karaoke.config.tswith equivalent settings derived from the old config - Updates
astro.config.mjsto usekaraoke()instead of inline integration code - Updates
src/content.config.tsto usemakeCollections() - Preserves the vault content directory untouched
Status
Not yet implemented. The package exists as a placeholder. The bin/karaoke-migrate entry is declared but src/ is empty.
The migration path from fork-and-go to npm-package model is documented manually in the project wiki.
How it changes the behavior of the system
This package does not affect running sites. It is a one-time migration tool that changes the project structure so the site can thereafter be maintained by upgrading @karaoke-cms/astro and the theme packages rather than pulling framework changes manually.
