npm - @crypto512/jicon-mcp - Versions diffs - 0.7.0 → 0.7.1 - Mend

@crypto512/jicon-mcp 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md +81 -62
package/dist/utils/content-buffer.d.ts +12 -0
package/dist/utils/content-buffer.d.ts.map +1 -1
package/dist/utils/content-buffer.js +29 -12
package/dist/utils/content-buffer.js.map +1 -1
package/package.json +1 -1
package/CLAUDE.md +0 -947
package/CONTRIBUTING.md +0 -371
package/DEVELOPMENT.md +0 -400
package/JIRA_API_ANALYSIS.md +0 -275

package/CONTRIBUTING.md DELETED Viewed

@@ -1,371 +0,0 @@
-# Contributing to Jicon MCP Server
-Thank you for your interest in contributing to Jicon! This document provides guidelines and instructions for contributing to the project.
-## Table of Contents
-- [Code of Conduct](#code-of-conduct)
-- [Getting Started](#getting-started)
-- [Development Workflow](#development-workflow)
-- [Project Structure](#project-structure)
-- [Coding Standards](#coding-standards)
-- [Testing Guidelines](#testing-guidelines)
-- [Pull Request Process](#pull-request-process)
-- [Release Process](#release-process)
-## Code of Conduct
-By participating in this project, you agree to maintain a respectful and inclusive environment. We expect:
-- **Respectful Communication**: Be kind and considerate in all interactions
-- **Constructive Feedback**: Provide helpful and actionable feedback
-- **Collaboration**: Work together towards common goals
-- **Inclusivity**: Welcome contributors of all backgrounds and skill levels
-## Getting Started
-### Prerequisites
-- **Node.js**: Version 18.0.0 or higher
-- **npm**: Version 8.0.0 or higher
-- **Git**: For version control
-- **TypeScript Knowledge**: Familiarity with TypeScript is helpful
-### Initial Setup
-1. **Fork the Repository**
-   ```bash
-   # Fork on GitHub, then clone your fork
-   git clone https://github.com/YOUR_USERNAME/jicon.git
-   cd jicon
-   ```
-2. **Install Dependencies**
-   ```bash
-   npm install
-   ```
-3. **Build the Project**
-   ```bash
-   npm run build
-   ```
-4. **Run Tests**
-   ```bash
-   npm test
-   ```
-5. **Set Up Environment** (Optional for testing)
-   ```bash
-   cp .env.example .env
-   # Edit .env with your test Jira/Confluence credentials
-   ```
-## Development Workflow
-### Branch Strategy
-- `main` - Production-ready code
-- `develop` - Integration branch for features
-- `feature/*` - New features
-- `fix/*` - Bug fixes
-- `docs/*` - Documentation updates
-### Making Changes
-1. **Create a Branch**
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-2. **Make Your Changes**
-   - Write clear, focused commits
-   - Follow coding standards
-   - Add tests for new functionality
-   - Update documentation as needed
-3. **Run Tests**
-   ```bash
-   npm test
-   npm run lint
-   npm run build
-   ```
-4. **Commit Your Changes**
-   ```bash
-   git add .
-   git commit -m "feat: add new feature description"
-   ```
-### Commit Message Format
-We follow [Conventional Commits](https://www.conventionalcommits.org/):
-```
-<type>(<scope>): <subject>
-<body>
-<footer>
-```
-**Types:**
-- `feat`: New feature
-- `fix`: Bug fix
-- `docs`: Documentation changes
-- `style`: Code style changes (formatting, etc.)
-- `refactor`: Code refactoring
-- `test`: Test additions or modifications
-- `chore`: Build process or auxiliary tool changes
-**Examples:**
-```bash
-feat(jira): add support for custom fields in create issue
-fix(confluence): handle missing page version error
-docs(readme): update configuration examples
-test(jira): add tests for issue transitions
-```
-## Project Structure
-```
-jicon/
-├── src/
-│   ├── index.ts              # MCP server entry point
-│   ├── types.ts              # Common type definitions
-│   ├── jira/
-│   │   ├── client.ts         # Jira API client
-│   │   ├── tools.ts          # Jira MCP tools
-│   │   └── types.ts          # Jira-specific types
-│   ├── confluence/
-│   │   ├── client.ts         # Confluence API client
-│   │   ├── tools.ts          # Confluence MCP tools
-│   │   └── types.ts          # Confluence-specific types
-│   └── utils/
-│       ├── http-client.ts    # HTTP utilities
-│       └── response-formatter.ts
-├── tests/
-│   ├── jira/
-│   ├── confluence/
-│   └── utils/
-├── dist/                     # Compiled JavaScript (gitignored)
-├── node_modules/             # Dependencies (gitignored)
-├── package.json
-├── tsconfig.json
-└── README.md
-```
-## Coding Standards
-### TypeScript Guidelines
-1. **Use Strong Types**
-   ```typescript
-   // Good
-   function getIssue(issueKey: string): Promise<JiraIssue>
-   // Avoid
-   function getIssue(issueKey: any): Promise<any>
-   ```
-2. **Prefer Interfaces for Objects**
-   ```typescript
-   interface IssueData {
-     key: string;
-     summary: string;
-     status: string;
-   }
-   ```
-3. **Use Async/Await**
-   ```typescript
-   // Good
-   async function fetchData() {
-     const result = await client.getData();
-     return result;
-   }
-   // Avoid
-   function fetchData() {
-     return client.getData().then(result => result);
-   }
-   ```
-4. **Error Handling**
-   ```typescript
-   try {
-     const result = await client.getIssue(key);
-     return formatSuccess(result);
-   } catch (error) {
-     return formatError(isApiError(error) ? error : new Error(String(error)));
-   }
-   ```
-### Code Style
-- **Indentation**: 2 spaces
-- **Quotes**: Double quotes for strings
-- **Semicolons**: Required
-- **Line Length**: Maximum 100 characters (flexible)
-- **Naming**:
-  - `camelCase` for variables and functions
-  - `PascalCase` for classes and types
-  - `UPPER_CASE` for constants
-### Documentation
-- Add JSDoc comments for public APIs
-- Document complex logic with inline comments
-- Update README.md for user-facing changes
-- Update CLAUDE.md for specification changes
-**Example:**
-```typescript
-/**
- * Search for Jira issues using JQL
- * @param jql - Jira Query Language string
- * @param maxResults - Maximum number of results (default: 50)
- * @param fields - Optional array of fields to return
- * @returns Promise resolving to search results
- */
-async searchIssues(
-  jql: string,
-  maxResults: number = 50,
-  fields?: string[]
-): Promise<JiraSearchResult>
-```
-## Testing Guidelines
-### Test Structure
-- **Unit Tests**: Test individual functions/methods
-- **Integration Tests**: Test component interactions
-- **E2E Tests**: Test complete workflows (planned)
-### Writing Tests
-1. **Test File Naming**: `*.test.ts`
-2. **Use Descriptive Names**:
-   ```typescript
-   describe("JiraClient", () => {
-     describe("searchIssues", () => {
-       it("should return issues matching JQL query", () => {
-         // Test implementation
-       });
-       it("should handle empty results", () => {
-         // Test implementation
-       });
-     });
-   });
-   ```
-3. **Test Both Success and Error Cases**
-4. **Keep Tests Fast and Isolated**
-5. **Mock External Dependencies**
-### Running Tests
-```bash
-# Run all tests
-npm test
-# Run specific test file
-node --test tests/jira/client.test.ts
-# Run with verbose output
-node --test --test-reporter=spec
-```
-## Pull Request Process
-### Before Submitting
-1. ✅ All tests pass (`npm test`)
-2. ✅ Code builds successfully (`npm run build`)
-3. ✅ Code follows style guidelines
-4. ✅ Documentation is updated
-5. ✅ Commit messages follow conventions
-6. ✅ No sensitive data (credentials, tokens) in code
-### Submitting a Pull Request
-1. **Push to Your Fork**
-   ```bash
-   git push origin feature/your-feature-name
-   ```
-2. **Create Pull Request**
-   - Go to the original repository on GitHub
-   - Click "New Pull Request"
-   - Select your fork and branch
-   - Fill out the PR template
-3. **PR Description Should Include**:
-   - Summary of changes
-   - Related issue numbers (if applicable)
-   - Testing performed
-   - Screenshots (for UI changes)
-   - Breaking changes (if any)
-### PR Review Process
-1. **Automated Checks**: CI/CD runs tests and linting
-2. **Code Review**: Maintainers review your code
-3. **Feedback**: Address requested changes
-4. **Approval**: Once approved, PR will be merged
-## Release Process
-Releases are managed by maintainers following semantic versioning:
-- **Major** (1.0.0): Breaking changes
-- **Minor** (0.1.0): New features, backward compatible
-- **Patch** (0.0.1): Bug fixes, backward compatible
-## Areas for Contribution
-### High Priority
-- [ ] Add more comprehensive unit tests
-- [ ] Implement integration tests with mock APIs
-- [ ] Add rate limiting implementation
-- [ ] Implement caching layer
-- [ ] Improve error messages
-### Medium Priority
-- [ ] Add bulk operations support
-- [ ] Custom field templates
-- [ ] Better TypeScript type inference
-- [ ] Performance optimizations
-- [ ] Documentation improvements
-### Low Priority
-- [ ] Webhook support
-- [ ] Multi-instance configuration
-- [ ] CLI tool for testing
-- [ ] Web UI for configuration
-## Getting Help
-- **Issues**: Open an issue for bugs or feature requests
-- **Discussions**: Use GitHub Discussions for questions
-- **Documentation**: Check README.md and CLAUDE.md
-## Recognition
-All contributors will be:
-- Listed in the repository contributors page
-- Mentioned in release notes (for significant contributions)
-- Credited in the AUTHORS file (coming soon)
-## License
-By contributing, you agree that your contributions will be licensed under the MIT License.
----
-**Thank you for contributing to Jicon! Your efforts help make this project better for everyone.** 🎉