wbfy 21.9.0 → 21.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,3 +1,15 @@
1
+ ---
2
+ purpose: Every WillBooster repository stays on the organization's current conventions without anyone configuring it by hand.
3
+ goals:
4
+ - Applying `wbfy` to a repository leaves nothing to fix by hand.
5
+ - Applying `wbfy` again changes nothing.
6
+ - The agent instructions `wbfy` generates are all the guidance an AI agent needs to work in the repository.
7
+ nonGoals:
8
+ - Supporting repositories outside WillBooster and WillBoosterLab beyond best effort.
9
+ - Accepting hand-written, legacy, or third-party variants of the files `wbfy` generates.
10
+ - Running on Windows.
11
+ ---
12
+
1
13
  # wbfy
2
14
 
3
15
  [![Test](https://github.com/WillBooster/shared/actions/workflows/test.yml/badge.svg)](https://github.com/WillBooster/shared/actions/workflows/test.yml)
@@ -5,15 +17,6 @@
5
17
 
6
18
  :books::rocket: A tool for applying WillBooster's conventional configurations to npm packages
7
19
 
8
- ## Motivation
9
-
10
- There are some resources for creating a project with conventional configurations like [Yeoman](https://yeoman.io/), GitHub's Template repository, and starter-kit repositories.
11
- However, we sometimes faced the cases where we wanted to apply conventional configurations to an existing repository, so we've launch this tool!
12
-
13
- ## Philosophy
14
-
15
- This tool must keep idempotency, i.e., it always yields the same result when a user applies this tool to a project even multiple times.
16
-
17
20
  ## How to Use
18
21
 
19
22
  Run with Bun >= 1.4.4 or Node.js >= 26 on macOS or Linux. mise must be on `PATH`. The target repository may still pin an older Bun: wbfy installs and activates the managed Node.js and Bun before dependency commands, then checks that the Bun CLI is at least 1.4.4. `bunx @willbooster/wbfy` uses its Bun entry point, including when the target repository still pins Node.js 24. To run the CLI with Node.js, invoke its `bin/wbfy.js` with `node`. After updating `mise.toml`, wbfy uses the pinned Node.js and Bun for dependency installation and cleanup.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "wbfy",
3
- "version": "21.9.0",
3
+ "version": "21.9.2",
4
4
  "description": "A tool for applying WillBooster's conventional configures to npm packages",
5
5
  "repository": {
6
6
  "type": "git",
@@ -18,7 +18,7 @@
18
18
  "NOTICE"
19
19
  ],
20
20
  "dependencies": {
21
- "@willbooster/wbfy": "21.9.0"
21
+ "@willbooster/wbfy": "21.9.2"
22
22
  },
23
23
  "engines": {
24
24
  "bun": ">=1.4.4",