@grunnverk/kilde 0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,438 @@
+# Contributing to Kilde
+
+Thank you for your interest in contributing to Kilde! This document provides guidelines and instructions for contributing.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Testing](#testing)
+- [Documentation](#documentation)
+- [Submitting Changes](#submitting-changes)
+- [Release Process](#release-process)
+
+## Code of Conduct
+
+### Our Standards
+
+- Be respectful and inclusive
+- Welcome newcomers and help them learn
+- Focus on what is best for the community
+- Show empathy towards other community members
+
+### Unacceptable Behavior
+
+- Harassment, trolling, or discriminatory language
+- Publishing others' private information
+- Other conduct which could reasonably be considered inappropriate
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 24.0.0 or higher
+- Git 2.0 or higher
+- npm 10.0 or higher
+- OpenAI API key for testing
+
+### Finding Issues
+
+Good places to start:
+
+- [Issues labeled "good first issue"](https://github.com/grunnverk/kilde/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+- [Issues labeled "help wanted"](https://github.com/grunnverk/kilde/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+- Documentation improvements
+- Test coverage improvements
+
+## Development Setup
+
+### 1. Fork and Clone
+
+```bash
+# Fork the repository on GitHub, then clone your fork
+git clone https://github.com/YOUR_USERNAME/kilde.git
+cd kilde
+
+# Add upstream remote
+git remote add upstream https://github.com/grunnverk/kilde.git
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+```
+
+### 3. Set Up Environment
+
+Create a `.env` file in the project root:
+
+```bash
+OPENAI_API_KEY=sk-your-api-key-here
+```
+
+### 4. Build the Project
+
+```bash
+npm run build
+```
+
+### 5. Run Tests
+
+```bash
+npm test
+```
+
+### 6. Development Mode
+
+For active development with auto-rebuild:
+
+```bash
+npm run watch
+```
+
+## Project Structure
+
+```
+kilde/
+├── src/
+│   ├── commands/          # Command implementations
+│   │   └── release.ts     # Release notes command
+│   ├── mcp/              # MCP server implementation
+│   │   ├── server.ts     # MCP server
+│   │   ├── tools.ts      # MCP tools
+│   │   ├── resources.ts  # MCP resources
+│   │   └── prompts/      # MCP prompts
+│   ├── utils/            # Utility functions
+│   │   └── config.ts     # Configuration handling
+│   ├── application.ts    # CLI application
+│   ├── constants.ts      # Constants and defaults
+│   ├── logging.ts        # Logging setup
+│   ├── main.ts          # Entry point
+│   └── types.ts         # TypeScript types
+├── tests/                # Test files
+│   ├── mcp/             # MCP tests
+│   ├── utils/           # Utility tests
+│   └── *.test.ts        # Other tests
+├── docs/                # Documentation
+├── scripts/             # Build scripts
+└── dist/                # Build output
+```
+
+## Making Changes
+
+### 1. Create a Branch
+
+```bash
+# Update your fork
+git fetch upstream
+git checkout main
+git merge upstream/main
+
+# Create a feature branch
+git checkout -b feature/your-feature-name
+```
+
+### Branch Naming
+
+- `feature/` - New features
+- `fix/` - Bug fixes
+- `docs/` - Documentation changes
+- `test/` - Test improvements
+- `refactor/` - Code refactoring
+
+### 2. Make Your Changes
+
+Follow these guidelines:
+
+#### Code Style
+
+- Use TypeScript strict mode
+- Follow existing code patterns
+- Use meaningful variable names
+- Add JSDoc comments for public APIs
+- Keep functions small and focused
+
+#### Example
+
+```typescript
+/**
+ * Load configuration from file system
+ * @param cwd - Working directory to search from
+ * @returns Loaded configuration or null if not found
+ */
+export async function loadConfig(cwd: string = process.cwd()): Promise<Config | null> {
+    // Implementation
+}
+```
+
+#### Imports
+
+```typescript
+// External imports first
+import { Command } from 'commander';
+import winston from 'winston';
+
+// Internal imports second
+import { Config } from '@grunnverk/core';
+import { getLogger } from './logging';
+
+// Relative imports last
+import { loadConfig } from './utils/config';
+```
+
+#### Error Handling
+
+```typescript
+try {
+    const result = await someOperation();
+    return result;
+} catch (error: any) {
+    logger.error(`Operation failed: ${error.message}`);
+    throw error;
+}
+```
+
+### 3. Write Tests
+
+All new code must include tests:
+
+```typescript
+import { describe, it, expect } from 'vitest';
+
+describe('myFunction', () => {
+    it('should do something correctly', () => {
+        const result = myFunction('input');
+        expect(result).toBe('expected output');
+    });
+
+    it('should handle edge cases', () => {
+        expect(() => myFunction(null)).toThrow();
+    });
+});
+```
+
+### 4. Update Documentation
+
+- Update README.md if adding features
+- Add JSDoc comments to new functions
+- Update AI_GUIDE.md for MCP changes
+- Create examples for new functionality
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage
+npm test -- --coverage
+
+# Run specific test file
+npm test tests/utils/config.test.ts
+```
+
+### Coverage Requirements
+
+- Statements: 70%
+- Branches: 70%
+- Functions: 70%
+- Lines: 70%
+
+### Writing Good Tests
+
+1. **Test Behavior, Not Implementation**
+   ```typescript
+   // Good
+   it('should return configuration from file', async () => {
+       const config = await loadConfig();
+       expect(config.verbose).toBeDefined();
+   });
+
+   // Avoid
+   it('should call fs.readFile with correct path', async () => {
+       await loadConfig();
+       expect(mockReadFile).toHaveBeenCalledWith('/path');
+   });
+   ```
+
+2. **Use Descriptive Test Names**
+   ```typescript
+   // Good
+   it('should return null when no config file exists', async () => {});
+
+   // Avoid
+   it('works correctly', async () => {});
+   ```
+
+3. **Test Edge Cases**
+   ```typescript
+   describe('loadConfig', () => {
+       it('should handle missing file');
+       it('should handle malformed JSON');
+       it('should handle permission errors');
+   });
+   ```
+
+## Documentation
+
+### Code Comments
+
+- Use JSDoc for public APIs
+- Explain "why", not "what"
+- Keep comments up to date
+
+```typescript
+/**
+ * Execute a tool with the given name and arguments.
+ *
+ * This function builds the config from defaults and executes
+ * the appropriate command (commit or release).
+ *
+ * @param name - Tool name ('kilde_commit' or 'kilde_release')
+ * @param args - Tool arguments
+ * @param context - Execution context
+ * @returns Tool result with content array
+ */
+export async function executeTool(
+    name: string,
+    args: Record<string, any>,
+    context: ToolContext
+): Promise<ToolResult> {
+    // Implementation
+}
+```
+
+### README Updates
+
+When adding features:
+
+1. Add to Features section
+2. Update Commands section
+3. Add examples
+4. Update configuration if needed
+
+### AI Guide Updates
+
+When changing MCP functionality:
+
+1. Update tool parameters
+2. Add new examples
+3. Update best practices
+4. Add troubleshooting tips
+
+## Submitting Changes
+
+### 1. Commit Your Changes
+
+Follow conventional commit format:
+
+```bash
+# Format: <type>(<scope>): <description>
+
+git commit -m "feat(mcp): add new resource for git tags"
+git commit -m "fix(commit): handle empty diff gracefully"
+git commit -m "docs: update AI integration guide"
+git commit -m "test: add tests for config loading"
+```
+
+Types:
+- `feat` - New feature
+- `fix` - Bug fix
+- `docs` - Documentation
+- `test` - Tests
+- `refactor` - Code refactoring
+- `chore` - Maintenance
+
+### 2. Push to Your Fork
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 3. Create Pull Request
+
+1. Go to GitHub and create a pull request
+2. Fill out the pull request template
+3. Link related issues
+4. Request review
+
+### Pull Request Template
+
+```markdown
+## Description
+Brief description of changes
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## Testing
+- [ ] Tests pass locally
+- [ ] New tests added
+- [ ] Coverage maintained/improved
+
+## Checklist
+- [ ] Code follows project style
+- [ ] Documentation updated
+- [ ] Commit messages follow convention
+- [ ] No breaking changes (or documented)
+```
+
+### 4. Code Review Process
+
+- Address reviewer feedback promptly
+- Keep discussions focused and professional
+- Make requested changes in new commits
+- Don't force-push during review
+
+### 5. After Approval
+
+Once approved, a maintainer will merge your PR.
+
+## Release Process
+
+Releases are handled by maintainers:
+
+1. Version bump
+2. Update CHANGELOG
+3. Create git tag
+4. Publish to npm
+5. Create GitHub release
+
+### Versioning
+
+We follow [Semantic Versioning](https://semver.org/):
+
+- **MAJOR**: Breaking changes
+- **MINOR**: New features (backward compatible)
+- **PATCH**: Bug fixes
+
+## Getting Help
+
+- [GitHub Discussions](https://github.com/grunnverk/kilde/discussions)
+- [GitHub Issues](https://github.com/grunnverk/kilde/issues)
+- [Discord Community](https://discord.gg/grunnverk) (coming soon)
+
+## Recognition
+
+Contributors are recognized in:
+
+- CHANGELOG.md
+- GitHub contributors page
+- Release notes
+
+Thank you for contributing to Kilde! 🎉
+
+---
+
+**Questions?** Open a [GitHub Discussion](https://github.com/grunnverk/kilde/discussions)

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Tim O'Brien
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.