Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ func main() {
| maven | pom.xml, ivy.xml, build.gradle, build.gradle.kts, build.sbt | gradle.lockfile, gradle-dependencies-q.txt, maven-resolved-dependencies.txt, verification-metadata.xml |
| nimble | *.nimble | |
| nix | flake.nix | flake.lock, sources.json |
| pre-commit | .pre-commit-config.yaml, prek.toml | |
| npm | package.json, bower.json | package-lock.json, npm-shrinkwrap.json, yarn.lock, pnpm-lock.yaml, bun.lock, npm-ls.json |
| nuget | *.csproj, *.vbproj, *.fsproj, *.nuspec, packages.config, Project.json | packages.lock.json, paket.lock, project.assets.json, *.deps.json, Project.lock.json |
| pub | pubspec.yaml | pubspec.lock |
Expand Down
1 change: 1 addition & 0 deletions imports.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import (
_ "github.com/git-pkgs/manifests/internal/nix"
_ "github.com/git-pkgs/manifests/internal/npm"
_ "github.com/git-pkgs/manifests/internal/nuget"
_ "github.com/git-pkgs/manifests/internal/precommit"
_ "github.com/git-pkgs/manifests/internal/pub"
_ "github.com/git-pkgs/manifests/internal/pypi"
_ "github.com/git-pkgs/manifests/internal/rebar"
Expand Down
73 changes: 73 additions & 0 deletions internal/precommit/precommit.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package precommit

import (
"strings"

"github.com/BurntSushi/toml"
"github.com/git-pkgs/manifests/internal/core"
"gopkg.in/yaml.v3"
)

func init() {
core.Register("pre-commit", core.Manifest, &preCommitYAMLParser{}, core.ExactMatch(".pre-commit-config.yaml"))
core.Register("pre-commit", core.Manifest, &prekTOMLParser{}, core.ExactMatch("prek.toml"))
}

type repo struct {
Repo string
Rev string
}

func reposToDeps(repos []repo) []core.Dependency {
var deps []core.Dependency
for _, r := range repos {
if r.Repo == "local" || r.Repo == "meta" || r.Repo == "builtin" {
continue
}

name := r.Repo
if i := strings.Index(name, "://"); i >= 0 {
name = name[i+3:]
}

deps = append(deps, core.Dependency{
Name: name,
Version: r.Rev,
Scope: core.Development,
Direct: true,
})
}
return deps
}

// YAML parser for .pre-commit-config.yaml

type preCommitYAMLParser struct{}

type preCommitYAMLConfig struct {
Repos []repo `yaml:"repos"`
}

func (p *preCommitYAMLParser) Parse(filename string, content []byte) ([]core.Dependency, error) {
var config preCommitYAMLConfig
if err := yaml.Unmarshal(content, &config); err != nil {
return nil, &core.ParseError{Filename: filename, Err: err}
}
return reposToDeps(config.Repos), nil
}

// TOML parser for prek.toml

type prekTOMLParser struct{}

type prekTOMLConfig struct {
Repos []repo `toml:"repos"`
}

func (p *prekTOMLParser) Parse(filename string, content []byte) ([]core.Dependency, error) {
var config prekTOMLConfig
if err := toml.Unmarshal(content, &config); err != nil {
return nil, &core.ParseError{Filename: filename, Err: err}
}
return reposToDeps(config.Repos), nil
}
99 changes: 99 additions & 0 deletions internal/precommit/precommit_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
package precommit

import (
"os"
"testing"

"github.com/git-pkgs/manifests/internal/core"
)

func TestPreCommitConfig(t *testing.T) {
content, err := os.ReadFile("../../testdata/pre-commit/.pre-commit-config.yaml")
if err != nil {
t.Fatalf("failed to read fixture: %v", err)
}

parser := &preCommitYAMLParser{}
deps, err := parser.Parse(".pre-commit-config.yaml", content)
if err != nil {
t.Fatalf("Parse failed: %v", err)
}

if len(deps) != 4 {
t.Fatalf("expected 4 dependencies, got %d", len(deps))
}

depMap := make(map[string]core.Dependency)
for _, d := range deps {
depMap[d.Name] = d
}

expected := map[string]string{
"github.com/pre-commit/pre-commit-hooks": "v4.5.0",
"github.com/psf/black": "24.2.0",
"github.com/PyCQA/flake8": "7.0.0",
"gitlab.com/pycqa/flake8": "5.0.0",
}

for name, wantVer := range expected {
dep, ok := depMap[name]
if !ok {
t.Errorf("expected %s dependency", name)
continue
}
if dep.Version != wantVer {
t.Errorf("%s version = %q, want %q", name, dep.Version, wantVer)
}
if dep.Scope != core.Development {
t.Errorf("%s scope = %q, want %q", name, dep.Scope, core.Development)
}
if !dep.Direct {
t.Errorf("%s should be direct", name)
}
}
}

func TestPrekTOML(t *testing.T) {
content, err := os.ReadFile("../../testdata/pre-commit/prek.toml")
if err != nil {
t.Fatalf("failed to read fixture: %v", err)
}

parser := &prekTOMLParser{}
deps, err := parser.Parse("prek.toml", content)
if err != nil {
t.Fatalf("Parse failed: %v", err)
}

if len(deps) != 3 {
t.Fatalf("expected 3 dependencies, got %d", len(deps))
}

depMap := make(map[string]core.Dependency)
for _, d := range deps {
depMap[d.Name] = d
}

expected := map[string]string{
"github.com/crate-ci/typos": "v1.42.3",
"github.com/executablebooks/mdformat": "1.0.0",
"gitlab.com/pycqa/flake8": "7.0.0",
}

for name, wantVer := range expected {
dep, ok := depMap[name]
if !ok {
t.Errorf("expected %s dependency", name)
continue
}
if dep.Version != wantVer {
t.Errorf("%s version = %q, want %q", name, dep.Version, wantVer)
}
if dep.Scope != core.Development {
t.Errorf("%s scope = %q, want %q", name, dep.Scope, core.Development)
}
if !dep.Direct {
t.Errorf("%s should be direct", name)
}
}
}
28 changes: 28 additions & 0 deletions testdata/pre-commit/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- repo: https://github.com/psf/black
rev: 24.2.0
hooks:
- id: black
- repo: https://github.com/PyCQA/flake8
rev: 7.0.0
hooks:
- id: flake8
- repo: https://gitlab.com/pycqa/flake8
rev: 5.0.0
hooks:
- id: flake8
- repo: local
hooks:
- id: my-local-hook
name: My local hook
entry: ./scripts/lint.sh
language: script
- repo: meta
hooks:
- id: check-hooks-apply
39 changes: 39 additions & 0 deletions testdata/pre-commit/prek.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[[repos]]
repo = "builtin"
hooks = [
{ id = "trailing-whitespace" },
{ id = "end-of-file-fixer" },
]

[[repos]]
repo = "https://github.com/crate-ci/typos"
rev = "v1.42.3"
hooks = [
{ id = "typos" },
]

[[repos]]
repo = "https://github.com/executablebooks/mdformat"
rev = "1.0.0"
hooks = [
{ id = "mdformat", language = "python" },
]

[[repos]]
repo = "https://gitlab.com/pycqa/flake8"
rev = "7.0.0"
hooks = [
{ id = "flake8" },
]

[[repos]]
repo = "local"
hooks = [
{ id = "taplo-fmt", name = "taplo fmt", entry = "taplo fmt", language = "system", types = ["toml"] },
]

[[repos]]
repo = "meta"
hooks = [
{ id = "check-hooks-apply" },
]