Skip to content

Commit 3762306

Browse files
authored
chore: release v0.1.4 with comprehensive test coverage and enhanced error messages (#19)
* chore: release v0.1.4 with comprehensive test coverage and enhanced error messages * Added 26 new tests, increasing overall code coverage from ~78% to ~86%, with a focus on cache cleanup, parameter validation, and error handling. * Improved error messages across all MCP tools to provide actionable guidance and context for users. * Fixed version inconsistencies in documentation and codebase to ensure alignment with package.json version 0.1.4. * Introduced a Code of Conduct to promote a respectful and inclusive community environment. * Added a roadmap for future enhancements and features to guide project development.
1 parent d10e787 commit 3762306

21 files changed

+1283
-73
lines changed

CHANGELOG.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,58 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.1.4] - 2026-01-14
9+
10+
### Added
11+
12+
- **Comprehensive Test Coverage** - Added 26 new tests significantly improving code coverage
13+
- **Coverage Improvements**: Overall coverage increased from ~78% to ~86% (statements, branches, lines)
14+
- **Cache Cleanup Tests** (10 tests) - Added tests for cache corruption detection, stale path detection, and cleanup logic
15+
- Tests for corrupted cache detection (invalid JSON in `context_main.json`)
16+
- Tests for stale cache detection (mismatched project paths in config files)
17+
- Tests for valid cache preservation and explicit cleanup
18+
- **Parameter Validation Tests** (7 tests) - Added comprehensive validation tests for `depth` parameter
19+
- Invalid depth values (non-integer, zero, negative)
20+
- Valid depth values (1, 3, default 2)
21+
- String-to-number conversion handling
22+
- **Error Code Preservation Tests** (4 tests) - Added tests ensuring error information is properly preserved
23+
- Error code preservation from exec errors
24+
- stdout/stderr preservation in error objects
25+
- ENOENT error handling for missing files
26+
- **Server Error Handling Tests** (4 tests) - Added tests for server-level error handling
27+
- Tool execution error wrapping in MCP format
28+
- Non-Error exception handling
29+
- Graceful error handling for all tools
30+
- **Documentation Error Handling Tests** (2 tests) - Added tests for error message structure and consistency
31+
- **File Coverage Improvements**:
32+
- `compare-modes.ts`: 60% → ~95% statements (+35%)
33+
- `refresh-snapshot.ts`: ~67% → ~96% statements (+29%)
34+
- Total test count: 163 → 189 tests (+26 tests)
35+
- All tests passing with improved confidence in error handling and edge cases
36+
37+
- **Enhanced Error Messages** - Improved error messages throughout all MCP tools to be more actionable and helpful
38+
- All error messages now include context about what was attempted and why it failed
39+
- Added suggestions for common errors (e.g., "Run logicstamp_refresh_snapshot first" when snapshot is missing)
40+
- Included relevant file paths and next steps in error messages
41+
- Error messages now guide users toward solutions instead of just reporting failures
42+
- Enhanced messages in: `logicstamp_refresh_snapshot`, `logicstamp_list_bundles`, `logicstamp_read_bundle`, `logicstamp_compare_snapshot`, `logicstamp_compare_modes`, `logicstamp_read_logicstamp_docs`
43+
- Example improvement: "context_main.json not found" → "context_main.json not found in /path/to/project. This file is required for comparison but hasn't been generated yet. Options: (1) Run logicstamp_refresh_snapshot first to generate context files, (2) Use forceRegenerate: true in this call to regenerate automatically before comparing, (3) Run 'stamp context' manually from the project directory."
44+
45+
- **Code of Conduct** - Added Contributor Covenant Code of Conduct to establish community standards and promote a respectful, inclusive environment
46+
- Available at [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
47+
48+
- **Roadmap** - Added roadmap document outlining planned enhancements and future features to guide project development
49+
- Available at [`ROADMAP.md`](ROADMAP.md)
50+
51+
### Fixed
52+
53+
- **Version Consistency** - Fixed version mismatches across codebase to ensure all version references match `package.json`
54+
- **README.md** - Updated version badge from `0.1.2` to `0.1.4`
55+
- **src/mcp/server.ts** - Updated server version from `0.1.2` to `0.1.4` (was incorrectly `0.1.2` for version `0.1.3`)
56+
- **docs/mcp_integration.md** - Updated example config version from `0.1.2` to `0.1.4`
57+
- All version references now consistently match `package.json` version `0.1.4`
58+
- Prevents confusion when users check version information across different sources
59+
860
## [0.1.3] - 2026-01-13
961

1062
### Changed
@@ -170,6 +222,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
170222
- Requires `logicstamp-context` CLI to be installed globally (`npm install -g logicstamp-context`)
171223
- All tools are read-only - they analyze but never modify your codebase
172224

225+
[0.1.4]: https://github.com/LogicStamp/logicstamp-mcp/releases/tag/v0.1.4
226+
173227
[0.1.3]: https://github.com/LogicStamp/logicstamp-mcp/releases/tag/v0.1.3
174228

175229
[0.1.2]: https://github.com/LogicStamp/logicstamp-mcp/releases/tag/v0.1.2

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We commit to acting in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Scope
10+
11+
This Code of Conduct applies to all official community spaces (GitHub issues, pull requests, discussions) and when officially representing the community in public spaces.
12+
13+
## Enforcement
14+
15+
The project maintainer(s) are responsible for enforcing these standards, and additional moderators may be designated as the project grows.
16+
They may remove, edit, or reject contributions that violate this Code of Conduct and will communicate moderation decisions when appropriate.
17+
18+
**Reporting:** Report violations to logicstamp.dev@gmail.com. All complaints will be reviewed promptly and fairly. Reporter privacy will be respected.
19+
20+
**Enforcement Guidelines:**
21+
22+
1. **Correction** - Inappropriate language or unprofessional behavior
23+
- Private written warning with explanation; public apology may be requested
24+
25+
2. **Warning** - Single incident or series of violations
26+
- Warning with consequences; no interaction with involved parties for a specified period; violation may lead to ban
27+
28+
3. **Temporary Ban** - Serious or sustained violations
29+
- Temporary ban from all community interaction; no contact with involved parties; violation may lead to permanent ban
30+
31+
4. **Permanent Ban** - Pattern of violations, harassment, or aggression toward individuals or groups
32+
- Permanent ban from all community interaction
33+
34+
## Attribution
35+
36+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
37+
38+
Enforcement guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
39+
40+
For answers to common questions, see [https://www.contributor-covenant.org/faq][FAQ].
41+
42+
[homepage]: https://www.contributor-covenant.org
43+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
44+
[Mozilla CoC]: https://github.com/mozilla/diversity
45+
[FAQ]: https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Thank you for your interest in contributing! This guide will help you get started.
44

5+
## Code of Conduct
6+
7+
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to logicstamp.dev@gmail.com.
8+
59
## Development Setup
610

711
### Prerequisites
@@ -199,7 +203,7 @@ If you already ran `npm link` during installation (see [Installation](#installat
199203
2. **Verify it's linked:**
200204
```bash
201205
npm list -g logicstamp-mcp
202-
# Should show: logicstamp-mcp@0.1.2 -> /path/to/logicstamp-mcp
206+
# Should show: logicstamp-mcp@0.1.4 -> /path/to/logicstamp-mcp
203207
```
204208

205209
3. **Your MCP clients will automatically use the local version** if they're configured with `npx logicstamp-mcp` (which is the standard configuration). No additional configuration needed!
@@ -415,9 +419,6 @@ When adding features, update:
415419
- Configuration file support
416420
- Multiple project support
417421

418-
## Code of Conduct
419-
420-
Be respectful, inclusive, and constructive in all interactions.
421422

422423
## License
423424

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<br/>
88

9-
![Version](https://img.shields.io/badge/version-0.1.2-blue.svg) ![Beta](https://img.shields.io/badge/status-beta-orange.svg) ![License](https://img.shields.io/badge/license-MIT-green.svg) ![Node](https://img.shields.io/badge/node-%3E%3D18.18.0-brightgreen.svg) [![CI](https://github.com/LogicStamp/logicstamp-mcp/workflows/CI/badge.svg)](https://github.com/LogicStamp/logicstamp-mcp/actions)
9+
![Version](https://img.shields.io/badge/version-0.1.4-blue.svg) ![Beta](https://img.shields.io/badge/status-beta-orange.svg) ![License](https://img.shields.io/badge/license-MIT-green.svg) ![Node](https://img.shields.io/badge/node-%3E%3D18.18.0-brightgreen.svg) [![CI](https://github.com/LogicStamp/logicstamp-mcp/workflows/CI/badge.svg)](https://github.com/LogicStamp/logicstamp-mcp/actions)
1010

1111
<br/>
1212

@@ -300,10 +300,18 @@ These assets may not be used for third-party branding, logos, or commercial iden
300300

301301
Contributions welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
302302

303+
## Community
304+
305+
This project follows a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
306+
303307
## Changelog
304308

305309
See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes and version history.
306310

311+
## Roadmap
312+
313+
See [ROADMAP.md](ROADMAP.md) for planned enhancements and future features.
314+
307315
## Links
308316

309317
- [LogicStamp](https://logicstamp.dev) - Official website and documentation

0 commit comments

Comments
 (0)