@versatiles/style 3.4.1 → 3.5.0

package/README.MD

@@ -1,6 +1,9 @@
-# VersaTiles Styles
+[![Code Coverage](https://codecov.io/gh/versatiles-org/versatiles-style/branch/main/graph/badge.svg?token=IDHAI13M0K)](https://codecov.io/gh/versatiles-org/versatiles-style)
+[![GitHub Workflow Status)](https://img.shields.io/github/actions/workflow/status/versatiles-org/versatiles-style/ci.yml)](https://github.com/versatiles-org/versatiles-style/actions/workflows/ci.yml)
 
-Programatically generates Shortbread StyleJSON for MapLibre.
+# VersaTiles Style
+
+Programatically generates StyleJSON for MapLibre.
 
 ![Example: Colorful Style](docs/colorful.png)
 
@@ -12,21 +15,21 @@ Programatically generates Shortbread StyleJSON for MapLibre.
 
 ## Download
 
-You can download the latest StyleJSONs from the [latest release](https://github.com/versatiles-org/versatiles-styles/releases/latest/).
+You can download the latest StyleJSONs from the [latest release](https://github.com/versatiles-org/versatiles-style/releases/latest/).
 We provide each style with and without labels, and also in multiple languages.
 
 Be aware that styles already include `tiles.versatiles.org` as source for tiles, fonts (glyphs) and icons (sprites). So you might want to update the URLs in the JSON.
 
 ## as Node.js module
 
-Install `versatiles-styles` via NPM:
+Install `versatiles-style` via NPM:
 ```bash
-npm install versatiles-styles
+npm install versatiles-style
 ```
 
 Use it in Node.js:
 ```javascript
-import { colorful } from 'versatiles-styles';
+import { colorful } from 'versatiles-style';
 let style = colorful({language:'de'});
 writeFileSync('style.json', JSON.stringify(style));
 ```
@@ -35,19 +38,19 @@ writeFileSync('style.json', JSON.stringify(style));
 
 Download latest release:
 ```bash
-wget "https://github.com/versatiles-org/versatiles-styles/releases/latest/download/versatiles-styles.js"
+wget "https://github.com/versatiles-org/versatiles-style/releases/latest/download/versatiles-style.js"
 ```
 
 Use it in:
 ```html
 <div id="map"></div>
 <script src="maplibre-gl.js"></script>
-<script src="versatiles-styles.js"></script>
+<script src="versatiles-style.js"></script>
 <script>
 	const baseUrl = new URL('/', window.location.href).href;
 	const map = new maplibregl.Map({
 		container: 'map',
-		style: versatiles_styles.colorful({
+		style: versatiles_style.colorful({
 			glyphsUrl: baseUrl + 'fonts/{fontstack}/{range}.pbf',
 			spriteUrl: baseUrl + 'sprites/sprites',
 			tilesUrl: [baseUrl + 'tiles/{z}/{x}/{y}'],
@@ -62,7 +65,7 @@ Use it in:
 
 ## Add/edit styles
 
-* style definitions in `src/styles/*.js`
+* style definitions in `src/style/*.js`
 * shortbread layer definition in `src/lib/shortbread_layers.js`
 * style template in `src/lib/shortbread_template.json`
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export type { MaplibreStyle } from './lib/style_builder.js';
-export { default as Colorful } from './styles/colorful.js';
-export { default as Graybeard } from './styles/graybeard.js';
-export { default as Neutrino } from './styles/neutrino.js';
+export { default as Colorful } from './style/colorful.js';
+export { default as Graybeard } from './style/graybeard.js';
+export { default as Neutrino } from './style/neutrino.js';

package/dist/index.js

@@ -1,3 +1,3 @@
-export { default as Colorful } from './styles/colorful.js';
-export { default as Graybeard } from './styles/graybeard.js';
-export { default as Neutrino } from './styles/neutrino.js';
+export { default as Colorful } from './style/colorful.js';
+export { default as Graybeard } from './style/graybeard.js';
+export { default as Neutrino } from './style/neutrino.js';

package/dist/lib/decorator.test.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/naming-convention */
 import { decorate } from './decorator.js';
 import Color from 'color';
 describe('decorate function', () => {

package/dist/lib/shortbread/layers.js

@@ -108,7 +108,6 @@ export default function getLayers(option) {
         },
         // tunnel-, street-, bridges-bridge
         ...['tunnel', 'street', 'bridge'].flatMap((c) => {
-            // eslint-disable-next-line @typescript-eslint/init-declarations
             let filter, prefix;
             const results = [];
             switch (c) {

package/dist/lib/style_builder.js

@@ -1,4 +1,3 @@
-// Import necessary modules and files
 import Color from 'color';
 import getShortbreadTemplate from './shortbread/template.js';
 import getShortbreadLayers from './shortbread/layers.js';

package/dist/lib/style_builder.test.js

@@ -26,7 +26,6 @@ class MockStyleBuilder extends StyleBuilder {
     }
 }
 describe('StyleBuilder', () => {
-    // eslint-disable-next-line @typescript-eslint/init-declarations
     let builder;
     beforeEach(() => {
         builder = new MockStyleBuilder();

package/dist/{styles → style}/graybeard.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/naming-convention */
 import Colorful from './colorful.js';
 export default class Graybeard extends Colorful {
     name = 'graybeard';

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@versatiles/style",
-  "version": "3.4.1",
+  "version": "3.5.0",
   "description": "Generate StyleJSON for MapLibre",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "complete-check": "npm run lint && npm run build && npm run test",
+    "check": "npm run lint && npm run build && npm run test",
     "build": "npm run build-browser && npm run build-node && npm run build-styles",
     "build-browser": "rollup -c=rollup.config.js",
     "build-node": "rm -rf dist && tsc -p tsconfig.node.json",
@@ -15,18 +15,19 @@
     "test": "npm run test-node && npm run test-coverage && npm run test-browser",
     "test-browser": "npm run build-browser && echo 'add browser test'",
     "test-coverage": "NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.coverage.ts",
-    "test-node": "npm run build-node && NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.node.ts"
+    "test-node": "npm run build-node && NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.node.ts",
+    "upgrade": "npm-check-updates -u && rm -f package-lock.json && rm -rf node_modules; npm i"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/versatiles-org/versatiles-styles.git"
+    "url": "git+https://github.com/versatiles-org/versatiles-style.git"
   },
   "author": "yetzt <versatiles@yetzt.me>, Michael Kreil <versatiles@michael-kreil.de>",
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "@types/color": "^3.0.5",
-    "@types/mapbox-gl": "^2.7.17",
+    "@types/color": "^3.0.6",
+    "@types/mapbox-gl": "^2.7.18",
     "brace-expansion": "^3.0.0",
     "color": "^4.2.3"
   },
@@ -40,21 +41,22 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.5",
-    "@types/brace-expansion": "^1.1.1",
-    "@types/inquirer": "^9.0.6",
-    "@types/jest": "^29.5.7",
-    "@types/node": "^20.8.10",
+    "@types/brace-expansion": "^1.1.2",
+    "@types/inquirer": "^9.0.7",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.9.0",
     "@typescript-eslint/eslint-plugin": "^6.10.0",
     "@typescript-eslint/parser": "^6.10.0",
     "eslint": "^8.53.0",
-    "inquirer": "^9.2.11",
+    "inquirer": "^9.2.12",
     "jest": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "rollup": "^4.3.0",
+    "npm-check-updates": "^16.14.6",
+    "rollup": "^4.3.1",
     "rollup-plugin-dts": "^6.1.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "tsx": "^3.14.0",
+    "tsx": "^4.1.1",
     "typescript": "^5.2.2"
   }
 }