stamen / mapbox-gl-style-linter

Lint Mapbox GL styles

mapbox-gl-style-linter

Lint Mapbox GL styles.

Why? Doesn't the style spec do this?

Yes, the style spec has gl-style-validate, but this module solves two issues:

1. The style spec tool uses an older version of Node, so it can be difficult to execute in projects that use newer versions.
2. The style spec tool does not find every error you might want to find. For example, the style spec tool does not raise errors for paint or layout property ids at the top level of a layer.

This tool takes the same inputs and creates compatible outputs to the style spec's gl-style-validate tool.

Usage

1. Install.
2. Execute on one or more styles:

   mapbox-gl-style-lint styles/*.json

Development

1. Clone this repo.
2. Install dependencies (yarn install).
3. Start build tool (yarn watch).
4. Start the test suite (yarn test).
5. Make changes in src.

mapbox-gl-style-linter's Issues

Make sure line-dash-array is formatted appropriately

We had an issue in a style repo where a style had an incorrectly formatted line-dash-array property using an array with a single value in it: [1].

This didn't cause issues rendering the style as a vector style, but converted to raster it created some breakages.

Out of the box validation from style spec gives layer number, not id

Style spec validation gives errors with a layer number (eg layers[103]) whereas our custom validation gives the layer id which is more helpful: https://github.com/stamen/mapbox-gl-style-linter/blob/main/src/lib/lint-layer.js#L30

We should update the output message from the out-of-the-box style spec validation to give the layer id.

Consider flag for enforcing HSL

We should consider adding flags to enforce certain conventions a user might care about. For example, we often prefer for our styles to use only HSL values. We might also allow for enforcing other color spaces as well.

Do we want to consider optional flags for common conventions like this?