https://github.com/mroth/porcelain

🫖 Parsers for git status porcelain in Go
https://github.com/mroth/porcelain

git git-porcelain git-status go

Last synced: 2 months ago
JSON representation

🫖 Parsers for git status porcelain in Go

• Host: GitHub
• URL: https://github.com/mroth/porcelain
• Owner: mroth
• License: mit
• Created: 2025-06-16T16:40:44.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-21T17:27:19.000Z (about 1 year ago)
• Last Synced: 2025-06-21T18:31:25.040Z (about 1 year ago)
• Topics: git, git-porcelain, git-status, go
• Language: Go
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# porcelain 🫖

[![Go Reference](https://pkg.go.dev/badge/github.com/mroth/porcelain.svg)](https://pkg.go.dev/github.com/mroth/porcelain)

[![CodeFactor](https://www.codefactor.io/repository/github/mroth/porcelain/badge)](https://www.codefactor.io/repository/github/mroth/porcelain)

[![Build Status](https://github.com/mroth/porcelain/workflows/test/badge.svg)](https://github.com/mroth/porcelain/actions)

Porcelain provides parsers for Git's [porcelain status output] in Go.

  - [github.com/mroth/porcelain/statusv1] provides `porcelain=v1` format parsing.

  - [github.com/mroth/porcelain/statusv2] provides `porcelain=v2` format parsing.

The parsers are performant (parsing a typical git status report including

headers in ~1 µs single-threaded), and robust (fuzz tested to avoid any possible

crashing panics).

Support for both regular (LF delimited) and `-z` (NUL delimited) output formats

is provided.

The `porcelain=v2` format was first introduced in Git v2.11.0 (2016), and is

recommended for most use cases, as it is significantly more robust and addresses

[some inconsistencies] with the historic `porcelain=v1` format.

[porcelain status output]: https://git-scm.com/docs/git-status#_porcelain_format_version_2

[github.com/mroth/porcelain/statusv1]: https://pkg.go.dev/github.com/mroth/porcelain/statusv1

[github.com/mroth/porcelain/statusv2]: https://pkg.go.dev/github.com/mroth/porcelain/statusv2

[github.com/mroth/scmpuff]: https://github.com/mroth/scmpuff

[some inconsistencies]: https://public-inbox.org/git/20100409184608.C7C61475FEF@snark.thyrsus.com/