Skip to content

Commit 5a969e7

Browse files
chrisbbreuerchrisbbreuer
committed
chore: wip
1 parent 47c56f3 commit 5a969e7

File tree

7 files changed

+414
-32
lines changed

7 files changed

+414
-32
lines changed

‎storage/framework/core/env/MIGRATION.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
### Dependencies Removed
66
- ❌ `@dotenvx/dotenvx` - Completely removed
77
- ❌ `bun-plugin-dotenvx` - Completely removed
8+
- ❌ `std-env` - Replaced with native implementation
89

910
### Files Removed from node_modules
1011
- ✓ `/node_modules/@dotenvx/dotenvx` - Deleted
@@ -20,7 +21,8 @@
2021
### New Native Implementation
2122
- ✅ `@stacksjs/env` - Native Bun plugin
2223
- ✅ Full encryption/decryption support
23-
- ✅ 82 passing tests with 191 assertions
24+
- ✅ Native environment detection utilities
25+
- ✅ 99 passing tests with 235 assertions
2426
- ✅ Zero external dependencies
2527

2628
## 📊 What's Working
@@ -35,6 +37,10 @@
3537
✓ Command substitution $(command)
3638
✓ Multi-environment support
3739
✓ Bun plugin auto-loading
40+
✓ Runtime detection (Bun, Node)
41+
✓ Platform detection (Windows, macOS, Linux)
42+
✓ CI/CD provider detection (14+ platforms)
43+
✓ Environment utilities (TTY, color support, debug mode)
3844
```
3945

4046
### CLI Commands
@@ -49,11 +55,11 @@
4955

5056
### Test Coverage
5157
```
52-
82 pass
58+
99 pass
5359
1 skip
5460
0 fail
55-
191 expect() calls
56-
Ran 83 tests across 4 files. [126.00ms]
61+
235 expect() calls
62+
Ran 100 tests across 5 files. [44.00ms]
5763
```
5864

5965
## 🚀 Usage Examples
@@ -131,6 +137,7 @@ buddy env:keypair
131137
- `src/parser.ts` - .env file parser
132138
- `src/plugin.ts` - Bun plugin
133139
- `src/cli.ts` - CLI commands
140+
- `src/utils.ts` - Environment detection utilities
134141
- `tests/` - Comprehensive test suite
135142

136143
## ✨ Benefits
@@ -155,9 +162,10 @@ buddy env:keypair
155162
```
156163
✅ 100% test coverage for critical paths
157164
✅ 0 external dependencies
158-
✅ 82 passing tests
159-
✅ <200ms full test suite
165+
✅ 99 passing tests (235 assertions)
166+
✅ <50ms full test suite
160167
✅ Compatible with dotenvx APIs
168+
✅ Native environment detection (replaces std-env)
161169
✅ Production-ready
162170
```
163171

‎storage/framework/core/env/README.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ A secure .env file management package with built-in encryption support for Bun a
1111
- 🔧 **Command Substitution** - Execute commands with `$(command)`
1212
- 🎯 **Multi-Environment** - Manage multiple .env files for different environments
1313
- 🛠️ **CLI Tools** - Full-featured CLI via buddy commands
14+
- 🌍 **Environment Detection** - Native runtime, platform, and CI/CD detection utilities
1415

1516
## Installation
1617

@@ -221,6 +222,67 @@ BUILD_TIME=$(date +%s)
221222
GIT_COMMIT=$(git rev-parse HEAD)
222223
```
223224

225+
## Environment Detection
226+
227+
The package includes native utilities to detect runtime, platform, and CI/CD environments:
228+
229+
```typescript
230+
import {
231+
// Runtime detection
232+
isBun,
233+
isNode,
234+
runtime,
235+
runtimeInfo,
236+
237+
// Platform detection
238+
platform,
239+
isWindows,
240+
isMacOS,
241+
isLinux,
242+
243+
// Environment detection
244+
hasTTY,
245+
hasWindow,
246+
isCI,
247+
isDebug,
248+
isMinimal,
249+
isColorSupported,
250+
251+
// Provider detection
252+
provider,
253+
providerInfo,
254+
} from '@stacksjs/env'
255+
256+
// Check runtime
257+
console.log(runtime) // 'bun' | 'node' | 'unknown'
258+
console.log(runtimeInfo) // { name: 'bun', version: '1.3.2' }
259+
260+
// Check platform
261+
console.log(platform) // 'darwin' | 'linux' | 'win32' | etc.
262+
console.log(isMacOS) // true/false
263+
264+
// Check CI environment
265+
console.log(isCI) // true/false
266+
console.log(provider) // 'github' | 'gitlab' | 'vercel' | etc.
267+
console.log(providerInfo) // { name: 'GitHub Actions', detected: true }
268+
```
269+
270+
### Supported CI/CD Providers
271+
272+
- GitHub Actions
273+
- GitLab CI
274+
- CircleCI
275+
- Travis CI
276+
- Jenkins
277+
- Vercel
278+
- Netlify
279+
- Heroku
280+
- AWS
281+
- Azure
282+
- Cloudflare Pages
283+
- Railway
284+
- Render
285+
224286
## Multi-Environment Support
225287

