lion
7b9aeb1016
|
3 years ago | |
|---|---|---|
| .. | ||
| bin | 3 years ago | |
| build | 3 years ago | |
| dist | 3 years ago | |
| error | 3 years ago | |
| expression | 3 years ago | |
| feature_filter | 3 years ago | |
| flow-typed | 3 years ago | |
| function | 3 years ago | |
| migrate | 3 years ago | |
| reference | 3 years ago | |
| util | 3 years ago | |
| validate | 3 years ago | |
| .eslintrc | 3 years ago | |
| CHANGELOG.md | 3 years ago | |
| README.md | 3 years ago | |
| composite.js | 3 years ago | |
| deref.js | 3 years ago | |
| diff.js | 3 years ago | |
| empty.js | 3 years ago | |
| format.js | 3 years ago | |
| group_by_layout.js | 3 years ago | |
| migrate.js | 3 years ago | |
| package.json | 3 years ago | |
| read_style.js | 3 years ago | |
| rollup.config.js | 3 years ago | |
| style-spec.js | 3 years ago | |
| test.js | 3 years ago | |
| types.js | 3 years ago | |
| validate_mapbox_api_supported.js | 3 years ago | |
| validate_style.js | 3 years ago | |
| validate_style.min.js | 3 years ago | |
| visit.js | 3 years ago | |
README.md
Mapbox GL style specification & utilities
This directory contains code and reference files that define the Mapbox GL style specification and provides some utilities for working with Mapbox styles.
npm package
The Mapbox GL style specification and utilities are published as a seperate npm package so that they can be installed without the bulk of GL JS.
npm install @mapbox/mapbox-gl-style-spec
CLI Tools
If you install this package globally, you will have access to several CLI tools.
npm install @mapbox/mapbox-gl-style-spec --global
gl-style-composite
$ gl-style-composite style.json
Will take a non-composited style and produce a composite style.
gl-style-migrate
This repo contains scripts for migrating GL styles of any version to the latest version (currently v8). Migrate a style like this:
$ gl-style-migrate bright-v7.json > bright-v8.json
To migrate a file in place, you can use the sponge utility from the moreutils package:
$ brew install moreutils
$ gl-style-migrate bright.json | sponge bright.json
gl-style-format
$ gl-style-format style.json
Will format the given style JSON to use standard indentation and sorted object keys.
gl-style-validate
$ gl-style-validate style.json
Will validate the given style JSON and print errors to stdout. Provide a
--json flag to get JSON output.
To validate that a style can be uploaded to the Mapbox Styles API, use the --mapbox-api-supported flag.