npm - @unvt/charites - Versions diffs - 0.1.1 → 0.1.4 - Mend

@unvt/charites 0.1.1 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (106) hide show

package/.all-contributorsrc +24 -0
package/.eslintignore +2 -0
package/.eslintrc.js +17 -0
package/.github/CONTRIBUTING.md +30 -0
package/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
package/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
package/.github/PULL_REQUEST_TEMPLATE.md +25 -0
package/.github/workflows/build-docs.yml +72 -0
package/.github/workflows/build.yml +1 -0
package/.prettierrc.js +6 -0
package/LICENSE +1 -1
package/README.md +23 -106
package/dist/cli/build.js +63 -0
package/dist/cli/convert.js +19 -0
package/dist/cli/init.js +26 -0
package/dist/cli/serve.js +34 -0
package/dist/cli.js +10 -66
package/dist/commands/build.js +39 -3
package/dist/commands/convert.js +6 -23
package/dist/commands/init.js +15 -22
package/dist/commands/serve.js +8 -3
package/dist/lib/build-sprite.js +71 -0
package/dist/lib/defaultValues.js +3 -3
package/dist/lib/error.js +9 -0
package/dist/lib/get-sprite-slug.js +16 -0
package/dist/lib/tileinfo-importer/base-importer.js +41 -0
package/dist/lib/tileinfo-importer/index.js +6 -0
package/dist/lib/tileinfo-importer/metadata-importer.js +38 -0
package/dist/lib/tileinfo-importer/tilejson-importer.js +25 -0
package/dist/lib/validate-style.js +2 -2
package/dist/lib/yaml-parser.js +2 -2
package/dist/lib/yaml-writer.js +48 -0
package/dist/types/index.js +15 -0
package/dist/types/metadatajson.js +2 -0
package/dist/types/tilejson.js +2 -0
package/dist/types/vector_layers.js +2 -0
package/docs/.tx/config +62 -0
package/docs/Makefile +170 -0
package/docs/Pipfile +20 -0
package/docs/Pipfile.lock +429 -0
package/docs/README.md +43 -0
package/docs/make.bat +35 -0
package/docs/source/_static/.gitkeep +0 -0
package/docs/source/_templates/.gitkeep +0 -0
package/docs/source/conf.py +69 -0
package/docs/source/development/index.rst +40 -0
package/docs/source/index.rst +61 -0
package/docs/source/install/index.rst +10 -0
package/docs/source/install/install.rst +7 -0
package/docs/source/install/install_on_nanban.rst +9 -0
package/docs/source/install/recommended_environment.rst +6 -0
package/docs/source/usage/commandline_interface.rst +102 -0
package/docs/source/usage/examples.rst +74 -0
package/docs/source/usage/global_options.rst +21 -0
package/docs/source/usage/index.rst +10 -0
package/package.json +12 -4
package/provider/default/app.css +10 -0
package/provider/default/app.js +31 -5
package/provider/default/index.html +7 -0
package/provider/geolonia/app.css +10 -0
package/provider/geolonia/app.js +29 -5
package/provider/geolonia/index.html +7 -0
package/provider/mapbox/app.css +10 -0
package/provider/mapbox/app.js +31 -5
package/provider/mapbox/index.html +7 -0
package/src/cli/build.ts +77 -0
package/src/cli/convert.ts +18 -0
package/src/cli/init.ts +34 -0
package/src/cli/serve.ts +39 -0
package/src/cli.ts +12 -76
package/src/commands/build.ts +71 -9
package/src/commands/convert.ts +16 -35
package/src/commands/init.ts +28 -21
package/src/commands/serve.ts +70 -57
package/src/lib/build-sprite.ts +80 -0
package/src/lib/defaultValues.ts +6 -6
package/src/lib/error.ts +6 -0
package/src/lib/get-sprite-slug.ts +18 -0
package/src/lib/tileinfo-importer/base-importer.ts +57 -0
package/src/lib/tileinfo-importer/index.ts +2 -0
package/src/lib/tileinfo-importer/metadata-importer.ts +44 -0
package/src/lib/tileinfo-importer/tilejson-importer.ts +29 -0
package/src/lib/validate-style.ts +8 -2
package/src/lib/yaml-parser.ts +9 -8
package/src/lib/yaml-writer.ts +68 -0
package/src/types/index.ts +3 -0
package/src/types/metadatajson.ts +16 -0
package/src/types/tilejson.ts +25 -0
package/src/types/vector_layers.ts +11 -0
package/test/build-sprite.spec.ts +24 -0
package/test/build.spec.ts +121 -16
package/test/convert.spec.ts +7 -7
package/test/data/icons/aerialway.svg +4 -0
package/test/data/init/init.yml +6 -0
package/test/data/init/init_metadata.yml +60 -0
package/test/data/init/init_tilejson.yml +28 -0
package/test/data/init/init_tilejson_without_layers.yml +9 -0
package/test/data/init/tilejson/init_decomposite.yml +13 -0
package/test/data/init/tilejson/layers/bicycle_parking.yml +6 -0
package/test/data/init/tilejson/layers/showers.yml +6 -0
package/test/data/init/tilejson/layers/telephone.yml +6 -0
package/test/get-sprite-slug.spec.ts +34 -0
package/test/init.spec.ts +151 -0
package/test/validate-style.spec.ts +7 -5
package/test/yaml-parser.spec.ts +15 -15
package/tsconfig.json +3 -1

