diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..f0fba7a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,17 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "npm" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" + open-pull-requests-limit: 5 + versioning-strategy: increase + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/lint-build.yml b/.github/workflows/lint-build.yml index 46ffc50..49308c4 100644 --- a/.github/workflows/lint-build.yml +++ b/.github/workflows/lint-build.yml @@ -17,5 +17,5 @@ jobs: node-version-file: '.nvmrc' - run: npm ci - run: npm run lint - - run: npm run build - - run: npm run build-compat + - run: npm run docs + - run: npm run build-dist diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1576e75..967970b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -95,5 +95,5 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: dist + publish_dir: docs commit_message: 'deploy docs: ${{ steps.tag_version.outputs.new_tag }}' \ No newline at end of file diff --git a/.gitignore b/.gitignore index 326adcc..5dc6e8c 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,4 @@ jspm_packages .node_repl_history dist +docs diff --git a/API.md b/API.md deleted file mode 100644 index fdf7f03..0000000 --- a/API.md +++ /dev/null @@ -1,70 +0,0 @@ - - -### Table of Contents - -* [generateColoredLayers][1] - * [Parameters][2] -* [generateInspectStyle][3] - * [Parameters][4] -* [brightColor][5] - * [Parameters][6] - -## generateColoredLayers - -Generate colored layer styles for the given sources -TODO: Improve docs - -### Parameters - -* `sources` -* `assignLayerColor` -* `Sources` **[Object][7]** dict containing the vector layer IDs -* `Function` **[Function][8]** to generate a color for a layer - -Returns **[array][9]** Array of Maplibre GL layers - -## generateInspectStyle - -Create inspection style out of the original style and the new colored layers - -### Parameters - -* `originalMapStyle` -* `coloredLayers` -* `opts` -* `Original` **[Object][7]** map styles -* `Array` **[array][9]** of colored Maplibre GL layers - -Returns **[Object][7]** Colored inspect style - -## brightColor - -Assign a color to a unique layer ID and also considering -common layer names such as water or wood. - -### Parameters - -* `layerId` **[string][10]** -* `alpha` - -Returns **[string][10]** Unique random for the layer ID - -[1]: #generatecoloredlayers - -[2]: #parameters - -[3]: #generateinspectstyle - -[4]: #parameters-1 - -[5]: #brightcolor - -[6]: #parameters-2 - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/README.md b/README.md index f574680..12a40aa 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Make sure to include the CSS and JS files. **When using a CDN** ```html - + ``` diff --git a/eslint.config.js b/eslint.config.js new file mode 100644 index 0000000..44b8cda --- /dev/null +++ b/eslint.config.js @@ -0,0 +1,17 @@ +// @ts-check + +import eslint from '@eslint/js'; +import tseslint from 'typescript-eslint'; + +export default tseslint.config( + eslint.configs.recommended, + ...tseslint.configs.recommended, + { + rules: { + indent: [ + 2, + 2 + ] + } + } +); \ No newline at end of file diff --git a/examples/custom-color-1.html b/examples/custom-color-1.html index c9cce16..0ddfcb7 100644 --- a/examples/custom-color-1.html +++ b/examples/custom-color-1.html @@ -4,9 +4,9 @@