map-gl-style-linter

Lint Mapbox GL styles.

Why? Doesn't the style spec do this?

Yes, the Mapbox 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

From the command line

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

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

Flags

By default, the linter uses Mapbox GL's style spec to validate a style. If you are using Maplibre GL, set the --renderer flag to maplibre-gl as shown below:

map-gl-style-lint styles/*.json --renderer=maplibre-gl

As a module

const { lint } = require('map-gl-style-linter');

const errors = lint(styleJson);

Options

As above, the default spec used is Mapbox GL. To use Maplibre GL from the module:

const { lint } = require('map-gl-style-linter');

const errors = lint(styleJson, { renderer: 'maplibre-gl' });

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.