* feat(go): make go fmt git-aware by default - By default, only check changed Go files (modified, staged, untracked) - Add --all flag to check all files (previous behaviour) - Reduces noise when running fmt on large codebases Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(build): minimal output by default, add missing i18n - Default output now shows single line: "Success Built N artifacts (dir)" - Add --verbose/-v flag to show full detailed output - Add all missing i18n translations for build commands - Errors still show failure reason in minimal mode Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add root-level `core git` command - Create pkg/gitcmd with git workflow commands as root menu - Export command builders from pkg/dev (AddCommitCommand, etc.) - Commands available under both `core git` and `core dev` for compatibility - Git commands: health, commit, push, pull, work, sync, apply - GitHub orchestration stays in dev: issues, reviews, ci, impact Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat(qa): add docblock coverage checking Implement docblock/docstring coverage analysis for Go code: - New `core qa docblock` command to check coverage - Shows compact file:line list when under threshold - Integrate with `core go qa` as a default check - Add --docblock-threshold flag (default 80%) The checker uses Go AST parsing to find exported symbols (functions, types, consts, vars) without documentation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address CodeRabbit review feedback - Fix doc comment: "status" → "health" in gitcmd package - Implement --check flag for `core go fmt` (exits non-zero if files need formatting) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add docstrings for 100% coverage Add documentation comments to all exported symbols: - pkg/build: ProjectType constants - pkg/cli: LogLevel, RenderStyle, TableStyle - pkg/framework: ServiceFor, MustServiceFor, Core.Core - pkg/git: GitError.Error, GitError.Unwrap - pkg/i18n: Handler Match/Handle methods - pkg/log: Level constants - pkg/mcp: Tool input/output types - pkg/php: Service constants, QA types, service methods - pkg/process: ServiceError.Error - pkg/repos: RepoType constants - pkg/setup: ChangeType, ChangeCategory constants - pkg/workspace: AddWorkspaceCommands Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: standardize line endings to LF Add .gitattributes to enforce LF line endings for all text files. Normalize all existing files to use Unix-style line endings. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address CodeRabbit review feedback - cmd_format.go: validate --check/--fix mutual exclusivity, capture stderr - cmd_docblock.go: return error instead of os.Exit(1) for proper error handling Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: address CodeRabbit review feedback (round 2) - linuxkit.go: propagate state update errors, handle cmd.Wait() errors in waitForExit - mcp.go: guard against empty old_string in editDiff to prevent runaway edits - cmd_docblock.go: log parse errors instead of silently skipping Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
147 lines
3.5 KiB
Go
147 lines
3.5 KiB
Go
package docs
|
|
|
|
import (
|
|
"io/fs"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/host-uk/core/pkg/cli"
|
|
"github.com/host-uk/core/pkg/i18n"
|
|
"github.com/host-uk/core/pkg/repos"
|
|
"github.com/host-uk/core/pkg/workspace"
|
|
)
|
|
|
|
// RepoDocInfo holds documentation info for a repo
|
|
type RepoDocInfo struct {
|
|
Name string
|
|
Path string
|
|
HasDocs bool
|
|
Readme string
|
|
ClaudeMd string
|
|
Changelog string
|
|
DocsFiles []string // All files in docs/ directory (recursive)
|
|
}
|
|
|
|
func loadRegistry(registryPath string) (*repos.Registry, string, error) {
|
|
var reg *repos.Registry
|
|
var err error
|
|
var registryDir string
|
|
|
|
if registryPath != "" {
|
|
reg, err = repos.LoadRegistry(registryPath)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "registry"))
|
|
}
|
|
registryDir = filepath.Dir(registryPath)
|
|
} else {
|
|
registryPath, err = repos.FindRegistry()
|
|
if err == nil {
|
|
reg, err = repos.LoadRegistry(registryPath)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "registry"))
|
|
}
|
|
registryDir = filepath.Dir(registryPath)
|
|
} else {
|
|
cwd, _ := os.Getwd()
|
|
reg, err = repos.ScanDirectory(cwd)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.scan", "directory"))
|
|
}
|
|
registryDir = cwd
|
|
}
|
|
}
|
|
|
|
// Load workspace config to respect packages_dir
|
|
wsConfig, err := workspace.LoadConfig(registryDir)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "workspace config"))
|
|
}
|
|
|
|
basePath := registryDir
|
|
|
|
if wsConfig != nil && wsConfig.PackagesDir != "" && wsConfig.PackagesDir != "./packages" {
|
|
pkgDir := wsConfig.PackagesDir
|
|
|
|
// Expand ~
|
|
if strings.HasPrefix(pkgDir, "~/") {
|
|
home, _ := os.UserHomeDir()
|
|
pkgDir = filepath.Join(home, pkgDir[2:])
|
|
}
|
|
|
|
if !filepath.IsAbs(pkgDir) {
|
|
pkgDir = filepath.Join(registryDir, pkgDir)
|
|
}
|
|
basePath = pkgDir
|
|
|
|
// Update repo paths if they were relative to registry
|
|
// This ensures consistency when packages_dir overrides the default
|
|
reg.BasePath = basePath
|
|
for _, repo := range reg.Repos {
|
|
repo.Path = filepath.Join(basePath, repo.Name)
|
|
}
|
|
}
|
|
|
|
return reg, basePath, nil
|
|
}
|
|
|
|
func scanRepoDocs(repo *repos.Repo) RepoDocInfo {
|
|
info := RepoDocInfo{
|
|
Name: repo.Name,
|
|
Path: repo.Path,
|
|
}
|
|
|
|
// Check for README.md
|
|
readme := filepath.Join(repo.Path, "README.md")
|
|
if _, err := os.Stat(readme); err == nil {
|
|
info.Readme = readme
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Check for CLAUDE.md
|
|
claudeMd := filepath.Join(repo.Path, "CLAUDE.md")
|
|
if _, err := os.Stat(claudeMd); err == nil {
|
|
info.ClaudeMd = claudeMd
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Check for CHANGELOG.md
|
|
changelog := filepath.Join(repo.Path, "CHANGELOG.md")
|
|
if _, err := os.Stat(changelog); err == nil {
|
|
info.Changelog = changelog
|
|
info.HasDocs = true
|
|
}
|
|
|
|
// Recursively scan docs/ directory for .md files
|
|
docsDir := filepath.Join(repo.Path, "docs")
|
|
if _, err := os.Stat(docsDir); err == nil {
|
|
filepath.WalkDir(docsDir, func(path string, d fs.DirEntry, err error) error {
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
// Skip plans/ directory
|
|
if d.IsDir() && d.Name() == "plans" {
|
|
return filepath.SkipDir
|
|
}
|
|
// Skip non-markdown files
|
|
if d.IsDir() || !strings.HasSuffix(d.Name(), ".md") {
|
|
return nil
|
|
}
|
|
// Get relative path from docs/
|
|
relPath, _ := filepath.Rel(docsDir, path)
|
|
info.DocsFiles = append(info.DocsFiles, relPath)
|
|
info.HasDocs = true
|
|
return nil
|
|
})
|
|
}
|
|
|
|
return info
|
|
}
|
|
|
|
func copyFile(src, dst string) error {
|
|
data, err := os.ReadFile(src)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return os.WriteFile(dst, data, 0644)
|
|
}
|