# README
go-whosonfirst-validate
Go package for validating Who's On First documents
Documentation
Documentation is incomplete.
Background
So far this is a tool built and developed out of expediency (translation: why is x
broken?). So far it validates the things that have needed to be validated.
Example
import (
"github.com/whosonfirst/go-whosonfirst-validate"
)
func main() {
r, _ := os.Open("/path/to/feature.geojson")
body, _ := validate.EnsureValidGeoJSON(r)
validate_opts := default.ValidateOptions()
validate.ValidateWithOptions(body, opts)
Error handling omitted for the sake of brevity.
Tools
wof-validate
This tool will attempt to load all the (principal) WOF documents (using go-whosonfirst-geojson-v2
) passed to it using a go-whosonfirst-iterate
iterator.
$> ./bin/wof-validate -h
Validate the contents of one or more whosonfirst/go-whosonfirst-iterate/v2 data sources.
Usage:
./bin/wof-validate path(N) path(N)
Valid arguments are:
-all
Enable all validation checks.
-edtf
Validate edtf: properties. (default true)
-is-current
Validate mz:is_current property.
-iterator-uri string
A valid whosonfirst/go-whosonfirst-iterate/v2 URI (default "repo://")
-name
Validate wof:name property. (default true)
-names
Validate WOF/RFC 5646 names.
-placetype
Validate wof:placetype property. (default true)
-repo
Validate wof:repo property. (default true)
-verbose
Be chatty about what's happening.
For example:
$> ./bin/wof-validate /usr/local/data/whosonfirst-data
...time passes
Assuming everything loads successfully you won't see any output (unless you've passed the -verbose
flag (in which case you'll see a lot of output)).
Or this:
$> ./bin/wof-validate -names /usr/local/data/whosonfirst-data
error: Failed to parse name tag for /usr/local/data/whosonfirst-data/data/112/585/728/5/1125857285.geojson, because Failed to parse language tag 'eng_v_variant'
WASM
Consult https://github.com/whosonfirst/go-whosonfirst-validate-wasm
See also
# Packages
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author