fix(build): Bump dependencies, improve test/build scripts, expand documentation and add project metadata

This commit is contained in:
2025-08-16 20:37:58 +00:00
parent a810338cc4
commit a8c36a64b7
12 changed files with 3447 additions and 2223 deletions

View File

@@ -0,0 +1,35 @@
# Code Style and Conventions
## Naming Conventions
- **Interfaces**: Prefix with `I` (e.g., `IUserData`)
- **Types**: Prefix with `T` (e.g., `TResponseType`)
- **Files**: Always lowercase (e.g., `classes.clamavservice.ts`)
- **Classes**: PascalCase (e.g., `ClamAvService`)
- **Methods/Functions**: camelCase (e.g., `scanBuffer`)
- Avoid ENums when possible
## TypeScript Patterns
- TypeScript-first approach with full type safety
- ES modules (type: "module" in package.json)
- Import dependencies in `ts/plugins.ts`
- Reference with full path: `plugins.myModule.myClass()`
## File Organization
- Source code in `ts/` directory
- Tests in `test/` directory
- Distribution in `dist_ts/` directory
- Use `.js` extensions in imports for ES modules
## Testing Patterns
- Use @git.zone/tstest framework
- Import expect from @push.rocks/tapbundle
- Test files end with `export default tap.start()`
- Test naming: `*.both.ts`, `*.node.ts`, `*.browser.ts`
- EICAR test string for antivirus verification
## General Principles
- Make RAZOR SHARP changes - every modification must be goal-oriented
- Improve elegance - changes should enhance clarity and maintainability
- Preserve necessary complexity - don't oversimplify
- Keep async patterns - maintain Promises where they add value
- Remove redundancy carefully while preserving functionality

View File

@@ -0,0 +1,31 @@
# SmartAntivirus Project Overview
## Purpose
SmartAntivirus (@push.rocks/smartantivirus) is a Node.js/TypeScript library that provides enterprise-grade antivirus scanning capabilities by integrating with ClamAV. It allows developers to scan files, buffers, strings, and streams for viruses in their applications.
## Tech Stack
- TypeScript (primary language)
- Node.js (runtime)
- ClamAV (antivirus engine)
- Docker (for containerized ClamAV deployment)
- Testing: @git.zone/tstest with @push.rocks/tapbundle
- Build: @git.zone/tsbuild
## Architecture
- **ClamAvService**: High-level interface for virus scanning operations
- Scan strings, buffers, Node.js streams, and Web Streams
- Auto-manages Docker container if needed
- Connects to ClamAV daemon on port 3310
- **ClamAVManager**: Low-level Docker container management
- Handles container lifecycle (start/stop)
- Updates virus definitions
- Provides log monitoring
## Key Features
- In-memory scanning without disk I/O
- Stream processing for large files
- TypeScript-first with full type safety
- Zero-config with sensible defaults
- Auto-updating virus definitions
- Docker-based or direct daemon connection

View File

@@ -0,0 +1,31 @@
# Suggested Commands for SmartAntivirus Development
## Build & Test Commands
- `pnpm test` - Run test suite with tapbundle
- `pnpm build` - Build TypeScript to JavaScript (uses tsbuild)
- `pnpm run buildDocs` - Generate documentation (tsdoc)
## Development Tools
- `tsbuild check test/**/* --skiplibcheck` - Type-check test files
- `tsx test/test.ts` - Run individual test file directly
## Version Control
- `git mv <old> <new>` - Move/rename files preserving history
- `git status` - Check current changes
- `git diff` - View uncommitted changes
## Package Management
- `pnpm install` - Install dependencies
- `pnpm install --save-dev <package>` - Add dev dependency
- `pnpm add <package>` - Add production dependency
## File Operations
- `ls` - List directory contents
- `cat <file>` - View file contents
- `find . -name "*.ts"` - Find TypeScript files
- `rg <pattern>` - Search codebase with ripgrep
## Docker Management (if testing locally)
- `docker ps` - List running containers
- `docker logs clamav` - View ClamAV container logs
- `docker stop clamav` - Stop ClamAV container

View File

@@ -0,0 +1,44 @@
# Task Completion Workflow
## Required Steps After Making Code Changes
1. **Build the Project**
```bash
pnpm build
```
Ensures TypeScript compiles without errors
2. **Run Tests**
```bash
pnpm test
```
Verifies functionality with test suite
3. **Type Check Test Files** (if tests were modified)
```bash
tsbuild check test/**/* --skiplibcheck
```
## Quality Checks
- Verify no TypeScript compilation errors
- Ensure all tests pass
- Check that new code follows existing patterns
- Verify imports use `.js` extensions for ES modules
- Confirm no hardcoded values that should be configurable
## Documentation Updates
- Update readme.md if API changes
- Add JSDoc comments for new public methods
- Update changelog.md for version changes
## Before Committing
- NEVER commit without explicit user approval
- Use `git status` to review changes
- Use `git diff` to verify modifications
- Create focused commits with clear messages
- Never commit secrets or API keys
## Important Notes
- The project uses pnpm exclusively (not npm or yarn)
- Always read documentation before using unfamiliar APIs
- Check existing code patterns before implementing new features