commit 40f1e06ee88430e4afa8a70747ab1de7f856f1f6 · edouard.paris/did-method-plc

+35

go-didplc/Makefile

···

       1
       1
       +
       

     

       2
       2
       +
       SHELL = /bin/bash

     

       3
       3
       +
       .SHELLFLAGS = -o pipefail -c

     

       4
       4
       +
       

     

       5
       5
       +
       .PHONY: help

     

       6
       6
       +
       help: ## Print info about all commands

     

       7
       7
       +
       	@echo "Commands:"

     

       8
       8
       +
       	@echo

     

       9
       9
       +
       	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "    \033[01;32m%-20s\033[0m %s\n", $$1, $$2}'

     

       10
       10
       +
       

     

       11
       11
       +
       #.PHONY: build

     

       12
       12
       +
       #build: ## Build all executables

     

       13
       13
       +
       #	go build ./...

     

       14
       14
       +
       

     

       15
       15
       +
       .PHONY: test

     

       16
       16
       +
       test: ## Run all tests

     

       17
       17
       +
       	go test ./...

     

       18
       18
       +
       

     

       19
       19
       +
       .PHONY: coverage-html

     

       20
       20
       +
       coverage-html: ## Generate test coverage report and open in browser

     

       21
       21
       +
       	go test ./... -coverpkg=./... -coverprofile=test-coverage.out

     

       22
       22
       +
       	go tool cover -html=test-coverage.out

     

       23
       23
       +
       

     

       24
       24
       +
       .PHONY: lint

     

       25
       25
       +
       lint: ## Verify code style and run static checks

     

       26
       26
       +
       	go vet ./...

     

       27
       27
       +
       	test -z $(gofmt -l ./...)

     

       28
       28
       +
       

     

       29
       29
       +
       .PHONY: fmt

     

       30
       30
       +
       fmt: ## Run syntax re-formatting (modify in place)

     

       31
       31
       +
       	go fmt ./...

     

       32
       32
       +
       

     

       33
       33
       +
       .PHONY: check

     

       34
       34
       +
       check: ## Compile everything, checking syntax (does not output binaries)

     

       35
       35
       +
       	go build ./...

+11

go-didplc/README.md

···

       1
       1
       +
       

     

       2
       2
       +
       `go-didplc`: did:plc in golang

     

       3
       3
       +
       ==============================

     

       4
       4
       +
       

     

       5
       5
       +
       This golang package will eventually be an implementation of the did:plc specification in golang, including at a minimum verification of DID documents from a PLC operation log.

     

       6
       6
       +
       

     

       7
       7
       +
       ## Developer Quickstart

     

       8
       8
       +
       

     

       9
       9
       +
       Install golang. We are generally using v1.22+.

     

       10
       10
       +
       

     

       11
       11
       +
       In this directory (`go-didplc/`) there is a Makefile with helpers for running tests, etc. Run `make help` to list available commands.