chore: update package version to 1.2.5 and add Jest testing framework

- Bump version in package.json and package-lock.json from 1.2.2 to 1.2.5
- Add Jest configuration file for testing
- Update build scripts to use npm instead of bun
- Add linting and testing scripts to package.json
- Include tsconfig files in package.json files array
This commit is contained in:
Siwat Sirichai 2025-08-20 17:08:39 +07:00
parent 180249be26
commit ad1424a79a
6 changed files with 54 additions and 638 deletions

View file

@ -8,34 +8,31 @@ This is **@siwatsystem/mxrelay-consumer**, a TypeScript client library for SMTP
## Development Commands
**This project uses Bun as the primary runtime and package manager. TypeScript files can be run directly without building.**
**This project uses Node.js as the primary runtime with npm as the package manager.**
### Build Commands
- `bun run build` - Build all formats (CommonJS, ESM, and type declarations)
- `bun run build:cjs` - Build CommonJS format only
- `bun run build:esm` - Build ES modules format only
- `bun run build:types` - Build TypeScript declarations only
- `bun run dev` - Watch mode for development
- `bun run clean` - Remove build artifacts
- `npm run build` - Build all formats (CommonJS, ESM, and type declarations)
- `npm run build:cjs` - Build CommonJS format only
- `npm run build:esm` - Build ES modules format only
- `npm run build:types` - Build TypeScript declarations only
- `npm run clean` - Remove build artifacts
### Testing Commands
- `bun test` - Run all tests
- `bun run test:watch` - Run tests in watch mode
- `bun run test:coverage` - Run tests with coverage report
- `npm test` - Run all tests
- `npm run test:watch` - Run tests in watch mode
- `npm run test:coverage` - Run tests with coverage report
### Code Quality Commands
- `bun run lint` - Lint TypeScript files
- `bun run lint:fix` - Lint and auto-fix issues
- `bun run format` - Format code with Prettier
- `npm run lint` - Lint TypeScript files
- `npm run lint:fix` - Lint and auto-fix issues
- `npm run format` - Format code with Prettier
### Example Commands
- `bun run examples/nodemailer-transport.ts` - Run Nodemailer transport example directly
- `bun run example:basic` - Run basic usage example
- `bun run example:queue` - Run queue management example
- `npm run example:basic` - Run basic usage example
- `npm run example:queue` - Run queue management example
### Running TypeScript Directly
- `bun run src/index.ts` - Run source files directly without building
- `bun run examples/any-example.ts` - Run any example file directly
- Use `npx ts-node` to run TypeScript files directly during development
## Architecture