 |
VOOZH | about |
|
VOOZH | about |
This page documents the development dependencies used in the simap-mcp project. These are tools and libraries required during development but not included in the production runtime. For runtime dependencies (production dependencies used when the server executes), see 7.1 Runtime Dependencies.
The project utilizes a modern TypeScript development stack centered around tsc for compilation, eslint for code quality, prettier for formatting, and vitest for testing. These dependencies ensure type safety, consistent style, and functional correctness before the code is transpiled to JavaScript for distribution. As of v1.3.0, the development environment is optimized for Node.js >=22.
Sources: package.json47-49 package.json58-68
| Package | Version | Purpose |
|---|---|---|
typescript | ^6.0.3 | TypeScript compiler for transpiling .ts source to JavaScript |
@types/node | ^25.9.1 | TypeScript type definitions for Node.js built-in modules |
eslint | ^10.4.0 | Core linting engine for identifying code quality issues |
@eslint/js | ^10.0.1 | ESLint's JavaScript configuration and rules |
typescript-eslint | ^8.59.4 | TypeScript-specific ESLint rules and parser |
prettier | ^3.8.3 | Code formatter for consistent style |
vitest | ^4.1.7 | Testing framework with native ESM and TypeScript support |
@changesets/cli | ^2.31.0 | Tool for managing versioning and changelogs |
Sources: package.json58-68
The following diagram illustrates how development dependencies interact during the local development lifecycle, from writing code to generating the distribution build.
Development Toolchain Flow
Sources: package.json11-27 tsconfig.json1-17
The project uses TypeScript 6.0.3. The configuration is optimized for modern Node.js environments using ECMAScript Modules (ESM).
tsconfig.json)The tsconfig.json file defines the transformation from src/ to dist/. Key settings include:
ES2023 for modern syntax support tsconfig.json3NodeNext to support native ESM resolution tsconfig.json4-5"strict": true) to enforce maximum type safety tsconfig.json8./dist directory tsconfig.json6./src tsconfig.json7declaration: true ensures .d.ts files are generated for consumers tsconfig.json12Sources: tsconfig.json1-17 package.json65
The project uses the "Flat Config" format (eslint.config.js). It combines the recommended JavaScript rules from @eslint/js with the recommended TypeScript rules from typescript-eslint.
Custom Rule Implementation:
_) eslint.config.js9-12off to allow TypeScript inference eslint.config.js13any to encourage specific typing eslint.config.js14dist/ and node_modules/ directories are excluded from linting eslint.config.js18Sources: eslint.config.js1-20 package.json61-66
Formatting is controlled via CLI arguments in package.json scripts. The project uses prettier ^3.8.3 package.json64
format runs prettier --write src/ and format:check runs prettier --check src/ package.json17-18Sources: package.json17-18 package.json64
Vitest 4.1.7 is the chosen test runner. It is configured to run in the src/ directory and respects the project's ESM configuration.
Execution Modes:
npm test executes vitest run for CI environments package.json20npm run test:watch executes vitest for interactive local development package.json21Sources: package.json67 package.json20-21
The project uses @changesets/cli to manage versioning and the automated generation of changelogs.
npm run changeset allows developers to document changes package.json24npm run version-packages applies changesets, updates the version, and syncs internal metadata package.json25npm run release uses changeset publish to push the package to the registry package.json26Sources: package.json24-26 package.json59-60
This diagram maps the high-level development tasks to the specific underlying tools and configurations defined in the codebase.
Task to Tool Mapping
Sources: package.json11-27 tsconfig.json1-17 eslint.config.js1-20
| Script | Command | Description |
|---|---|---|
build | tsc | Transpiles TypeScript to JavaScript in dist/ package.json12 |
start | node dist/index.js | Runs the compiled server package.json13 |
dev | npm run build && npm start | Rebuilds and starts the server for local testing package.json14 |
lint | eslint src/ | Runs static analysis on source files package.json15 |
lint:fix | eslint src/ --fix | Automatically fixes repairable linting issues package.json16 |
format | prettier --write src/ | Rewrites source files to match style guide package.json17 |
format:check | prettier --check src/ | Validates formatting without modifying files package.json18 |
typecheck | tsc --noEmit | Runs the compiler's type checker without generating files package.json19 |
test | vitest run | Executes the test suite once package.json20 |
test:watch | vitest | Runs tests in interactive watch mode package.json21 |
update:check | npx npm-check-updates --target semver | Checks for available dependency updates package.json22 |
changeset | changeset | Creates a new changeset for versioning package.json24 |
release | changeset publish | Publishes the package to npm package.json26 |
prepublishOnly | npm run build | Lifecycle hook ensuring a fresh build before npm publication package.json27 |
Sources: package.json11-27
Refresh this wiki