Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
75ee413
Update dependencies and configuration
yamcodes Sep 5, 2025
4f7ab41
Remove `jsdom` dependency and update `vite` version in `package.json`…
yamcodes Sep 5, 2025
1ca60c3
Enable version control system in biome.jsonc configuration
yamcodes Sep 5, 2025
9c50b7f
Update environment variable handling and dependencies
yamcodes Sep 5, 2025
82aa9a7
Update package.json to remove `jsdom` and `vitest` dependencies, reta…
yamcodes Sep 5, 2025
2df8f72
Remove `dotenv` dependency from `package.json` and `pnpm-lock.yaml`, …
yamcodes Sep 5, 2025
4bf63ae
Refactor import statements in test files to remove file extension for…
yamcodes Sep 5, 2025
e0d3bc3
Add test name and update build configuration
yamcodes Sep 5, 2025
c16305a
Update test assertions in index.test.ts to reflect changes in Vite bu…
yamcodes Sep 5, 2025
ab48e04
Update test assertions in index.test.ts to validate RollupOutput obje…
yamcodes Sep 5, 2025
ee4edae
Enhance error handling in index.test.ts for missing VITE_TEST environ…
yamcodes Sep 5, 2025
6de7496
Merge branch 'main' into vite-integration-test
yamcodes Sep 5, 2025
559ca39
Add path alias resolution in vitest.config.ts for improved module imp…
yamcodes Sep 5, 2025
62a3f8b
Refactor import statement order in vitest.config.ts for consistency
yamcodes Sep 5, 2025
8cfa756
Add coverage configuration in vitest.config.ts and enhance tests in i…
yamcodes Sep 5, 2025
04f1a53
Refactor test cases in index.test.ts to streamline Vite build configu…
yamcodes Sep 5, 2025
570bf04
Refactor test cases in index.test.ts to utilize a helper function for…
yamcodes Sep 5, 2025
d0ae32c
Refactor import statements in index.test.ts for improved type usage
yamcodes Sep 5, 2025
2bbdc1f
Update pnpm-lock.yaml and package.json to include @vitejs/plugin-reac…
yamcodes Sep 6, 2025
7a9c7a6
Merge branch 'main' into vite-integration-test
yamcodes Sep 6, 2025
b66b613
Update package.json and pnpm-lock.yaml to reflect new dependencies an…
yamcodes Sep 6, 2025
f42929c
Update @arkenv/vite-plugin version to 0.0.4 in package.json and pnpm-…
yamcodes Sep 6, 2025
b593f55
Enhance example configurations by adding output directory settings
yamcodes Sep 6, 2025
eb42e7f
Comment out HOST and PORT in example configuration for future fixes
yamcodes Sep 6, 2025
8ddef61
Changes from background agent bc-0576b958-3bf0-48b9-9af4-23f9d614b0af…
yamcodes Sep 6, 2025
105d8ce
Update @vitejs/plugin-react to version 5.0.2 in package.json and pnpm…
yamcodes Sep 6, 2025
50aebd8
Enhance Turbo configuration and update TypeScript module resolution
yamcodes Sep 6, 2025
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
5 changes: 5 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: 'pnpm'

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.2.21

- name: Install Dependencies
run: pnpm install

Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: 'pnpm'

- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.2.21

- name: Install dependencies
run: pnpm install

Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# build output
dist/
dist-test/

# dependencies
node_modules/
Expand All @@ -13,7 +14,8 @@ pnpm-debug.log*

# environment variables
.env
.env.production
.env.local
.env*.local

# macOS-specific files
.DS_Store
Expand Down
74 changes: 74 additions & 0 deletions TESTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Testing Strategy

This project uses a focused testing approach that combines unit tests with integration tests that use examples as test fixtures.

## Testing Philosophy

**"Examples as Test Fixtures"** - Our examples serve dual purposes:
1. **Documentation** - Show real-world usage patterns
2. **Test Fixtures** - Provide real projects to test against

This approach ensures the library works in real scenarios while keeping examples clean and focused.

## Test Structure

### Unit Tests (`packages/arkenv/src/*.test.ts`)
- Test individual functions and edge cases
- Validate error handling and type checking
- Fast, isolated tests for core logic

### Integration Tests (`packages/vite-plugin/src/*.test.ts`)
- Test the vite plugin using the `with-vite-react-ts` example as a fixture
- Validate that the plugin works with real Vite projects
- Ensure environment variable injection works correctly

## Running Tests

```bash
# Run all tests
pnpm test -- --run

# Run only unit tests
pnpm test --project arkenv -- --run

# Run only vite plugin tests
pnpm test --project vite-plugin -- --run
```

## Test Coverage

### Core Package (`arkenv`)
- ✅ Environment variable parsing and validation
- ✅ Type checking and error handling
- ✅ Default value handling
- ✅ Custom type validation (host, port, etc.)

### Vite Plugin (`@arkenv/vite-plugin`)
- ✅ Plugin integration with Vite
- ✅ Environment variable loading and injection
- ✅ Real project build testing using the example as a fixture
- ✅ Error handling for missing environment variables

