Let's give bun a try

Bun is a new JavaScript/TypeScript runtime with everything built in.
It seems like it could be a lot easier than using a bunch of tools.
It also is a bit faster and has some improvements to security.
This replaces node, c8, esbuild, taze, maybe some other things.

Author: bhousel

.github/workflows/build.yml

@@ -16,16 +16,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['18', '20', '22']
+        bun-version: ['1.3']
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+    - uses: actions/checkout@v5
+    - name: Use Bun ${{ matrix.bun-version }}
+      uses: oven-sh/setup-bun@v2
       with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
+        bun-version: ${{ matrix.bun-version }}
+    - run: bun install
     - run: |
         echo "::remove-matcher owner=eslint-compact::"
         echo "::remove-matcher owner=eslint-stylish::"
-    - run: npm run test
+    - run: bun run all

.gitignore

@@ -1,9 +1,11 @@
+/coverage
+/dist
+/node_modules
+/scratch
+
 .DS_Store
-.cache
+.vscode
 npm-debug.log
+lerna-debug.log
 package-lock.json
-
-.nyc_output/
-.scratch/
-coverage/
-node_modules/
+yarn.lock

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+This project uses **GitHub** to track issues and manage our source code.
+- Check out the [Git Guides](https://github.com/git-guides) to learn more.
+
+This project uses the **JavaScript** programming language.
+- [MDN's JavaScript guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide) is a great resource for learning about JavaScript.
+
+This project uses the **TypeScript** programming language.
+- Check out the [TypeScript Docs](https://www.typescriptlang.org/docs/) to learn more.
+- (It's a superset of JavaScript, so knowing that already will help you a lot).
+
+This project uses **Bun** as our development environment.
+- Check out the [Bun Docs](https://bun.com/docs) to learn more.
+- (It's similar to other JavaScript tools like Node/Jest/Esbuild/Vite, so knowing any of those already will help you a lot).
+- Bun supports both JavaScript and TypeScript.
+
+If you want to contribute to osm-auth, you'll probably need to:
+- [Install Bun](https://bun.com/docs/installation)
+- `git clone` osm-auth
+- `cd` into the project folder
+- `bun install` the dependencies
+
+As you change things, you'll want to `bun run all` to ensure that things are working.
+(This command just runs `clean`, `lint`, `build`, and `test`.)
+
+You can also test the code in a local server:
+- `bun start` - then open `http://127.0.0.1:8080/` in a browser.
+
+It's also good to check on the dependencies sometimes with commands like:
+- `bun outdated`  - what packages have updates available?
+- `bun update --interactive`  - choose which updates to apply
+
+Try to keep things simple!

README.md

@@ -23,9 +23,9 @@ Try it out now at: https://osmlab.github.io/osm-auth/
 Or you can run the demo locally by cloning this project, then run:
 
 ```sh
-$ npm install
-$ npm run build
-$ npm start
+$ bun install
+$ bun run all
+$ bun start
 ```
 
 This will start a local server on port 8080. Then open `http://127.0.0.1:8080/` in a browser.
@@ -35,7 +35,7 @@ This will start a local server on port 8080. Then open `http://127.0.0.1:8080/`
 
 ### Use in Node
 
-To install osm-auth as a dependency in your project:
+To install osm-auth as a dependency in your Node project:
 ```bash
 $  npm install --save osm-auth
 ```
@@ -148,6 +148,14 @@ if (window.location.search.slice(1).split('&').some(p => p.startsWith('code=')))
 }
 ```
 
+ 
+
+## Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more info.
+
+ 
+
 # API
 
 ## `.osmAuth(options)`

bun.lock

@@ -0,0 +1,8 @@
+[install]
+# Only install package versions published at least 3 days ago
+minimumReleaseAge = 259200 # seconds
+
+[run]
+# equivalent to `bun --bun` for all `bun run` commands
+bun = true
+shell = "bun"