Add README and use Bun file read

Author: tedspare

CHANGELOG.md

@@ -1,3 +1,4 @@
+- [2024-11-09] [Add README and use Bun file read](https://github.com/RubricLab/package/commit/72413ce1826d5a064539d622f0c567dd8d65e94d)
 - [2024-10-24] [add notify-monorepo action](https://github.com/RubricLab/package/commit/84c7a866ed0bae6327ace3f1d7eaffde66ec22c8)
 - [2024-10-22] [null commit](https://github.com/RubricLab/package/commit/3ed1bb87967f633a8a20b79e7e64a93ae92ebec0)
 - [2024-10-18] [post-commit hook](https://github.com/RubricLab/package/commit/8d490e082b47dfe7cc169bae481a36f0cc1337b4)

README.md

@@ -0,0 +1,27 @@
+# Package
+
+A tool for scaffolding and publishing NPM packages quickly.
+
+## Getting Started
+
+### Global Installation
+
+Run `bun add -g @rubriclab/package`.
+
+### Per-project Installation
+
+Run `bun add -d @rubriclab/package`.
+
+### Init a package
+
+Ensure you have a `package.json`. If not, run `bun init`.
+
+Run `bunx rubriclab-setuppackage`. This will add a few resources to your package:
+
+- a publish workflow
+  - on push to main, the NPM package will be bumped and auto-published
+- scripts
+  - `lint`: checks for code issues
+  - `format`: tries to fix code issues
+  - `bleed`: updates all dependencies to `latest`
+  - `clean`: clears node modules and cache

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rubriclab/package",
-  "version": "0.0.87",
+  "version": "0.0.88",
   "repository": {
     "type": "git",
     "url": "https://github.com/RubricLab/package.git"
@@ -20,7 +20,7 @@
     "format": "bun x biome format --write .",
     "lint": "bun x biome check .",
     "lint:fix": "bun x biome lint . --write --unsafe",
-    "clean": "rm -rf .next && rm -rf node_modules"
+    "clean": "rm -rf .next; rm bun.lockb; rm -rf node_modules"
   },
   "devDependencies": {
     "@types/bun": "latest"

scripts/post-install.ts

@@ -1,17 +1,14 @@
 #!/usr/bin/env bun
 
-import { readFileSync, writeFileSync } from 'node:fs'
 import { join } from 'node:path'
 
-const projectRoot = process.cwd()
-const pkgJsonPath = join(projectRoot, 'package.json')
-
 try {
-	const pkgJson = JSON.parse(readFileSync(pkgJsonPath, 'utf-8'))
+	const projectRoot = process.cwd()
+	const pkgJsonPath = join(projectRoot, 'package.json')
+
+	const pkgJson = await Bun.file(pkgJsonPath).json()
 
-	pkgJson['simple-git-hooks'] = {
-		'post-commit': 'bun run rubriclab-postcommit'
-	}
+	pkgJson['simple-git-hooks'] = { 'post-commit': 'bun run rubriclab-postcommit' }
 
 	pkgJson.scripts = pkgJson.scripts || {}
 	pkgJson.scripts.prepare = 'bun x simple-git-hooks'
@@ -20,14 +17,16 @@ try {
 	pkgJson.scripts.format = 'bun x biome format --write .'
 	pkgJson.scripts.lint = 'bun x biome check .'
 	pkgJson.scripts['lint:fix'] = 'bun x biome lint . --write --unsafe'
-	pkgJson.publishConfig = {
-		access: 'public'
-	}
-
-	writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2))
+	pkgJson.publishConfig = { access: 'public' }
 
 	const file = Bun.file(join(import.meta.dir, '..', 'workflows/publish-package.yml'))
-	await Bun.write(join(projectRoot, '.github/workflows/publish.yml'), file)
+
+	await Promise.all([
+		Bun.write(pkgJsonPath, JSON.stringify(pkgJson, null, 2)),
+		Bun.write(join(projectRoot, '.github/workflows/publish.yml'), file)
+	])
+
+	console.log('Set up package successfully.')
 } catch (error) {
 	console.error('Postinstall script failed:', error)
 	process.exit(1)