eslint-plugin-googlemaps

!Build
!Release
!GitHub contributors

Description

ESLint plugin with rules specific to Google Maps Platform JavaScript API.

Install

Available via npm as the package eslint-plugin-googlemaps.

``sh
npm i -D eslint-plugin-googlemaps
`

Usage

To use rules provided by the plugin, use the following:

eslintrc.json:

`json
{
"extends": ["plugin:googlemaps:recommended"]
"plugins": ["googlemaps"],
}
`

Some rules are fixable with eslint --fix. For example the place-fields rule.

`js
service.getDetails({place_id: 'foo'})
`
becomes

`js
service.getDetails({fields: /* TODO: Add necessary fields to the request / [], place_id: 'foo'})
``

Rules

| Rule | Description | Configurations | Type |
| ------------------------------------------------------------ | ---------------------------------- | ---------------- | ------------ |
| no-api-keys | Keep API keys out of code. | ![recommended][] | ![suggest][] |
| place-fields | Always use place fields. | ![recommended][] | ![fixable][] |
| require-js-api-loader | Require @googlemaps/js-api-loader. | ![recommended][] | ![suggest][] |

[recommended]: https://img.shields.io/badge/-recommended-lightgrey.svg
[suggest]: https://img.shields.io/badge/-suggest-yellow.svg
[fixable]: https://img.shields.io/badge/-fixable-green.svg
[style]: https://img.shields.io/badge/-style-blue.svg