226288
Load different .env files based on environment:

‎storage/framework/core/env/TESTING.md‎

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Test Coverage
44

5-
The `@stacksjs/env` package has comprehensive test coverage with **82 passing tests** across multiple test suites.
5+
The `@stacksjs/env` package has comprehensive test coverage with **99 passing tests** across multiple test suites.
66

77
## Test Suites
88

@@ -98,7 +98,40 @@ Tests for .env file parsing:
9898
- AWS credentials format
9999
- Next.js style .env
100100

101-
### 3. E2E Tests (`tests/e2e.test.ts`)
101+
### 3. Utils Tests (`tests/utils.test.ts`)
102+
103+
**Coverage: 17 tests**
104+
105+
Tests for environment detection utilities:
106+
107+
- **Runtime Detection (2 tests)**
108+
- Bun runtime detection
109+
- Runtime info and version
110+
111+
- **Platform Detection (3 tests)**
112+
- Platform identification
113+
- OS type detection (Windows, macOS, Linux)
114+
- Platform/OS boolean matching
115+
116+
- **Environment Detection (6 tests)**
117+
- TTY detection
118+
- Window detection (browser)
119+
- CI environment detection
120+
- Debug mode detection
121+
- Minimal mode detection
122+
- Color support detection
123+
124+
- **Provider Detection (4 tests)**
125+
- Provider identification
126+
- Valid provider info
127+
- Known provider detection
128+
- Provider info matching
129+
130+
- **Type Safety (2 tests)**
131+
- Correct types for all exports
132+
- Runtime value validation
133+
134+
### 4. E2E Tests (`tests/e2e.test.ts`)
102135

103136
**Coverage: 24 tests**
104137

@@ -145,6 +178,7 @@ bun test
145178
# Run specific test file
146179
bun test tests/crypto.test.ts
147180
bun test tests/parser.test.ts
181+
bun test tests/utils.test.ts
148182
bun test tests/e2e.test.ts
149183

150184
# Run tests with coverage
@@ -154,11 +188,11 @@ bun test --coverage
154188
## Test Results
155189

156190
```
157-
82 pass
191+
99 pass
158192
1 skip
159193
0 fail
160-
191 expect() calls
161-
Ran 83 tests across 4 files. [145.00ms]
194+
235 expect() calls
195+
Ran 100 tests across 5 files. [44.00ms]
162196
```
163197

164198
## Test Data
@@ -198,6 +232,10 @@ This directory is cleaned up after each test.
198232
- Command substitution
199233
- File operations (encrypt, decrypt, set, get)
200234
- Multi-environment support
235+
- Environment detection utilities
236+
- Runtime detection (Bun, Node)
237+
- Platform detection (Windows, macOS, Linux)
238+
- CI/CD provider detection
201239
- Error handling
202240

203241
### Edge Cases Covered
@@ -223,7 +261,7 @@ This directory is cleaned up after each test.
223261

224262
## Performance
225263

226-
All tests complete in under 200ms, with most individual tests completing in < 10ms.
264+
All tests complete in under 50ms, with most individual tests completing in < 5ms.
227265

228266
## Continuous Integration
229267

‎storage/framework/core/env/package.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@
3838
"@stacksjs/development": "workspace:*",
3939
"@stacksjs/path": "workspace:*",
4040
"@stacksjs/validation": "workspace:*",
41-
"fs-extra": "^11.3.1",
42-
"std-env": "^3.9.0"
41+
"fs-extra": "^11.3.1"
42+
},
43+
"peerDependencies": {
44+
"bun-types": "*"
4345
}
4446
}

‎storage/framework/core/env/src/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,4 @@ export * from './crypto'
6060
export * from './parser'
6161
export * from './plugin'
6262
export * from './cli'
63+
export * from './utils'

‎storage/framework/core/env/src/utils.ts‎