package/provider/mapbox/app.js CHANGED Viewed

@@ -3,11 +3,37 @@ mapboxgl.accessToken = '___MAPBOX_ACCESS_TOKEN___'
 const map = new mapboxgl.Map({
   container: 'map',
   hash: true,
-  style: `http://${window.location.host}/style.json`
-});
+  style: `http://${window.location.host}/style.json`,
+})
-const socket = new WebSocket('ws://localhost:___PORT___');
+const socket = new WebSocket('ws://localhost:___PORT___')
-socket.addEventListener('message',(message)=>{
+socket.addEventListener('message', (message) => {
   map.setStyle(JSON.parse(message.data))
-});
+})
+map.addControl(new mapboxgl.NavigationControl(), 'top-right')
+const showTileBoundaries = document.getElementById('showTileBoundaries')
+const setShowTileBoundaries = function () {
+  const checked = showTileBoundaries.checked
+  map.showTileBoundaries = checked
+}
+setShowTileBoundaries()
+showTileBoundaries.addEventListener('click', setShowTileBoundaries)
+const showCollisionBoxes = document.getElementById('showCollisionBoxes')
+const setShowCollisionBoxes = function () {
+  const checked = showCollisionBoxes.checked
+  map.showCollisionBoxes = checked
+}
+setShowCollisionBoxes()
+showCollisionBoxes.addEventListener('click', setShowCollisionBoxes)
+const showPadding = document.getElementById('showPadding')
+const setShowPadding = function () {
+  const checked = showPadding.checked
+  map.showPadding = checked
+}
+setShowPadding()
+showPadding.addEventListener('click', setShowPadding)

package/provider/mapbox/index.html CHANGED Viewed

@@ -7,6 +7,13 @@
     <script src='https://api.mapbox.com/mapbox-gl-js/v2.5.0/mapbox-gl.js'></script>
   </head>
   <body>
+    <div class="overlay">
+      <label><input type="checkbox" id="showTileBoundaries">show Tile Boundaries</label>
+      <br>
+      <label><input type="checkbox" id="showCollisionBoxes">show Collision Boxes</label>
+      <br>
+      <label><input type="checkbox" id="showPadding">show Padding</label>
+    </div>
     <div id="map"></div>
     <script type="text/javascript" src="/app.js"></script>
   </body>

package/src/cli/build.ts ADDED Viewed

@@ -0,0 +1,77 @@
+import { Command } from 'commander'
+import { build, buildOptions, buildWatch } from '../commands/build'
+import { error } from '../lib/error'
+import { defaultSettings } from '../lib/defaultValues'
+import fs from 'fs'
+import path from 'path'
+const program = new 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: string, destination: string, buildOptions: 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.resolve(process.cwd(), 'icons')
+      if (buildOptions.spriteInput) {
+        options.spriteInput = buildOptions.spriteInput
+      } else if (fs.existsSync(spriteInputDefault)) {
+        options.spriteInput = spriteInputDefault
+      }
+      if (!fs.existsSync(defaultSettings.configFile)) {
+        fs.writeFileSync(
+          defaultSettings.configFile,
+          `provider: ${options.provider || 'default'}`,
+        )
+      }
+      if (buildOptions.watch) {
+        try {
+          console.log('Start watching...')
+          await new Promise((resolve) => {
+            const watcher = buildWatch(source, destination, options)
+            process.on('SIGINT', () => {
+              watcher.close()
+              resolve(undefined)
+            })
+          })
+        } catch (e) {
+          error(e)
+        }
+      } else {
+        try {
+          await build(source, destination, options)
+        } catch (e) {
+          error(e)
+        }
+      }
+    },
+  )
+export default program

