Starship Butler

[!Caution]

This package is still in development, and the API may change frequently.

[!Note]

This is an "opinionated" "butler", so that it's not suitable for everyone.

Your best butler, helping you manage the whole development "starship". 😃

Features

• 🚀 Quick management of your application configurations & local project configurations
• 📦 Built-in presets for popular tools (Git, Oxlint, ESLint, etc.)
• 🧰 Easy to use CLI interface
• ⚙️ Powered by Bun & TypeScript
• 🔗 Support symlink mode (experimental)
• ...

Usage

Install globally with node package manager (bun, npm, yarn, pnpm, etc.):

bun install starship-butler -g

Run the cli and get help info with --help flag:

butler --help

Preset

Command preset helps you to preset your application configurations.

butler preset [...options]

Applying all presets:

butler preset --all

Specifying included preset id pattern:

butler preset --include <preset_id_pattern>

See help info for more details:

butler preset --help

Set

Command Set helps you to set local project configurations.

butler set <source_pattern> <target> [...options]

If source_pattern does not contain / character, it will be automatically prefix with ** in order to match files in all sub-directories simply. In other word, butler set .eslintrc.json ./project/ is equivalent to butler set **/.eslintrc.json ./project/.

Notice that, if target is not exists yet, butler will judge whether it's a file path or a directory path according to the end character:

• If target is a directory, butler will allows you to choose multiple matched files
• ...Otherwise, butler will only allows you to choose one matched file

For example, butler set .eslintrc.json ./project/ will copy all the chosen files to ./project, while butler set .eslintrc.json ./project will copy the only one chosen file to . and rename it to project.

See help info for more details:

butler set --help

Todos

Preset

• [x] List all built-in presets using --list flag
• [x] Better default target file name, for example, for source assets/project/linter/eslint/library/_eslint.config.js, the default target file name should be eslint.config.js, not _eslint.config.js (without the leading underscore)
• [ ] Backup before applying
• [ ] Restore backup using --restore flag
• [ ] Restore backup when uninstalling (Prompt to user whether to restore backup or not)

Set

• [x] Better default target file name, for example, for source assets/project/linter/eslint/library/_eslint.config.js, the default target file name should be eslint.config.js, not _eslint.config.js (without the leading underscore)

Sponsors

License

MIT License © Lumirelle