## Benefits of This Approach

1. **Clean Separation** - Examples remain pure examples, not test files
2. **Real-World Validation** - Plugin tests use actual Vite projects
3. **Low Maintenance** - Examples don't need test maintenance
4. **Focused Testing** - Each package tests its own functionality
5. **Integration Coverage** - Plugin tests catch real-world issues

## Examples

Examples are kept clean and focused on demonstrating usage:
- `examples/basic` - Basic Node.js usage
- `examples/with-bun` - Bun runtime usage
- `examples/with-vite-react-ts` - Vite plugin usage (also used as test fixture)

## CI Integration

The CI pipeline runs:
- Unit tests for core functionality
- Integration tests for the vite plugin using real examples
- Ensures no regressions in real-world usage scenarios

This approach provides comprehensive test coverage while maintaining clean, focused examples.
3 changes: 2 additions & 1 deletion biome.jsonc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"vcs": {
"enabled": false,
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true,
"defaultBranch": "main"
Expand All @@ -12,6 +12,7 @@
"**",
"!**/node_modules",
"!**/dist",
"!**/dist-test",
"!**/.gitignore",
"!**/.next",
"!**/.source"
Expand Down
10 changes: 6 additions & 4 deletions examples/basic/index.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import { defineEnv, host, port } from "arkenv";

// TODO: Uncomment once we fix

const env = defineEnv({
HOST: host.default("localhost"),
PORT: port.default("3000"),
// HOST: host.default("localhost"),
// PORT: port.default("3000"),
NODE_ENV: "'development' | 'production' | 'test' = 'development'",
});

// Automatically validate and parse process.env
// TypeScript knows the ✨exact✨ types!
console.log(env.HOST); // (property) HOST: string
console.log(env.PORT); // (property) PORT: number
// console.log(env.HOST); // (property) HOST: string
// console.log(env.PORT); // (property) PORT: number
console.log(env.NODE_ENV); // (property) NODE_ENV: "development" | "production" | "test"

export default env;
2 changes: 1 addition & 1 deletion examples/basic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"build": "tsc"
},
"dependencies": {
"arkenv": "^0.1.3",
"arkenv": "^0.2.0",
"arktype": "^2.0.4"
},
"devDependencies": {
Expand Down
3 changes: 2 additions & 1 deletion examples/basic/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"esModuleInterop": true,
"strict": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
"forceConsistentCasingInFileNames": true,
"outDir": "./dist"
}
}
5 changes: 3 additions & 2 deletions examples/with-bun/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
"type": "module",
"scripts": {
"start": "bun run index.ts",
"dev": "bun --watch run index.ts"
"dev": "bun --watch run index.ts",
"build": "bun build index.ts --outdir ./dist"
},
"dependencies": {
"arkenv": "^0.1.3",
"arkenv": "^0.2.0",
"arktype": "^2.0.4",
"chalk": "^5.4.1"
},
Expand Down
103 changes: 103 additions & 0 deletions examples/with-bun/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
1 change: 1 addition & 0 deletions examples/with-vite-react-ts/.env.development
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_TEST=test-value
1 change: 1 addition & 0 deletions examples/with-vite-react-ts/.env.production
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_TEST=test-value
6 changes: 3 additions & 3 deletions examples/with-vite-react-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
"preview": "vite preview"
},
"dependencies": {
"@arkenv/vite-plugin": "^0.0.2",
"arkenv": "^0.1.4",
"@arkenv/vite-plugin": "^0.0.4",
"arkenv": "^0.2.0",
"arktype": "^2.0.4",
"react": "^19.0.0",
"react-dom": "^19.0.0"
},
"devDependencies": {
"@types/react": "^19.0.8",
"@types/react-dom": "^19.0.3",
"@vitejs/plugin-react": "^4.3.4",
"@vitejs/plugin-react": "^5.0.2",
"globals": "^15.14.0",
"typescript": "~5.7.2",
"vite": "^7.0.0"
Expand Down
4 changes: 0 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{
"name": "arkenv-monorepo",
"private": true,
"workspaces": [
"packages/*",
"apps/*"
],
"scripts": {
"build": "turbo run build",
"build:packages": "turbo run build --filter=./packages/*",
Expand Down
1 change: 1 addition & 0 deletions packages/vite-plugin/.env.test
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_TEST=test-value
7 changes: 5 additions & 2 deletions packages/vite-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@
"arkenv": "workspace:*"
},
"devDependencies": {
"@vitejs/plugin-react": "^5.0.2",
"tsup": "^8.5.0",
"typescript": "^5.9.2"
"typescript": "^5.9.2",
"vite": "^7.0.0",
"vitest": "^3.2.4"
},
"peerDependencies": {
"arktype": "^2.0.0",
"vite": "^6.0.0"
"vite": "^6.0.0 || ^7.0.0"
},
"exports": {
"types": "./dist/index.d.ts",
Expand Down
Loading
Loading