feat!: big refactoring of internals #81
Conversation
|
@sebbalex sorry for the big PR but this lays out the foundation to incrementally improve on it and future patches will be smaller for sure 😅. Gonna check those failing test that didn't fail on my machine and the io-app one (they removed the AUTHORS file from the repo last week) |
| os.Exit(1) | ||
| } | ||
|
|
||
| fmt.Println(string(out)) |
There was a problem hiding this comment.
given the nature of parser it can be called both from cli and as an external library (from crawler) we should consider to have a separate routine for json/yaml export and make them available for every interface. wdyt @bfabio
|
|
||
| // Load adminisrations data from amministrazoni.txt | ||
| func (p *Parser) isCodiceIPA(codiceiPA string) error { | ||
| // Load Public Aministrations data from amministrazioni.txt | ||
| dataFile, err := Asset("data/amministrazioni.txt") |
There was a problem hiding this comment.
how do we update this? if we do...
There was a problem hiding this comment.
We do it manually https://github.com/italia/publiccode-parser-go#assets every once in a while.
| URL *URL `yaml:"url" validate:"required"` | ||
| LandingURL *URL `yaml:"landingURL,omitempty"` | ||
|
|
||
| IsBasedOn UrlOrUrlArray `yaml:"isBasedOn,omitempty"` |
There was a problem hiding this comment.
| IsBasedOn UrlOrUrlArray `yaml:"isBasedOn,omitempty"` | |
| IsBasedOn UrlArray `yaml:"isBasedOn,omitempty"` |
keys.go
Outdated
| repo2 := vcsurl.GetRepo((*url.URL)(p.PublicCode.URL)) | ||
| if repo1 == nil { | ||
| ve = append(ve, newValidationError( | ||
| "", "failed to detect repo for remote-base-url: %s\n", url1.String()), |
There was a problem hiding this comment.
perhaps I miss something but we should always have key field valued. In this file there are others occurrences.
There was a problem hiding this comment.
This particular error doesn't have a key if refers to because remote-base-url gets passed out of band and it's not in the YAML file (as an argument in case of pcvalidate and as a struct field in case of the library).
In general, there can be cases where key is empty, when the error is not about a specific key, fe. when the encoding is not correct.
bfabio
force-pushed
the
refactor
branch
3 times, most recently
from
5116af0
to
e790c22
Compare
* Refactored the way the library does validation: now we use github.com/go-playground/validator/v10 instead of custom ones. * Now Parse() always return ValidationErrors containing one or more ValidationError if any validation error is present. * The parser tries not to stop the validation early and give as many errors as possible immediately. * The strict mode was removed * The default output is now errorformat friendly (https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format) * pcvalidate learned the -json switch to ouput the report as JSON * Specify the errored keys as a subset of JSONPath (fe. documentation.eng.features[3]) Fix italia#76, Fix italia#19, Fix italia#74, Fix italia#60.
Use the italia/publiccode-editor repository as we can change the publiccode.yml more quickly, if we need to.
Related to italia#82.
* Remove -remote-base-url from the CLI. By default, files existence it's performed checking remotely using remote raw root URL, which is now autodetected from the publiccode. To check from the local directory use -path * Similarly, the Go API now provides NewParser() and NewParserWithPath(), to use respectively the remote raw URL or a local path.
This allows for publiccode.yml to be in a different repository than the one pointed by url and for absolute URLs in publiccode.yml to be outside of the repository. Related to italia/publiccode-crawler#85
Don't expand the relative path of files, the parser should just deal with parsing and validation.
Disable checks that would most likely run into CORS errors when running under WASM.
|
@sebbalex fixed some minor stuff and rebased, we are ready 🎉 |
github.com/go-playground/validator/v10 instead of custom ones.
ValidationError if any validation error is present.
errors as possible immediately.
(https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format)
(fe. documentation.eng.features[3])
Fix #76, Fix #19, Fix #74, Fix #60.