@unvt/charites 0.1.1 → 0.1.4

package/.all-contributorsrc

@@ -0,0 +1,24 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "geolonia",
+      "name": "Geolonia",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42296593?v=4",
+      "profile": "https://geolonia.com/",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "charites",
+  "projectOwner": "unvt",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}

package/.eslintignore

@@ -0,0 +1,2 @@
+/node_modules/
+/dist

package/.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+    'plugin:prettier/recommended',
+  ],
+  rules: {
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/no-var-requires': 0,
+  },
+}

package/.github/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+Submit a new issue only if you are sure it is a missing feature or a bug.
+
+## A quick guide for pull request
+
+1. [Fork the repo](https://help.github.com/articles/fork-a-repo) and create a branch for your new feature or bug fix.
+
+2. Make sure build pass. Run: `npm run build`
+
+3. Make sure no lint error. Run: `npm run lint`
+
+4. Run unit tests to ensure all features work well. Run: `npm test`
+
+5. Make sure `charites` command work well after installing globally. Run:
+
+```bash
+npm uninstall -g .
+npm uninstall @unvt/charites
+npm install -g
+charites help
+```
+
+6. Make sure you submit a change specific to exactly one issue. If you have ideas for multiple changes please create separate pull requests.
+
+7. Make sure update documentation under `docs` folder if your changes affect existing documents.
+
+8. Push to your fork and [submit a pull request](https://help.github.com/articles/using-pull-requests). A button should appear on your fork its github page afterwards.
+
+## Translation of charites documentation
+
+Please join our charites-docs project in transifex from [here](https://www.transifex.com/unvt/charites-docs). Welcome to translate documentations in other languages.

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Charites Version:**
+
+- Charites version: 0.X.X
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. Windows]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+Thank you for submitting a pull request!
+
+## Description
+
+Please describe what you changed briefly.
+
+## Type of Pull Request
+<!-- ignore-task-list-start -->
+- [ ] Adding a feature
+- [ ] Fixing a bug
+- [ ] Maintaining documents
+- [ ] Others ()
+<!-- ignore-task-list-end -->
+
+## Verify the followings
+<!-- ignore-task-list-start -->
+- [ ] Code is up-to-date with the `main` branch
+- [ ] No build errors after `npm run build`
+- [ ] No lint errors after `npm run lint`
+- [ ] No errors on using `charites help` globally
+- [ ] Make sure all the exsiting features working well
+- [ ] Have you updated documentation?
+<!-- ignore-task-list-end -->
+
+Refer to [CONTRIBUTING.MD](https://github.com/unvt/charites/tree/master/.github/CONTRIBUTING.md) for more details.

package/.github/workflows/build-docs.yml

@@ -0,0 +1,72 @@
+name: Build and Deploy docs
+
+on: 
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+  pull_request:
+    branches:
+      - '**'
+  workflow_dispatch: {}
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    env:
+      TX_TOKEN: ${{ secrets.TX_TOKEN }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get install -y transifex-client gettext
+        python -m pip install --upgrade pip
+        cd docs
+        pip install pipenv
+        pipenv install --system
+
+    - name: Push translations
+      if: ${{ github.ref == 'refs/heads/main' }}
+      run: |
+        cd docs
+        set -e
+        make gettext
+        if [[ -z "${TX_TOKEN}" ]]; then
+          echo "TX_TOKEN not set, skip tx pull"
+        else
+          tx push -s
+        fi
+        make clean
+
+    - name: Pull translations
+      run: |
+        cd docs
+        set -e
+        if [[ -z "${TX_TOKEN}" ]]; then
+          echo "TX_TOKEN not set, skip tx pull"
+        else
+          make transifex_pull
+        fi
+
+    - name: Build
+      run: |
+        cd docs
+        make html
+        touch ./build/html/.nojekyll
+
+    - name: Deploy 🚀
+      uses: JamesIves/github-pages-deploy-action@4.1.7
+      if: ${{ github.ref == 'refs/heads/main' }}
+      with:
+        branch: gh-pages # The branch the action should deploy to.
+        folder: docs/build/html # The folder the action should deploy.

package/.github/workflows/build.yml

@@ -27,6 +27,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
+      - run: npm run lint
       - run: npm test
 
   publish:

package/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  semi: false,
+  trailingComma: 'all',
+  singleQuote: true,
+  tabWidth: 2,
+}

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Geolonia Inc.
+Copyright (c) 2021 The United Nations Vector Tile Toolkit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,7 @@
 # Charites
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-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.
 With YAML format's readability, JSON compiler, linter, and live style viewer on a local browser, you can simplify your map styling workflow.
@@ -15,123 +18,37 @@ In Greek mythology, the [Charites](https://en.wikipedia.org/wiki/Charites) are t
 - 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.
 
-Example: https://github.com/miya0001/style-template
+## Documentation
 
-## Install
+Documentation is available [here](https://unvt.github.io/charites/).
 
-```
-$ npm install -g @unvt/charites
-```
-
-Then try:
-
-```
-$ charites help
-```
-
-## Usage
-
-```
-$ charites help
-Usage: charites [options] [command]
-
-Options:
-  --provider [provider]                      your map service. e.g. `mapbox`, `geolonia`
-  --mapbox-access-token [mapboxAccessToken]  Access Token for the Mapbox
-  -h, --help                                 display help for command
-
-Commands:
-  init <file>                                initialize a style JSON
-  convert <source> [destination]             convert the style JSON to YAML
-  build [options] <source> [destination]     build a style JSON from the YAML
-  serve <source>                             serve your map locally
-  help [command]                             display help for command
-```
-
-## Global Options
-
-Charites has two global options that are common to all commands.
-
-- `--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.
-
-# Configuration
-
-The global options for Charites can be stored in a configuration file written in YAML.
-
-The config file will be automatically created to the following path the first time the charites command is executed.
-
-```
-~/.charites/config.yml
-```
-
-Global options can be specified as follows:
-
-
-```
-provider: mapbox
-mapboxAccessToken: xxxx
-```
-
-With the example above, you get the same result as `charites --provider mapbox --mapbox-access-token xxxx`.
-
-## Examples
-
-Build `style.json` from `style.yml`:
-
-```
-charites build style.yml style.json
-```
-
-Add `-c` or `--compact-output` to minify the JSON
-
-```
-charites build style.yml style.json -c
-```
-
-Convert `style.json` to `style.yml`:
+## Contributing
 
-```
-charites convert style.json style.yml
-```
+see [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
 
-Load JSON as a standard input to generate `style.yml`:
+## License
 
-```
-curl http://example.com/style.json | charites convert - style.yml
-```
+MIT
 
-Launch a live preview of your map style in your local environment:
+## Contributors ✨
 
-```
-charites serve style.yml
-```
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
-For Mapbox users:
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
 
-```
-charites serve style.yml --provider mapbox --mapbox-access-token xxxx
-```
+<table>
+  <tr>
+    <td align="center"><a href="https://geolonia.com/"><img src="https://avatars.githubusercontent.com/u/42296593?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Geolonia</b></sub></a><br /><a href="https://github.com/unvt/charites/commits?author=geolonia" title="Code">💻</a></td>
+  </tr>
+</table>
 
-## Contributing
 
-### Development
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
 
-```
-$ git clone https://github.com/geolonia/charites.git
-$ cd charites
-$ npm install
-$ npm run build
-$ npm install -g .
-```
-Then run:
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
-```
-$ charites help
-```
 
-## License
-
-MIT
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/dist/cli/build.js

@@ -0,0 +1,63 @@
+"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();
+program
+    .name('build')
+    .arguments('<source> [destination]')
+    .description('build a style JSON from the YAML')
+    .option('-c, --compact-output', 'build a minified style JSON')
+    .option('-w, --watch', 'watch YAML and build when changed')
+    .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');
+    if (buildOptions.spriteInput) {
+        options.spriteInput = buildOptions.spriteInput;
+    }
+    else if (fs_1.default.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 = build_1.buildWatch(source, destination, options);
+                process.on('SIGINT', () => {
+                    watcher.close();
+                    resolve(undefined);
+                });
+            });
+        }
+        catch (e) {
+            error_1.error(e);
+        }
+    }
+    else {
+        try {
+            await build_1.build(source, destination, options);
+        }
+        catch (e) {
+            error_1.error(e);
+        }
+    }
+});
+exports.default = program;

package/dist/cli/convert.js

@@ -0,0 +1,19 @@
+"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();
+program
+    .name('convert')
+    .arguments('<source> [destination]')
+    .description('convert the style JSON to YAML')
+    .action((source, destination) => {
+    try {
+        convert_1.convert(source, destination);
+    }
+    catch (e) {
+        error_1.error(e);
+    }
+});
+exports.default = program;

package/dist/cli/init.js

@@ -0,0 +1,26 @@
+"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();
+program
+    .name('init')
+    .arguments('<file>')
+    .description('initialize a style JSON')
+    .option('-t, --tilejson-urls <tilejson_urls>', 'an URL for TileJSON. It will create empty layers from vector_layers property of TileJSON. Please use comma (,) in case multiple TileJSONs require.')
+    .option('-m, --metadatajson-urls <metadatajson_urls>', 'an URL for metadata.json. It will create empty layers from vector_layers property of metadata.json. Please use comma (,) in case multiple metadata.json require.')
+    .option('-c, --composite-layers', 'If it is true, a single YAML will be generated with multiple layers. Default is false.')
+    .action(async (file, initOptions) => {
+    const options = program.opts();
+    options.tilejsonUrls = initOptions.tilejsonUrls;
+    options.metadatajsonUrls = initOptions.metadatajsonUrls;
+    options.compositeLayers = initOptions.compositeLayers;
+    try {
+        await init_1.init(file, options);
+    }
+    catch (e) {
+        error_1.error(e);
+    }
+});
+exports.default = program;

package/dist/cli/serve.js

@@ -0,0 +1,34 @@
+"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();
+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]', 'Access Token for the Mapbox')
+    .option('--port [port]', 'Specify custom port')
+    .action((source, serveOptions) => {
+    const options = program.opts();
+    options.provider = serveOptions.provider;
+    options.mapboxAccessToken = serveOptions.mapboxAccessToken;
+    options.port = serveOptions.port;
+    if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
+        fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
+    }
+    try {
+        serve_1.serve(source, program.opts());
+    }
+    catch (e) {
+        error_1.error(e);
+    }
+});
+exports.default = program;

package/dist/cli.js

@@ -5,72 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const fs_1 = __importDefault(require("fs"));
-const init_1 = require("./commands/init");
-const convert_1 = require("./commands/convert");
-const build_1 = require("./commands/build");
-const serve_1 = require("./commands/serve");
-const defaultValues_1 = require("./lib/defaultValues");
+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 error = (message) => {
-    console.error(message.toString());
-    process.exit(1);
-};
-program
-    .option('--provider [provider]', 'your map service. e.g. `mapbox`, `geolonia`')
-    .option('--mapbox-access-token [mapboxAccessToken]', 'Access Token for the Mapbox');
-program
-    .command('init <file>')
-    .description('initialize a style JSON')
-    .action((file) => {
-    try {
-        init_1.init(file);
-    }
-    catch (e) {
-        error(e);
-    }
-});
-program
-    .command('convert <source> [destination]')
-    .description('convert the style JSON to YAML')
-    .action((source, destination) => {
-    try {
-        convert_1.convert(source, destination);
-    }
-    catch (e) {
-        error(e);
-    }
-});
-program
-    .command('build <source> [destination]')
-    .description('build a style JSON from the YAML')
-    .option('-c, --compact-output', 'build a minified style JSON')
-    .action((source, destination, buildOptions) => {
-    const options = program.opts();
-    options.compactOutput = buildOptions.compactOutput;
-    if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
-        fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
-    }
-    try {
-        build_1.build(source, destination, options);
-    }
-    catch (e) {
-        error(e);
-    }
-});
+const version = require('../package.json').version;
 program
-    .command('serve <source>')
-    .description('serve your map locally')
-    .action((source) => {
-    const options = program.opts();
-    if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
-        fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
-    }
-    try {
-        serve_1.serve(source, program.opts());
-    }
-    catch (e) {
-        error(e);
-    }
-});
+    .version(version, '-v, --version', 'output the version number')
+    .addCommand(init_1.default)
+    .addCommand(convert_1.default)
+    .addCommand(build_1.default)
+    .addCommand(serve_1.default);
 program.parse(process.argv);