package/src/cli/convert.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import { Command } from 'commander'
+import { convert } from '../commands/convert'
+import { error } from '../lib/error'
+const program = new Command()
+program
+  .name('convert')
+  .arguments('<source> [destination]')
+  .description('convert the style JSON to YAML')
+  .action((source: string, destination: string) => {
+    try {
+      convert(source, destination)
+    } catch (e) {
+      error(e)
+    }
+  })
+export default program

package/src/cli/init.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { Command } from 'commander'
+import { init, initOptions } from '../commands/init'
+import { error } from '../lib/error'
+const program = new 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: string, initOptions: initOptions) => {
+    const options = program.opts()
+    options.tilejsonUrls = initOptions.tilejsonUrls
+    options.metadatajsonUrls = initOptions.metadatajsonUrls
+    options.compositeLayers = initOptions.compositeLayers
+    try {
+      await init(file, options)
+    } catch (e) {
+      error(e)
+    }
+  })
+export default program

package/src/cli/serve.ts ADDED Viewed

@@ -0,0 +1,39 @@
+import { Command } from 'commander'
+import { serve, serveOptions } from '../commands/serve'
+import { error } from '../lib/error'
+import { defaultSettings } from '../lib/defaultValues'
+import fs from 'fs'
+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]',
+    'Access Token for the Mapbox',
+  )
+  .option('--port [port]', 'Specify custom port')
+  .action((source: string, serveOptions: serveOptions) => {
+    const options: serveOptions = program.opts()
+    options.provider = serveOptions.provider
+    options.mapboxAccessToken = serveOptions.mapboxAccessToken
+    options.port = serveOptions.port
+    if (!fs.existsSync(defaultSettings.configFile)) {
+      fs.writeFileSync(
+        defaultSettings.configFile,
+        `provider: ${options.provider || 'default'}`,
+      )
+    }
+    try {
+      serve(source, program.opts())
+    } catch (e) {
+      error(e)
+    }
+  })
+export default program

package/src/cli.ts CHANGED Viewed

@@ -1,83 +1,19 @@
 #!/usr/bin/env node
