fix(qenv): Improve documentation, update dependencies, and refine project configuration

This commit is contained in:
2025-08-14 07:20:05 +00:00
parent 7b34ef8453
commit 88bed685bc
11 changed files with 3818 additions and 3208 deletions

View File

@@ -0,0 +1,38 @@
# Code Style and Conventions
## TypeScript Conventions
- Use TypeScript with ES modules (type: "module" in package.json)
- All files use `.js` extensions in imports (even for .ts files)
- Interfaces prefixed with `I` (e.g., `IUserData`)
- Types prefixed with `T` (e.g., `TEnvVarRef`)
- Filenames must be lowercase
- Avoid ENUMs when possible
## File Organization
- Source code in `ts/` directory
- Tests in `test/` directory
- Plugin imports in `ts/qenv.plugins.ts`
- Main exports in `ts/index.ts`
- Class files named as `qenv.classes.<classname>.ts`
## Import Style
- Import all dependencies in plugins file
- Reference as `plugins.moduleName.method()`
- Use full import paths with .js extension
- Group imports: external packages, then internal modules
## Testing
- Use @git.zone/tstest framework
- Import expect from tapbundle: `import { tap, expect } from '@git.zone/tstest/tapbundle'`
- Test files end with `export default tap.start()` (tstest pattern)
- Test file naming: `*.both.ts`, `*.node.ts`, or `*.browser.ts`
## Documentation
- Keep comments minimal unless specifically requested
- README should be lowercase: `readme.md`
- Documentation should be engaging and use emojis where appropriate
## Git Conventions
- Small, focused commits
- Use `git mv` for file operations
- Never commit without running tests and type checks

View File

@@ -0,0 +1,37 @@
# Qenv Project Overview
## Purpose
@push.rocks/qenv is a TypeScript/Node.js module for managing environment variables in Node.js projects. It provides a unified interface for loading environment variables from multiple sources:
- Process environment variables
- YAML configuration files (.yml/.yaml)
- JSON configuration files (.json)
- Docker secrets
- Dynamic/async variable resolution via functions
## Key Features
- Support for required and optional environment variables
- Multi-source loading hierarchy (env vars > config files > Docker secrets)
- Base64-encoded object support for complex configurations
- Synchronous and asynchronous variable retrieval
- Strict mode with error throwing for unset variables
- TypeScript with full type definitions
- Logging via @push.rocks/smartlog
## Main Components
- `Qenv` class: Core class for environment variable management
- `CloudlyAdapter`: Configuration vault integration
- Support for `qenv.yml` (required vars definition) and `env.yml`/`env.json` (values)
## Tech Stack
- TypeScript
- Node.js
- pnpm package manager
- @push.rocks ecosystem libraries (smartfile, smartlog, smartpath)
- @git.zone tools for building and testing
## Dependencies
- @api.global/typedrequest
- @configvault.io/interfaces
- @push.rocks/smartfile
- @push.rocks/smartlog
- @push.rocks/smartpath

View File

@@ -0,0 +1,30 @@
# Suggested Commands for Qenv Development
## Build & Test Commands
- `pnpm test` - Run tests with tstest
- `pnpm build` - Build the project with tsbuild (includes --web --allowimplicitany flags)
- `pnpm buildDocs` - Generate documentation with tsdoc
## Development Tools
- `tsx <file>` - Execute TypeScript files directly (globally available)
- `tstest test/test.some.ts --verbose` - Run specific test file with verbose output
## Package Management
- `pnpm install` - Install dependencies
- `pnpm install --save-dev <package>` - Add development dependency
- `pnpm install <package>` - Add production dependency
## Git Operations
- `git mv <old> <new>` - Move/rename files preserving history
- `git status` - Check current repository status
- `git diff` - View uncommitted changes
## Type Checking
- `tsbuild check test/**/* --skiplibcheck` - Type check test files
- `pnpm run build` - Type check and build module files
## System Commands (Linux)
- `ls` - List files
- `find . -name "pattern"` - Find files by pattern
- `rg "pattern"` - Search file contents (ripgrep)
- `curl` - Make HTTP requests for testing/debugging

View File

@@ -0,0 +1,32 @@
# Task Completion Checklist
When completing any development task in the qenv project, follow these steps:
## Pre-Commit Checks
1. **Run Tests**: `pnpm test`
- Ensure all tests pass
- Add new tests for new functionality
2. **Type Checking**: `pnpm run build`
- Verify no TypeScript errors
- Check that build output is generated correctly
3. **Code Quality**:
- Verify code follows project conventions
- Ensure no console.log statements left in production code
- Check imports use proper .js extensions
## Documentation Updates
- Update README.md if API changes
- Update changelog.md for notable changes
- Ensure JSDoc comments for public APIs
## Final Verification
- Review changes with `git diff`
- Test the module can be imported correctly
- Verify no breaking changes to public API
## Important Notes
- NEVER commit without explicit user approval
- Always run tests and build before suggesting commit
- If lint/typecheck commands unknown, ask user and update CLAUDE.md