easyp

module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2024 License: Apache-2.0

README

Easyp

easyp is a cli tool for workflows with proto files.

For now, it's just linter and package manager, but... who knows, who knows...

Install

Build from source
  1. Clone repository
  2. Build
go build ./cmd/easyp
Install from github
go install github.com/easyp-tech/easyp/cmd/easyp@latest

Linter

easyp support buf's linter rules.

Usage
easyp lint -c example.easyp.yaml

Package manager

Usage

To usage easpy as a package manager use mod command:

easyp mod -c example.easyp.yaml

Your config file has to contains deps section which is list of repositories with proto files and its version (optional).

For example:

deps:
  - github.com/googleapis/googleapis@common-protos-1_3_1

NOTE: Use only git tag or full hash of commit version.

By default, easyp use $HOME/.easyp dir to storage cache and downloaded modules, you could override it with EASYPPATH env var.

Roadmap
  • Implement support for buf.work.yaml config
  • Calc hash sum, store it and compare (i.e go.sum)
  • Buf's blob support (for IDE plugins)

Directories

Path Synopsis
cmd
easyp command
internal
api
lint
Package lint provides the core functionality of easyp lint.
Package lint provides the core functionality of easyp lint.
mod

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL