@unvt/charites 0.5.4 → 2.0.0

package/.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

package/.mocharc.json

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

package/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)):

package/dist/cli/build.js

@@ -1,15 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const build_1 = require("../commands/build");
-const error_1 = require("../lib/error");
-const defaultValues_1 = require("../lib/defaultValues");
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const program = new commander_1.Command();
+import { Command } from 'commander';
+import { build, buildWatch } from '../commands/build.js';
+import { error } from '../lib/error.js';
+import fs from 'fs';
+import path from 'path';
+const program = new Command();
 program
     .name('build')
     .arguments('<source> [destination]')
@@ -19,28 +13,23 @@ program
     .option('-u, --sprite-url [<sprite url>]', 'url to set as the sprite in style.json')
     .option('-i, --sprite-input [<icon input directory>]', 'directory path of icon source to build icons. The default <icon source> is `icons/`')
     .option('-o, --sprite-output [<icon output directory>]', 'directory path to output icon files. The default <icons destination> is the current directory')
-    .option('--provider [provider]', 'your map service. e.g. `mapbox`, `geolonia`')
     .action(async (source, destination, buildOptions) => {
     const options = program.opts();
-    options.provider = buildOptions.provider;
     options.compactOutput = buildOptions.compactOutput;
     options.spriteUrl = buildOptions.spriteUrl;
     options.spriteOutput = buildOptions.spriteOutput || process.cwd();
-    const spriteInputDefault = path_1.default.resolve(process.cwd(), 'icons');
+    const spriteInputDefault = path.resolve(process.cwd(), 'icons');
     if (buildOptions.spriteInput) {
         options.spriteInput = buildOptions.spriteInput;
     }
-    else if (fs_1.default.existsSync(spriteInputDefault)) {
+    else if (fs.existsSync(spriteInputDefault)) {
         options.spriteInput = spriteInputDefault;
     }
-    if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
-        fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
-    }
     if (buildOptions.watch) {
         try {
             console.log('Start watching...');
             await new Promise((resolve) => {
-                const watcher = (0, build_1.buildWatch)(source, destination, options);
+                const watcher = buildWatch(source, destination, options);
                 process.on('SIGINT', () => {
                     watcher.close();
                     resolve(undefined);
@@ -48,16 +37,16 @@ program
             });
         }
         catch (e) {
-            (0, error_1.error)(e);
+            error(e);
         }
     }
     else {
         try {
-            await (0, build_1.build)(source, destination, options);
+            await build(source, destination, options);
         }
         catch (e) {
-            (0, error_1.error)(e);
+            error(e);
         }
     }
 });
-exports.default = program;
+export default program;

package/dist/cli/convert.js

@@ -1,19 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const convert_1 = require("../commands/convert");
-const error_1 = require("../lib/error");
-const program = new commander_1.Command();
+import { Command } from 'commander';
+import { convert } from '../commands/convert.js';
+import { error } from '../lib/error.js';
+const program = new Command();
 program
     .name('convert')
     .arguments('<source> [destination]')
     .description('convert the style JSON to YAML')
     .action((source, destination) => {
     try {
-        (0, convert_1.convert)(source, destination);
+        convert(source, destination);
     }
     catch (e) {
-        (0, error_1.error)(e);
+        error(e);
     }
 });
-exports.default = program;
+export default program;

package/dist/cli/init.js

@@ -1,9 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const init_1 = require("../commands/init");
-const error_1 = require("../lib/error");
-const program = new commander_1.Command();
+import { Command } from 'commander';
+import { init } from '../commands/init.js';
+import { error } from '../lib/error.js';
+const program = new Command();
 program
     .name('init')
     .arguments('<file>')
@@ -17,10 +15,10 @@ program
     options.metadatajsonUrls = initOptions.metadatajsonUrls;
     options.compositeLayers = initOptions.compositeLayers;
     try {
-        await (0, init_1.init)(file, options);
+        await init(file, options);
     }
     catch (e) {
-        (0, error_1.error)(e);
+        error(e);
     }
 });
-exports.default = program;
+export default program;

