Include docs/ folder in bun-types (#15398)

oven-sh · Nov 25, 2024 · 9cbe1ec · 9cbe1ec
1 parent 4f8c1c9
commit 9cbe1ec
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 71 deletions.
diff --git a/docs/upgrading-webkit.md → docs/contributing/upgrading-webkit.md b/docs/upgrading-webkit.md → docs/contributing/upgrading-webkit.md
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
diff --git a/packages/bun-types/.gitignore b/packages/bun-types/.gitignore
@@ -1,2 +1,4 @@
 node_modules/
-dist/
+dist/
+docs/
+*.tgz
diff --git a/packages/bun-types/package.json b/packages/bun-types/package.json
@@ -3,14 +3,16 @@
   "license": "MIT",
   "main": "",
   "types": "index.d.ts",
-  "description": "Type definitions for Bun, an incredibly fast JavaScript runtime",
+  "description": "Type definitions and documentation for Bun, an incredibly fast JavaScript runtime",
   "repository": {
     "type": "git",
     "url": "https://github.com/oven-sh/bun",
     "directory": "packages/bun-types"
   },
   "files": [
-    "*.d.ts"
+    "*.d.ts",
+    "docs/**/*.md",
+    "docs/*.md"
   ],
   "homepage": "https://bun.sh",
   "dependencies": {
@@ -25,7 +27,8 @@
   },
   "scripts": {
     "prebuild": "echo $(pwd)",
-    "build": "bun scripts/build.ts && bun run fmt",
+    "copy-docs": "rm -rf docs && cp -r ../../docs/ ./docs",
+    "build": "bun run copy-docs && bun scripts/build.ts && bun run fmt",
     "test": "tsc",
     "fmt": "echo $(which biome) && biome format --write ."
   },