5d2096fb5d
Implements a comprehensive suite of AI SDK v6 tools across multiple categories: - Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text - Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize - Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer - Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite - Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist - Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic - Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad - Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis - Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-* - Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse - HTML (3): html-sanitize, html-to-markdown, markdown-to-html All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>(). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
121 lines
3.1 KiB
Markdown
121 lines
3.1 KiB
Markdown
# @tpmjs/tools-conventional-commit-suggest
|
|
|
|
Suggests conventional commit messages from descriptions or file changes following the Conventional Commits specification.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @tpmjs/tools-conventional-commit-suggest
|
|
```
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { conventionalCommitSuggest } from '@tpmjs/tools-conventional-commit-suggest';
|
|
import { generateText } from 'ai';
|
|
|
|
const result = await generateText({
|
|
model: yourModel,
|
|
tools: {
|
|
conventionalCommitSuggest,
|
|
},
|
|
prompt: 'Suggest a commit message for adding a new login feature',
|
|
});
|
|
```
|
|
|
|
## Tool Details
|
|
|
|
### conventionalCommitSuggest
|
|
|
|
Suggests a conventional commit message based on a description of changes and optionally a list of changed files.
|
|
|
|
**Parameters:**
|
|
|
|
- `description` (string, required) - Description of the changes made
|
|
- `files` (array of strings, optional) - Changed file paths to help determine scope
|
|
|
|
**Returns:**
|
|
|
|
```typescript
|
|
{
|
|
message: string; // The commit message subject line
|
|
type: CommitType; // feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
|
|
scope: string | null; // The scope (usually derived from files)
|
|
breaking: boolean; // Whether this is a breaking change
|
|
body: string | null; // Optional commit body
|
|
fullMessage: string; // Complete commit message with body
|
|
explanation: string; // Explanation of the commit type
|
|
}
|
|
```
|
|
|
|
## Example Output
|
|
|
|
**Input:**
|
|
```typescript
|
|
{
|
|
description: "added dark mode toggle to settings page",
|
|
files: ["src/components/settings/ThemeToggle.tsx", "src/components/settings/Settings.tsx"]
|
|
}
|
|
```
|
|
|
|
**Output:**
|
|
```typescript
|
|
{
|
|
message: "feat(settings): add dark mode toggle to settings page",
|
|
type: "feat",
|
|
scope: "settings",
|
|
breaking: false,
|
|
body: "Files changed:\n- src/components/settings/ThemeToggle.tsx\n- src/components/settings/Settings.tsx",
|
|
fullMessage: "feat(settings): add dark mode toggle to settings page\n\nFiles changed:\n- src/components/settings/ThemeToggle.tsx\n- src/components/settings/Settings.tsx",
|
|
explanation: "A new feature"
|
|
}
|
|
```
|
|
|
|
## Conventional Commits Specification
|
|
|
|
This tool follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
|
|
|
|
### Commit Types
|
|
|
|
- **feat**: A new feature
|
|
- **fix**: A bug fix
|
|
- **docs**: Documentation only changes
|
|
- **style**: Changes that don't affect code meaning (formatting, whitespace)
|
|
- **refactor**: Code change that neither fixes a bug nor adds a feature
|
|
- **perf**: Performance improvement
|
|
- **test**: Adding or updating tests
|
|
- **build**: Changes to build system or dependencies
|
|
- **ci**: Changes to CI/CD configuration
|
|
- **chore**: Other changes that don't modify src or test files
|
|
- **revert**: Reverts a previous commit
|
|
|
|
### Format
|
|
|
|
```
|
|
<type>(<scope>): <subject>
|
|
|
|
<body>
|
|
|
|
<footer>
|
|
```
|
|
|
|
### Breaking Changes
|
|
|
|
Breaking changes are indicated with `!` after the type/scope:
|
|
|
|
```
|
|
feat(api)!: remove deprecated endpoints
|
|
```
|
|
|
|
## Features
|
|
|
|
- Automatically determines commit type from description
|
|
- Extracts scope from file paths
|
|
- Detects breaking changes
|
|
- Generates commit body with file list
|
|
- Follows Conventional Commits specification
|
|
- Provides explanation for suggested type
|
|
|
|
## License
|
|
|
|
MIT
|