Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

which-pm: add bun support #188

Merged
merged 2 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ npm-debug.log*

# Dependency directory
node_modules
bun.lockb

# Coverage directory used by tools like istanbul
coverage
Expand Down
6 changes: 5 additions & 1 deletion which-pm/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
declare function whichpm (pkgPath: string): Promise<whichpm.Result>

declare namespace whichpm {
type Result = NPM | YARN | PNPM | Other
type Result = NPM | YARN | PNPM | BUN | Other

interface NPM {
readonly name: 'npm'
Expand All @@ -16,6 +16,10 @@ declare namespace whichpm {
readonly version: string
}

interface BUN {
readonly name: 'bun'
}

interface Other {
readonly name: string
readonly version?: string
Expand Down
2 changes: 2 additions & 0 deletions which-pm/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ module.exports = async function (pkgPath) {
const exists = await pathExists(path.join(modulesPath, '.yarn-integrity'))
if (exists) return { name: 'yarn' }

if (await pathExists(path.join(pkgPath, 'bun.lockb'))) return { name: 'bun' }

try {
const modules = await loadYamlFile(path.join(modulesPath, '.modules.yaml'))
return toNameAndVersion(modules.packageManager)
Expand Down
1 change: 1 addition & 0 deletions which-pm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"keywords": [
"npm",
"pnpm",
"bun",
"yarn"
],
"author": "Zoltan Kochan",
Expand Down
175 changes: 175 additions & 0 deletions which-pm/test/fixtures/bun/.gitignore
nektro marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
15 changes: 15 additions & 0 deletions which-pm/test/fixtures/bun/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# bun

To install dependencies:

```bash
bun install
```

To run:

```bash
bun run index.ts
```

This project was created using `bun init` in bun v1.1.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
Binary file added which-pm/test/fixtures/bun/bun.lockb
Binary file not shown.
1 change: 1 addition & 0 deletions which-pm/test/fixtures/bun/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log("Hello via Bun!");
11 changes: 11 additions & 0 deletions which-pm/test/fixtures/bun/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "bun",
"module": "index.ts",
"type": "module",
"devDependencies": {
"@types/bun": "latest"
},
"peerDependencies": {
"typescript": "^5.0.0"
}
}
27 changes: 27 additions & 0 deletions which-pm/test/fixtures/bun/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,

// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,

// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,

// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}
6 changes: 6 additions & 0 deletions which-pm/test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ test('identifies yarn installation', async t => {
t.end()
})

test('identifies bun installation', async t => {
const pm = await whichpm(path.join(fixturesDir, 'bun'))
t.deepEqual(pm, { name: 'bun' })
t.end()
})

test('identifies npm installation', async t => {
const pm = await whichpm(path.join(fixturesDir, 'npm'))
t.deepEqual(pm, { name: 'npm' })
Expand Down