<h1 align="center">
bs
</h1>

> Common build scripts for my rbxts projects.

<p align="left">
<a alt="Released version" href="https://www.npmjs.com/package/@daymxn/bs">
<img src="https://img.shields.io/npm/v/%40daymxn%2Fbs?style=flat-square"></a>
<img alt="Last release date" src="https://img.shields.io/github/release-date/daymxn/bs-cli?label=last%20release">
<a alt="Last commit date" href="https://github.com/daymxn/bs-cli/commits/main/">
<img src="https://img.shields.io/github/last-commit/daymxn/bs-cli/main?style=flat-square"></a>
<a alt="Open issues" href="https://github.com/daymxn/bs-cli/issues">
<img src="https://img.shields.io/github/issues/daymxn/bs-cli?style=flat-square"></a>
<img alt="Code size" src="https://img.shields.io/github/languages/code-size/daymxn/bs-cli?style=flat-square">
<a alt="License" href="https://github.com/daymxn/bs-cli/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/daymxn/bs-cli?style=flat-square"></a>
</p>

---

## Demo

![help output](static/demo.png)

## Installation

You can install `bs` from npm, preferably as a `devDependency`.

```sh
pnpm add -D @daymxn/bs
```

You may also want to create a config file to customize a variety of default
behavior.

```sh
pnpm bs config init
```

> [!NOTE]
>
> You can use whatever package manager you want, but `bs`
> uses `pnpm` for most of its commands- so it's expected
> that you have pnpm installed.
>
> Some features may not work correctly against other
> package managers as well.

## Overview

I've been working on a lot of rbxts projects lately, and I found myself
copy and pasting a lot of the same files (eg; testing).

Furthermore, the "scripts" section of `package.json` was getting _excessively_
long, and it was hard to see the commands at a glance.

By abstracting all my scripts into a single CLI, I'm now able to not only
centralize all my common build scripts- but organize them and provide
more robust functionality.

## Commands

For a full list of commands, check out the [commands](commands.md) page.

## Roadmap

- Check command
- Fix command
- Theme command
- Wiki commands
- Semver commands

## Contributing

If you're interested in contributing to **bs**, give the [CONTRIBUTING](CONTRIBUTING.md) doc a read.

## Licence

[Apache 2.0](LICENSE)
