* fix(docs): respect workspace.yaml packages_dir setting (fixes #46) * fix(workspace): improve config loading logic (CR feedback) - Expand ~ before resolving relative paths in cmd_registry - Handle LoadWorkspaceConfig errors properly - Update Repo.Path when PackagesDir overrides default - Validate workspace config version - Add unit tests for workspace config loading * docs: add comments and increase test coverage (CR feedback) - Add docstrings to exported functions in pkg/cli - Add unit tests for Semantic Output (pkg/cli/output.go) - Add unit tests for CheckBuilder (pkg/cli/check.go) - Add unit tests for IPC Query/Perform (pkg/framework/core) * fix(test): fix panics and failures in php package tests - Fix panic in TestLookupLinuxKit_Bad by mocking paths - Fix assertion errors in TestGetSSLDir_Bad and TestGetPackageInfo_Bad - Fix formatting in test files * fix(test): correct syntax in services_extended_test.go * fix(ci): point coverage workflow to go.mod instead of go.work * fix(ci): build CLI before running coverage * fix(ci): run go generate for updater package in coverage workflow * fix(github): allow dry-run publish without gh CLI authentication Moves validation check after dry-run check so tests can verify dry-run behavior in CI environments.
146 lines
3.4 KiB
Go
146 lines
3.4 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"
|
|
)
|
|
|
|
// 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 := repos.LoadWorkspaceConfig(registryDir)
|
|
if err != nil {
|
|
return nil, "", cli.Wrap(err, i18n.T("i18n.fail.load", "workspace config"))
|
|
}
|
|
|
|
basePath := registryDir
|
|
|
|
if wsConfig.PackagesDir != "" {
|
|
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)
|
|
}
|