Skip to content

CHANGELOG.md

Latest commit

 

History

History
118 lines (92 loc) · 9.5 KB

CHANGELOG.md

File metadata and controls

118 lines (92 loc) · 9.5 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, this project adheres to Semantic Versioning, commits follow Conventional Commits, and this changelog is generated by Structured Changelog.

Unreleased

v0.2.0 - 2026-06-07

Highlights

  • Configuration file support (.api-style.yaml) for project-level governance settings
  • Multi-file linting with glob patterns and recursive directory search
  • Watch mode for continuous linting during development
  • Git pre-commit hook generator for blocking commits with violations

Added

  • Configuration file support with profile, level, include/exclude patterns, exceptions, and severity overrides (b548e01)
  • Config file auto-discovery (.api-style.yaml, .api-style.yml, api-style.yaml) (b548e01)
  • Multi-file resolution with glob patterns (api/*.yaml) (d186981)
  • Recursive directory search (--recursive flag) (d186981)
  • Include/exclude pattern filtering with ** double-star glob support (d186981)
  • MultiLintReport type for aggregating results from multiple files (d186981)
  • Git pre-commit hook generator (api-style hooks init) (b25c337)
  • Pre-commit hook with configurable profile and conformance level (b25c337)
  • File watcher using fsnotify with debouncing (1b58b0a)
  • Watch mode (--watch flag) for continuous re-linting (9118701)
  • --config flag for explicit config file path (9118701)
  • --recursive flag for directory traversal (9118701)
  • hooks init subcommand with --force, --level flags (254d538)

Changed

  • api-style lint accepts multiple file arguments (9118701)
  • CLI flags override config file settings (9118701)

Documentation

  • Configuration file reference (docs/reference/config.md) (6d5f069)
  • Example config file (.api-style.yaml.example) (6d5f069)
  • CLI reference updates for new flags and commands (d3703dc)
  • Getting started guide with config, multi-file, watch, pre-commit sections (d3703dc)
  • Hooks reference with git pre-commit section (d3703dc)
  • Automated API Governance guide for AI-first API design workflow (e4bcaf0)
  • README and examples updates for v0.2.0 features (2d3370e)

Build

  • Add github.com/fsnotify/fsnotify v1.10.1 dependency (2334a2e)
  • Update indirect dependencies (regexp2/v2 to v2.2.1) (baf0bee)

v0.1.0 - 2026-06-06

Highlights

  • OpenAPI style linting with vacuum integration and configurable style profiles (Azure, Google, custom)
  • LLM-powered API evaluation using Claude for semantic analysis beyond static rules
  • MCP server for Claude Desktop and Claude Code integration with resources and prompts
  • Web UI with Lit components and REST API backend for browser-based linting

Added

  • Core types package with LintReport, Violation, StyleProfile, and EvaluationResult structs (7148015)
  • JSON Schema generation from Go types with embedded schemas (7148015)
  • Vacuum-based linting engine with severity mapping and JSON path extraction (4222198)
  • Style profile loading from YAML/JSON with built-in Azure and Google profiles (363656a)
  • Profile inheritance via extends field for building on base profiles (363656a)
  • LLM evaluation with Claude using structured prompts and JSON output (5bdc90d)
  • Evaluation categories: naming, structure, documentation, security, versioning (5bdc90d)
  • Analysis orchestrator combining static linting and LLM evaluation (fb2d291)
  • Spectral ruleset generator from style profiles (0d156fc)
  • Markdown report generator with configurable output options (0d156fc)
  • CLI with lint, analyze, and evaluate commands (e027306)
  • Multiple output formats: text, JSON, SARIF (e027306)
  • Exit codes based on violation severity for CI integration (e027306)
  • MCP server with openapi:// resource URIs for spec access (a039bd5)
  • MCP prompts for guided API review workflows (a039bd5)
  • MCP tools for linting and evaluation from Claude Desktop (a039bd5)
  • Claude Code hooks for pre-commit and post-save linting (384d812)
  • Claude Code skills for /lint and /evaluate slash commands (384d812)
  • SARIF 2.1.0 output format for IDE integration (VS Code, JetBrains) (b935239)
  • GitHub Code Scanning compatible SARIF output (b935239)
  • REST API server with /api/lint and /api/profiles endpoints (f096739)
  • CORS support for development and cross-origin requests (f096739)
  • Web UI with Lit components: spec editor, profile selector, results panel (767a898)
  • Vite-based frontend build with hot module replacement (767a898)
  • Example OpenAPI specs: PetStore and E-Commerce APIs (3de679f)
  • Example custom style profiles demonstrating profile customization (3de679f)

Documentation

  • MkDocs documentation site with Material theme (47b6dc8)
  • Getting started guide with installation and basic usage (47b6dc8)
  • Profile customization guide with YAML examples (47b6dc8)
  • MCP integration guide for Claude Desktop setup (47b6dc8)
  • Feature roadmap with prioritized enhancements

Build

  • GitHub Actions workflows for CI/CD: build, lint, test (c74e181)
  • golangci-lint configuration with security and style checks (c743abf)
  • Schema generator tool for JSON Schema from Go types (ed7302b)

Tests

  • Unit tests for analyze package (82% coverage) (fb2d291)
  • Unit tests for judge package (76% coverage) (5bdc90d)
  • Unit tests for lint package (79% coverage) (4222198)
  • Unit tests for SARIF package (92% coverage) (b935239)