Merge pull request #178 from smellman/dev-2.0

Charites v2: Drop support providers, rewrite all to esm module

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
   build:
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 21.x]
+        node-version: [20.x, 22.x]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -53,8 +53,6 @@ jobs:
       - run: npm run build
       - run: chmod 777 dist/cli.js
       - run: npm run test:e2e
-        env:
-          MAPBOX_ACCESS_TOKEN: ${{ secrets.MAPBOX_ACCESS_TOKEN }}
 
   publish:
     name: 'Publish npm package'
@@ -67,7 +65,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           tag_name: 'v%s'
-          node-version: '18.x'
+          node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
           scope: '@unvt'
       - run: npm install

.gitignore

@@ -76,3 +76,5 @@ typings/
 .serverless
 
 dist
+
+test-results/

.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "loader": "ts-node/esm",
+  "require": ["./mocha-register.cjs"],
+  "extensions": ["ts"],
+  "spec": "test/*.ts",
+  "timeout": 5000
+}

README.md

@@ -3,7 +3,7 @@
 [![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the [Mapbox](https://docs.mapbox.com/mapbox-gl-js/style-spec/) and [MapLibre](https://maplibre.org/maplibre-gl-js-docs/style-spec/) Style Specification in YAML.
+An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the [MapLibre](https://maplibre.org/maplibre-style-spec/) Style Specification in YAML.
 With YAML format's readability, JSON compiler, linter, and live style viewer on a local browser, you can simplify your map styling workflow.
 
 In Greek mythology, the [Charites](https://en.wikipedia.org/wiki/Charites) are the three goddesses of charm, beauty, and human creativity. They are believed to have been worshipped not only by artists but also by those who aspired to technology to infuse them with a creative spirit.
@@ -15,7 +15,6 @@ In Greek mythology, the [Charites](https://en.wikipedia.org/wiki/Charites) are t
 - Divide groups of layers in to multiple files for better readability and mantainability. `!!inc/file <relative-path-to-the-file>`
 - Use variables like `$backgroundColor` and `$waterColor` to style effectively.
 - Compile YAML to a single style.json file, with a format linter.
-- Use `--provider mapbox` to validate your style against Mapbox GL JS v2.x
 - Run `charites serve <source>` to preview your style live while you make changes in a browser.
 
 ## Documentation
@@ -30,6 +29,10 @@ see [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
 
 MIT
 
+## Rquirements
+
+- Node.js v20 or later
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

docs/source/index.rst

@@ -6,17 +6,17 @@
 Charites - Documentation
 ====================================
 
-:Date:   2022-12-15
+:Date:   2024-08-23
 :Copyright: CC-BY-SA
 :Organization: The United Nations Vector Tile Toolkit
-:Version: 0.3.0
+:Version: 2.0.0
 :Abstract: This document contains the complete documentation of Charites, an application to style vector tiles easily
 
 .. meta::
    :description lang=en: This document contains the complete documentation of Charites, an application to style vector tiles easily
-   :keywords: Charites, Mapbox, Maplibre, Vectortiles, UNVT, webmapping
+   :keywords: Charites, Maplibre, Vectortiles, UNVT, webmapping
 
-An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the `Mapbox <https://docs.mapbox.com/mapbox-gl-js/style-spec/>`_ and `MapLibre <https://maplibre.org/maplibre-gl-js-docs/style-spec/>`_ Style Specification in YAML.
+An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the `MapLibre <https://maplibre.org/maplibre-style-spec/>`_ Style Specification in YAML.
 With YAML format's readability, JSON compiler, linter, and live style viewer on a local browser, you can simplify your map styling workflow.
 
 .. note::
@@ -30,7 +30,6 @@ Features
 - Divide groups of layers in to multiple files for better readability and mantainability. `!!inc/file <relative-path-to-the-file>`
 - Use variables like `$backgroundColor` and `$waterColor` to style effectively.
 - Compile YAML to a single style.json file, with a format linter.
-- Use `--provider mapbox` to validate your style against Mapbox GL JS v2.x
 - Run `charites serve <source>` to preview your style live while you make changes in a browser.
 
 .. toctree::

docs/source/usage/commandline_interface.rst

@@ -78,11 +78,8 @@ Build `style.json` from `style.yml`
     -u, --sprite-url [<sprite url>]                url to set as the sprite in style.json
     -i, --sprite-input [<icon input directory>]    directory path of icon source to build icons. The default <icon source> is `icons/`
     -o, --sprite-output [<icon output directory>]  directory path to output icon files. The default <icons destination> is the current directory
-    --provider [provider]                          your map service. e.g. `mapbox`, `geolonia`
     -h, --help                                     display help for command
 
-if you use mapbox v2 for your style, please use `--provider mapbox` to specify mapbox service rather than default. Please see `--provider` option at `serve` command section.
-
 Realtime editor on browser
 --------------------------
 
@@ -94,8 +91,6 @@ Realtime editor on browser
     serve your map locally
 
     Options:
-    --provider [provider]                        your map service. e.g. `mapbox`, `geolonia`
-    --mapbox-access-token [mapboxAccessToken]    Access Token for the Mapbox
     -i, --sprite-input [<icon input directory>]  directory path of icon source to build icons. The default <icon
                                                  source> is `icons/`
     --sdf                                        Allows to use SDF sprite in charites
@@ -104,13 +99,6 @@ Realtime editor on browser
 
 Charites has three options for `serve` command.
 
-- ``--provider`` - `mapbox`, `geolonia`, or `default`. When not specified, default or the value in the configuration file will be used.
-
-  - `mapbox` - The format linter runs against the Mapbox GL JS v2.x compatible specification.
-  - `geolonia` and `default` - the format linter runs against the MapLibre GL JS compatible specification.
-
-- ``--mapbox-access-token`` - Set your access-token when styling for Mapbox.
-
 - ``--sprite-input`` - If you are building icon spritesheets with Charites, you can specify the directory of SVG files to compile here. See the ``build`` command for more information.
 
 - ``--sdf`` - if this option is used together with ``--sprite-input``, the viewer will generate SDF sprite. If the option is not specified, non SDF sprite will be generated.

docs/source/usage/examples.rst

@@ -66,9 +66,3 @@ Launch a live preview of your map style in your local environment:
 
     charites serve style.yml
 
-
-For Mapbox users:
-
-.. code-block:: bash
-
-    charites serve style.yml --provider mapbox --mapbox-access-token xxxx

docs/source/usage/index.rst

@@ -6,6 +6,5 @@ Usage
   :maxdepth: 1
 
   commandline_interface
-  global_options
   examples
   example2

eslint.config.mjs

@@ -0,0 +1,46 @@
+import tsParser from '@typescript-eslint/parser'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export default [
+  {
+    ignores: ['node_modules/', 'dist', 'mocha-register.cjs'],
+  },
+  ...compat.extends(
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'prettier',
+  ),
+  {
+    languageOptions: {
+      parser: tsParser,
+      ecmaVersion: 2020,
+      sourceType: 'module',
+    },
+
+    rules: {
+      '@typescript-eslint/explicit-module-boundary-types': 0,
+      '@typescript-eslint/ban-ts-comment': 0,
+      '@typescript-eslint/no-var-requires': 0,
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+        },
+      ],
+    },
+  },
+]

mocha-register.cjs

@@ -0,0 +1,2 @@
+require('ts-node/register')
+require('tsconfig-paths/register')