package/dist/cli/serve.js

@@ -1,40 +1,26 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const serve_1 = require("../commands/serve");
-const error_1 = require("../lib/error");
-const defaultValues_1 = require("../lib/defaultValues");
-const fs_1 = __importDefault(require("fs"));
-const program = new commander_1.Command();
+import { Command } from 'commander';
+import { serve } from '../commands/serve.js';
+import { error } from '../lib/error.js';
+const program = new Command();
 program
     .name('serve')
     .arguments('<source>')
     .description('serve your map locally')
-    .option('--provider [provider]', 'your map service. e.g. `mapbox`, `geolonia`')
-    .option('--mapbox-access-token [mapboxAccessToken]', 'Your Mapbox Access Token (required if using the `mapbox` provider)')
     .option('-i, --sprite-input [<icon input directory>]', 'directory path of icon source to build icons. The default <icon source> is `icons/`')
     .option('--sdf', 'Allows to use SDF sprite in charites')
     .option('--port [port]', 'Specify custom port')
     .option('--no-open', "Don't open the preview in the default browser")
     .action(async (source, serveOptions) => {
     const options = program.opts();
-    options.provider = serveOptions.provider;
-    options.mapboxAccessToken = serveOptions.mapboxAccessToken;
     options.port = serveOptions.port;
     options.spriteInput = serveOptions.spriteInput;
     options.open = serveOptions.open;
     options.sdf = serveOptions.sdf;
-    if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
-        fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
-    }
     try {
-        await (0, serve_1.serve)(source, program.opts());
+        await serve(source, program.opts());
     }
     catch (e) {
-        (0, error_1.error)(e);
+        error(e);
     }
 });
-exports.default = program;
+export default program;

package/dist/cli.js

@@ -1,20 +1,22 @@
 #!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const init_1 = __importDefault(require("./cli/init"));
-const convert_1 = __importDefault(require("./cli/convert"));
-const build_1 = __importDefault(require("./cli/build"));
-const serve_1 = __importDefault(require("./cli/serve"));
-const program = new commander_1.Command();
-const version = require('../package.json').version;
+import { Command } from 'commander';
+import init from './cli/init.js';
+import convert from './cli/convert.js';
+import build from './cli/build.js';
+import serve from './cli/serve.js';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { readFileSync } from 'fs';
+// ESMの__dirnameの代わり
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const program = new Command();
+const packageJson = readFileSync(join(__dirname, '../package.json'), 'utf-8');
+const { version } = JSON.parse(packageJson);
 program
     .version(version, '-v, --version', 'output the version number')
-    .addCommand(init_1.default)
-    .addCommand(convert_1.default)
-    .addCommand(build_1.default)
-    .addCommand(serve_1.default);
+    .addCommand(init)
+    .addCommand(convert)
+    .addCommand(build)
+    .addCommand(serve);
 program.parse(process.argv);

package/dist/commands/build.js