-import { Command } from 'commander';
-import fs from 'fs'
+import { Command } from 'commander'
-import { init } from './commands/init'
-import { convert } from './commands/convert'
-import { build } from './commands/build'
-import { serve } from './commands/serve'
-import { defaultSettings } from './lib/defaultValues'
-interface buildOptions {
-  compactOutput?: boolean
-}
-const program = new Command();
-const error = (message: any) => {
-  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: string) => {
-    try {
-      init(file)
-    } catch(e) {
-      error(e)
-    }
-  })
-program
-  .command('convert <source> [destination]')
-  .description('convert the style JSON to YAML')
-  .action((source: string, destination: string) => {
-    try {
-      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: string, destination: string, buildOptions: buildOptions) => {
-    const options = program.opts()
-    options.compactOutput = buildOptions.compactOutput
-    if (! fs.existsSync(defaultSettings.configFile)) {
-      fs.writeFileSync(defaultSettings.configFile, `provider: ${options.provider || 'default'}`)
-    }
-    try {
-      build(source, destination, options)
-    } catch(e) {
-      error(e)
-    }
-  })
+import init from './cli/init'
+import convert from './cli/convert'
+import build from './cli/build'
+import serve from './cli/serve'
+const program = new Command()
+const version = require('../package.json').version
 program
-  .command('serve <source>')
-  .description('serve your map locally')
-  .action((source: string) => {
-    const options = program.opts()
-    if (! fs.existsSync(defaultSettings.configFile)) {
-      fs.writeFileSync(defaultSettings.configFile, `provider: ${options.provider || 'default'}`)
-    }
-    try {
-      serve(source, program.opts())
-    } catch(e) {
-      error(e)
-    }
-  })
+  .version(version, '-v, --version', 'output the version number')
+  .addCommand(init)
+  .addCommand(convert)
+  .addCommand(build)
+  .addCommand(serve)
 program.parse(process.argv)

package/src/commands/build.ts CHANGED Viewed

@@ -2,15 +2,27 @@ import path from 'path'
 import fs from 'fs'
 import { parser } from '../lib/yaml-parser'
 import { validateStyle } from '../lib/validate-style'
+import { buildSprite } from '../lib/build-sprite'
+import { getSpriteSlug } from '../lib/get-sprite-slug'
 import { defaultValues } from '../lib/defaultValues'
 import jsonminify from 'jsonminify'
+import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec/types'
+import watch from 'node-watch'
-interface options {
-  provider?: string,
+export interface buildOptions {
+  provider?: string
   compactOutput?: boolean
+  watch?: boolean
+  spriteUrl?: string
+  spriteInput?: string
+  spriteOutput?: string
 }
-export function build(source: string, destination: string, options: options) {
+export async function build(
+  source: string,
+  destination: string,
+  options: buildOptions,
+) {
   let sourcePath = path.resolve(process.cwd(), source)
   // The `source` is absolute path.
@@ -18,11 +30,11 @@ export function build(source: string, destination: string, options: options) {
     sourcePath = source
   }
-  if (! fs.existsSync(sourcePath)) {
+  if (!fs.existsSync(sourcePath)) {
     throw `${sourcePath}: No such file or directory`
   }
-  let destinationPath = ""
+  let destinationPath = ''
   if (destination) {
     if (destination.match(/^\//)) {
@@ -31,7 +43,10 @@ export function build(source: string, destination: string, options: options) {
       destinationPath = path.resolve(process.cwd(), destination)
     }
   } else {
-    destinationPath = path.join(path.dirname(sourcePath), `${path.basename(source, '.yml')}.json`)
+    destinationPath = path.join(
+      path.dirname(sourcePath),
+      `${path.basename(source, '.yml')}.json`,
+    )
   }
   let provider = defaultValues.provider
@@ -42,13 +57,36 @@ export function build(source: string, destination: string, options: options) {
   let style = ''
   try {
-    const _style = parser(sourcePath)
+    const _style: StyleSpecification = parser(sourcePath)
     validateStyle(_style, provider)
+    if (options.spriteUrl && 'sprite' in _style) {
+      _style.sprite = options.spriteUrl
+    }
     style = JSON.stringify(_style, null, '  ')
+    if (options.spriteInput && options.spriteOutput) {
+      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.existsSync(options.spriteOutput)) {
+        throw `${options.spriteOutput}: No such directory. Please specify valid icon output directory. For more help run charites build --help`
+      }
+      const iconSlug = getSpriteSlug(JSON.parse(style))
+      if (!iconSlug) {
+        throw `Invalid sprite url format.`
+      }
+      await buildSprite(options.spriteInput, options.spriteOutput, iconSlug)
+    }
     if (options.compactOutput) {
       style = jsonminify(style)
     }
-  } catch(err) {
+  } catch (err) {
     if (err) {
       throw err
     } else {
@@ -58,7 +96,31 @@ export function build(source: string, destination: string, options: options) {
   try {
     fs.writeFileSync(destinationPath, style)
-  } catch(err) {
+  } catch (err) {
     throw `${destinationPath}: Permission denied`
   }
 }
+export function buildWatch(
+  source: string,
+  destination: string,
+  options: buildOptions,
+) {
+  let sourcePath = path.resolve(process.cwd(), source)
+  if (source.match(/^\//)) {
+    sourcePath = source
+  }
+  console.log(path.dirname(sourcePath))
+  return watch(
+    path.dirname(sourcePath),
+    { recursive: true, filter: /\.yml$/ },
+    (event, file) => {
+      console.log(`${(event || '').toUpperCase()}: ${file}`)
+      try {
+        build(source, destination, options)
+      } catch (e) {
+        // Nothing to do
+      }
+    },
+  )
+}

package/src/commands/convert.ts CHANGED Viewed

@@ -1,31 +1,9 @@
 import path from 'path'
 import fs from 'fs'
-import YAML from 'js-yaml'
 import readline from 'readline'
+import { writeYaml } from '../lib/yaml-writer'
-// TODO: Type of style should be loaded from maplibre or mapbox style spec.
-const writeYaml = (destinationPath: string, style: any) => {
-  const layers = []
-  for (let i = 0; i < style.layers.length; i++) {
-    const layer = style.layers[i]
-    const layerYml = YAML.dump(layer)
-    const fileName = `${style.layers[i].id}.yml`
-    const dirName = path.join(path.dirname(destinationPath), 'layers')
-    fs.mkdirSync(dirName, { recursive: true })
-    fs.writeFileSync(path.join(dirName, fileName), layerYml)
-    layers.push(`!!inc/file ${path.join('layers', fileName)}`)
-  }
-  style.layers = layers
-  fs.writeFileSync(destinationPath, YAML.dump(style).replace(/'\!\!inc\/file layers\/.+\.yml'/g, function (match) {
-    return match.replace(/'/g, '')
-  }))
-}
-const getDestinationPath = (destination: string, sourcePath: string = '') => {
+const getDestinationPath = (destination: string, sourcePath = '') => {
   let destinationPath
   if (destination) {
@@ -36,7 +14,10 @@ const getDestinationPath = (destination: string, sourcePath: string = '') => {
     }
   } else {
     if (sourcePath) {
-      destinationPath = path.join(path.dirname(sourcePath), `${path.basename(sourcePath, '.json')}.yml`)
+      destinationPath = path.join(
+        path.dirname(sourcePath),
+        `${path.basename(sourcePath, '.json')}.yml`,
+      )
     } else {
       destinationPath = path.join(process.cwd(), 'style.yml')
     }
@@ -51,22 +32,22 @@ export function convert(source: string, destination: string) {
   if ('-' === source) {
     const rl = readline.createInterface({
       input: process.stdin,
-      terminal: false
-    });
+      terminal: false,
+    })
     const lines: string[] = []
-    rl.on("line", (line) => {
+    rl.on('line', (line) => {
       lines.push(line)
-    });
+    })
-    rl.on("close", () => {
+    rl.on('close', () => {
       const style = JSON.parse(lines.join(''))
       const destinationPath = getDestinationPath(destination)
       try {
-        writeYaml(destinationPath, style)
-      } catch(err) {
+        writeYaml(destinationPath, style, false)
+      } catch (err) {
         throw `${destinationPath}: Permission denied`
       }
     })
@@ -78,7 +59,7 @@ export function convert(source: string, destination: string) {
       sourcePath = source
     }
-    if (! fs.existsSync(sourcePath)) {
+    if (!fs.existsSync(sourcePath)) {
       throw `${sourcePath}: No such file or directory`
     }
@@ -87,8 +68,8 @@ export function convert(source: string, destination: string) {
     const destinationPath = getDestinationPath(destination, sourcePath)
     try {
-      writeYaml(destinationPath, style)
-    } catch(err) {
+      writeYaml(destinationPath, style, false)
+    } catch (err) {
       throw `${destinationPath}: Permission denied`
     }
   }

package/src/commands/init.ts CHANGED Viewed

@@ -1,29 +1,36 @@
-import path from 'path'
-import fs from 'fs'
-import YAML from 'js-yaml'
+import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec/types'
+import { writeYaml } from '../lib/yaml-writer'
+import {
+  TileJSONImporter,
+  MetadataJSONImporter,
+} from '../lib/tileinfo-importer'
-// TODO: We need type definition for style.
-const styleRoot = {
+export interface initOptions {
+  tilejsonUrls?: string
+  metadatajsonUrls?: string
+  compositeLayers?: boolean
+}
+const styleRoot: StyleSpecification = {
   version: 8,
-  name: "My Style",
-  sprite: "",
-  glyphs: "",
+  name: 'My Style',
+  sprite: '',
+  glyphs: '',
   sources: {},
-  layers: []
+  layers: [],
 }
-export function init(file: string) {
-  const styleYAML = YAML.dump(styleRoot)
-  let stylePath = path.resolve(process.cwd(), file)
-  // The `source` is absolute path.
-  if (file.match(/^\//)) {
-    stylePath = file
+export async function init(file: string, options: initOptions) {
+  let styleTemplate = JSON.parse(JSON.stringify(styleRoot))
+  if (options.tilejsonUrls) {
+    const tileJSONImporter = new TileJSONImporter(options.tilejsonUrls)
+    styleTemplate = await tileJSONImporter.import(styleTemplate)
   }
-  try {
-    fs.writeFileSync(stylePath, styleYAML)
-  } catch(err) {
-    throw `${stylePath}: Permission denied`
+  if (options.metadatajsonUrls) {
+    const metadataJSONImporter = new MetadataJSONImporter(
+      options.metadatajsonUrls,
+    )
+    styleTemplate = await metadataJSONImporter.import(styleTemplate)
   }
+  writeYaml(file, styleTemplate, options.compositeLayers)
 }