Lines changed: 117 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,117 @@
1-
export {
2-
hasTTY,
3-
hasWindow,
4-
isBun,
5-
isCI,
6-
isColorSupported,
7-
isDebug,
8-
isLinux,
9-
isMacOS,
10-
isMinimal,
11-
isNode,
12-
isWindows,
13-
platform,
14-
provider,
15-
providerInfo,
16-
runtime,
17-
runtimeInfo,
18-
} from 'std-env'
1+
/**
2+
* Native environment detection utilities
3+
* Replaces std-env with native implementations
4+
*/
5+
6+
import process from 'node:process'
7+
import { platform as osPlatform } from 'node:os'
8+
9+
// Runtime detection
10+
export const isBun: boolean = typeof Bun !== 'undefined'
11+
export const isNode: boolean = typeof process !== 'undefined' && process.versions?.node !== undefined
12+
export const runtime: 'bun' | 'node' | 'unknown' = isBun ? 'bun' : isNode ? 'node' : 'unknown'
13+
export const runtimeInfo: { name: 'bun' | 'node' | 'unknown', version: string | undefined } = {
14+
name: runtime,
15+
version: isBun ? Bun.version : isNode ? process.version : undefined,
16+
}
17+
18+
// Platform detection
19+
export const platform: NodeJS.Platform = osPlatform()
20+
export const isWindows: boolean = platform === 'win32'
21+
export const isMacOS: boolean = platform === 'darwin'
22+
export const isLinux: boolean = platform === 'linux'
23+
24+
// TTY detection
25+
export const hasTTY: boolean = Boolean(process.stdout?.isTTY)
26+
27+
// Window detection (browser environment)
28+
export const hasWindow: boolean = typeof globalThis.window !== 'undefined'
29+
30+
// CI detection
31+
export const isCI: boolean = Boolean(
32+
process.env.CI
33+
|| process.env.CONTINUOUS_INTEGRATION
34+
|| process.env.BUILD_NUMBER
35+
|| process.env.RUN_ID,
36+
)
37+
38+
// Debug mode detection
39+
export const isDebug: boolean = Boolean(
40+
process.env.DEBUG
41+
|| process.env.VERBOSE
42+
|| process.argv.includes('--debug')
43+
|| process.argv.includes('--verbose'),
44+
)
45+
46+
// Minimal mode detection (CI or non-interactive)
47+
export const isMinimal: boolean = isCI || !hasTTY
48+
49+
// Color support detection
50+
export const isColorSupported: boolean = Boolean(
51+
!isMinimal
52+
&& (
53+
hasTTY
54+
|| process.env.COLORTERM
55+
|| process.env.FORCE_COLOR
56+
|| (process.env.TERM && process.env.TERM !== 'dumb')
57+
),
58+
)
59+
60+
// Provider detection (CI/CD platform)
61+
const providers: Record<string, { name: string, detected: boolean }> = {
62+
github: {
63+
name: 'GitHub Actions',
64+
detected: Boolean(process.env.GITHUB_ACTIONS),
65+
},
66+
gitlab: {
67+
name: 'GitLab CI',
68+
detected: Boolean(process.env.GITLAB_CI),
69+
},
70+
circle: {
71+
name: 'CircleCI',
72+
detected: Boolean(process.env.CIRCLECI),
73+
},
74+
travis: {
75+
name: 'Travis CI',
76+
detected: Boolean(process.env.TRAVIS),
77+
},
78+
jenkins: {
79+
name: 'Jenkins',
80+
detected: Boolean(process.env.JENKINS_URL),
81+
},
82+
vercel: {
83+
name: 'Vercel',
84+
detected: Boolean(process.env.VERCEL),
85+
},
86+
netlify: {
87+
name: 'Netlify',
88+
detected: Boolean(process.env.NETLIFY),
89+
},
90+
heroku: {
91+
name: 'Heroku',
92+
detected: Boolean(process.env.DYNO),
93+
},
94+
aws: {
95+
name: 'AWS',
96+
detected: Boolean(process.env.AWS_REGION || process.env.AWS_LAMBDA_FUNCTION_NAME),
97+
},
98+
azure: {
99+
name: 'Azure',
100+
detected: Boolean(process.env.AZURE_HTTP_USER_AGENT),
101+
},
102+
cloudflare: {
103+
name: 'Cloudflare',
104+
detected: Boolean(process.env.CF_PAGES),
105+
},
106+
railway: {
107+
name: 'Railway',
108+
detected: Boolean(process.env.RAILWAY_ENVIRONMENT),
109+
},
110+
render: {
111+
name: 'Render',
112+
detected: Boolean(process.env.RENDER),
113+
},
114+
}
115+
116+
export const provider: string = Object.keys(providers).find(key => providers[key].detected) || 'unknown'
117+
export const providerInfo: { name: string, detected: boolean } = providers[provider] || { name: 'Unknown', detected: false }

0 commit comments

Comments
 (0)