@@ -1,25 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildWatch = exports.build = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const yaml_parser_1 = require("../lib/yaml-parser");
-const validate_style_1 = require("../lib/validate-style");
-const build_sprite_1 = require("../lib/build-sprite");
-const get_sprite_slug_1 = require("../lib/get-sprite-slug");
-const defaultValues_1 = require("../lib/defaultValues");
-const jsonminify_1 = __importDefault(require("jsonminify"));
-const node_watch_1 = __importDefault(require("node-watch"));
-async function build(source, destination, options) {
-    let sourcePath = path_1.default.resolve(process.cwd(), source);
+import path from 'path';
+import fs from 'fs';
+import { parser } from '../lib/yaml-parser.js';
+import { validateStyle } from '../lib/validate-style.js';
+import { buildSprite } from '../lib/build-sprite.js';
+import { getSpriteSlug } from '../lib/get-sprite-slug.js';
+import jsonminify from 'jsonminify';
+import watch from 'node-watch';
+export async function build(source, destination, options) {
+    let sourcePath = path.resolve(process.cwd(), source);
     // The `source` is absolute path.
     if (source.match(/^\//)) {
         sourcePath = source;
     }
-    if (!fs_1.default.existsSync(sourcePath)) {
+    if (!fs.existsSync(sourcePath)) {
         throw `${sourcePath}: No such file or directory`;
     }
     let destinationPath = '';
@@ -28,39 +21,35 @@ async function build(source, destination, options) {
             destinationPath = destination;
         }
         else {
-            destinationPath = path_1.default.resolve(process.cwd(), destination);
+            destinationPath = path.resolve(process.cwd(), destination);
         }
     }
     else {
-        destinationPath = path_1.default.join(path_1.default.dirname(sourcePath), `${path_1.default.basename(source, '.yml')}.json`);
-    }
-    let provider = defaultValues_1.defaultValues.provider;
-    if (options.provider) {
-        provider = options.provider;
+        destinationPath = path.join(path.dirname(sourcePath), `${path.basename(source, '.yml')}.json`);
     }
     let style = '';
     try {
-        const _style = (0, yaml_parser_1.parser)(sourcePath);
-        (0, validate_style_1.validateStyle)(_style, provider);
+        const _style = parser(sourcePath);
+        validateStyle(_style);
         if (options.spriteUrl && 'sprite' in _style) {
             _style.sprite = options.spriteUrl;
         }
         style = JSON.stringify(_style, null, '  ');
         if (options.spriteInput && options.spriteOutput) {
-            if (!fs_1.default.existsSync(options.spriteInput)) {
+            if (!fs.existsSync(options.spriteInput)) {
                 throw `${options.spriteInput}: No such directory. Please specify valid icon input directory. For more help run charites build --help`;
             }
-            if (!fs_1.default.existsSync(options.spriteOutput)) {
+            if (!fs.existsSync(options.spriteOutput)) {
                 throw `${options.spriteOutput}: No such directory. Please specify valid icon output directory. For more help run charites build --help`;
             }
-            const iconSlug = (0, get_sprite_slug_1.getSpriteSlug)(JSON.parse(style));
+            const iconSlug = getSpriteSlug(JSON.parse(style));
             if (!iconSlug) {
                 throw `Invalid sprite url format.`;
             }
-            await (0, build_sprite_1.buildSprite)(options.spriteInput, options.spriteOutput, iconSlug);
+            await buildSprite(options.spriteInput, options.spriteOutput, iconSlug);
         }
         if (options.compactOutput) {
-            style = (0, jsonminify_1.default)(style);
+            style = jsonminify(style);
         }
     }
     catch (err) {
@@ -71,15 +60,14 @@ async function build(source, destination, options) {
             throw `${sourcePath}: Invalid YAML syntax`;
         }
     }
-    fs_1.default.writeFileSync(destinationPath, style);
+    fs.writeFileSync(destinationPath, style);
 }
-exports.build = build;
-function buildWatch(source, destination, options) {
-    let sourcePath = path_1.default.resolve(process.cwd(), source);
+export function buildWatch(source, destination, options) {
+    let sourcePath = path.resolve(process.cwd(), source);
     if (source.match(/^\//)) {
         sourcePath = source;
     }
-    console.log(path_1.default.dirname(sourcePath));
+    console.log(path.dirname(sourcePath));
     const watchCallback = async (event, file) => {
         console.log(`${(event || '').toUpperCase()}: ${file}`);
         try {
@@ -92,6 +80,5 @@ function buildWatch(source, destination, options) {
     };
     // Trigger the watch callback first manually, so the user doesn't need to save the file to create the initial file.
     watchCallback('update', sourcePath);
-    return (0, node_watch_1.default)(path_1.default.dirname(sourcePath), { recursive: true, filter: /\.yml$/ }, watchCallback);
+    return watch(path.dirname(sourcePath), { recursive: true, filter: /\.yml$/ }, watchCallback);
 }
-exports.buildWatch = buildWatch;

package/dist/commands/convert.js

@@ -1,13 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convert = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const readline_1 = __importDefault(require("readline"));
-const yaml_writer_1 = require("../lib/yaml-writer");
+import path from 'path';
+import fs from 'fs';
+import readline from 'readline';
+import { writeYaml } from '../lib/yaml-writer.js';
 const getDestinationPath = (destination, sourcePath = '') => {
     let destinationPath;
     if (destination) {
@@ -15,23 +9,23 @@ const getDestinationPath = (destination, sourcePath = '') => {
             destinationPath = destination;
         }
         else {
-            destinationPath = path_1.default.resolve(process.cwd(), destination);
+            destinationPath = path.resolve(process.cwd(), destination);
         }
     }
     else {
         if (sourcePath) {
-            destinationPath = path_1.default.join(path_1.default.dirname(sourcePath), `${path_1.default.basename(sourcePath, '.json')}.yml`);
+            destinationPath = path.join(path.dirname(sourcePath), `${path.basename(sourcePath, '.json')}.yml`);
         }
         else {
-            destinationPath = path_1.default.join(process.cwd(), 'style.yml');
+            destinationPath = path.join(process.cwd(), 'style.yml');
         }
     }
     return destinationPath;
 };
-function convert(source, destination) {
+export function convert(source, destination) {
     let style, sourcePath;
     if ('-' === source) {
-        const rl = readline_1.default.createInterface({
+        const rl = readline.createInterface({
             input: process.stdin,
             terminal: false,
         });
@@ -42,21 +36,20 @@ function convert(source, destination) {
         rl.on('close', () => {
             const style = JSON.parse(lines.join(''));
             const destinationPath = getDestinationPath(destination);
-            (0, yaml_writer_1.writeYaml)(destinationPath, style, false);
+            writeYaml(destinationPath, style, false);
         });
     }
     else {
-        sourcePath = path_1.default.resolve(process.cwd(), source);
+        sourcePath = path.resolve(process.cwd(), source);
         // The `source` is absolute path.
         if (source.match(/^\//)) {
             sourcePath = source;
         }
-        if (!fs_1.default.existsSync(sourcePath)) {
+        if (!fs.existsSync(sourcePath)) {
             throw `${sourcePath}: No such file or directory`;
         }
-        style = JSON.parse(fs_1.default.readFileSync(sourcePath, 'utf-8'));
+        style = JSON.parse(fs.readFileSync(sourcePath, 'utf-8'));
         const destinationPath = getDestinationPath(destination, sourcePath);
-        (0, yaml_writer_1.writeYaml)(destinationPath, style, false);
+        writeYaml(destinationPath, style, false);
     }
 }
-exports.convert = convert;

package/dist/commands/init.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.init = void 0;
-const yaml_writer_1 = require("../lib/yaml-writer");
-const tileinfo_importer_1 = require("../lib/tileinfo-importer");
+import { writeYaml } from '../lib/yaml-writer.js';
+import { TileJSONImporter, MetadataJSONImporter, } from '../lib/tileinfo-importer/index.js';
 const styleRoot = {
     version: 8,
     name: 'My Style',
@@ -11,16 +8,15 @@ const styleRoot = {
     sources: {},
     layers: [],
 };
-async function init(file, options) {
+export async function init(file, options) {
     let styleTemplate = JSON.parse(JSON.stringify(styleRoot));
     if (options.tilejsonUrls) {
-        const tileJSONImporter = new tileinfo_importer_1.TileJSONImporter(options.tilejsonUrls);
+        const tileJSONImporter = new TileJSONImporter(options.tilejsonUrls);
         styleTemplate = await tileJSONImporter.import(styleTemplate);
     }
     if (options.metadatajsonUrls) {
-        const metadataJSONImporter = new tileinfo_importer_1.MetadataJSONImporter(options.metadatajsonUrls);
+        const metadataJSONImporter = new MetadataJSONImporter(options.metadatajsonUrls);
         styleTemplate = await metadataJSONImporter.import(styleTemplate);
     }
-    (0, yaml_writer_1.writeYaml)(file, styleTemplate, options.compositeLayers);
+    writeYaml(file, styleTemplate, options.compositeLayers);
 }
-exports.init = init;