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

Binary file not shown.

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

68
.serena/project.yml Normal file
View File

@@ -0,0 +1,68 @@
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
# * For C, use cpp
# * For JavaScript, use typescript
# Special requirements:
# * csharp: Requires the presence of a .sln file in the project folder.
language: typescript
# whether to use the project's gitignore file to ignore files
# Added on 2025-04-07
ignore_all_files_in_gitignore: true
# list of additional paths to ignore
# same syntax as gitignore, so you can use * and **
# Was previously called `ignored_dirs`, please update your config if you are using that.
# Added (renamed) on 2025-04-07
ignored_paths: []
# whether the project is in read-only mode
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
# Added on 2025-04-18
read_only: false
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
# Below is the complete list of tools for convenience.
# To make sure you have the latest list of tools, and to view their descriptions,
# execute `uv run scripts/print_tool_overview.py`.
#
# * `activate_project`: Activates a project by name.
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
# * `create_text_file`: Creates/overwrites a file in the project directory.
# * `delete_lines`: Deletes a range of lines within a file.
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
# * `execute_shell_command`: Executes a shell command.
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
# * `initial_instructions`: Gets the initial instructions for the current project.
# Should only be used in settings where the system prompt cannot be set,
# e.g. in clients you have no control over, like Claude Desktop.
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
# * `insert_at_line`: Inserts content at a given line in a file.
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
# * `list_memories`: Lists memories in Serena's project-specific memory store.
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
# * `read_file`: Reads a file within the project directory.
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
# * `remove_project`: Removes a project from the Serena configuration.
# * `replace_lines`: Replaces a range of lines within a file with new content.
# * `replace_symbol_body`: Replaces the full definition of a symbol.
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
# * `search_for_pattern`: Performs a search for a pattern in the project.
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
# * `switch_modes`: Activates modes by providing a list of their names
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
excluded_tools: []
# initial prompt for the project. It will always be given to the LLM upon activating the project
# (contrary to the memories, which are loaded on demand).
initial_prompt: ""
project_name: "smartantivirus"