vega-cli 5.33.0 → 6.1.0

package/bin/vg2pdf

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 // Render a Vega specification to PDF, using node canvas
-const {createWriteStream} = require('fs'),
-      render = require('../src/render');
+import { createWriteStream } from 'fs';
+import render from '../src/render.js';
 
 render('pdf', function(canvas, arg) {
   const file = arg._[1] || null,

package/bin/vg2png

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 // Render a Vega specification to PNG, using node canvas
-const {createWriteStream} = require('fs'),
-      render = require('../src/render');
+import { createWriteStream } from 'fs';
+import render from '../src/render.js';
 
 render('png', function(canvas, arg) {
   const file = arg._[1] || null,

package/bin/vg2svg

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 // Render a Vega specification to SVG
-const {writeFile} = require('fs'),
-      render = require('../src/render');
+import { writeFile } from 'fs';
+import render from '../src/render.js';
 
 const svgHeader =
   '<?xml version="1.0" encoding="utf-8"?>\n' +

package/index.js

@@ -1 +1 @@
-module.exports = require('vega');
+export { default } from 'vega';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vega-cli",
-  "version": "5.33.0",
+  "version": "6.1.0",
   "description": "Command line utilities for server-side Vega.",
   "keywords": [
     "vega",
@@ -8,8 +8,17 @@
     "server"
   ],
   "license": "BSD-3-Clause",
-  "author": "Jeffrey Heer (http://idl.cs.washington.edu)",
-  "main": "index.js",
+  "type": "module",
+  "author": {
+    "name": "Vega",
+    "url": "https://vega.github.io"
+  },
+  "funding": {
+    "url": "https://app.hubspot.com/payments/GyPC972GD9Rt"
+  },
+  "exports": {
+    "default": "./build/index.js"
+  },
   "bin": {
     "vg2pdf": "./bin/vg2pdf",
     "vg2png": "./bin/vg2png",
@@ -20,9 +29,8 @@
     "test": "tape 'test/**/*-test.js'"
   },
   "dependencies": {
-    "canvas": "^2.11.2",
-    "vega": "5.33.0",
+    "canvas": "^3.1.0",
+    "vega": "6.1.0",
     "yargs": "17"
-  },
-  "gitHead": "ad0fb5d603df59a45ce560d6f3680c7c72ab45a9"
+  }
 }

package/src/args.js

@@ -1,5 +1,8 @@
-module.exports = function(type) {
-  const helpText = `Render a Vega specification to ${type.toUpperCase()}.
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+export default function (type) {
+    const helpText = `Render a Vega specification to ${type.toUpperCase()}.
 Usage: vg2${type} [vega_json_spec_file] [output_${type}_file]
   If no arguments are provided, reads from stdin.
   If output_${type}_file is not provided, writes to stdout.
@@ -8,52 +11,40 @@ Usage: vg2${type} [vega_json_spec_file] [output_${type}_file]
 To load data, you may need to set a base directory:
   For web retrieval, use '-b http://host/data/'.
   For files, use '-b file:///dir/data/' (absolute) or '-b data/' (relative).`;
-
-  const args = require('yargs')
-    .usage(helpText)
-    .demand(0);
-
-  args.string('b')
-    .alias('b', 'base')
-    .describe('b', 'Base directory for data loading. Defaults to the directory of the input spec.');
-
-  args.string('l')
-    .alias('l', 'loglevel')
-    .describe('l', 'Level of log messages written to stderr. One of "error", "warn" (default), "info", or "debug".');
-
-  args.string('c')
-    .alias('c', 'config')
-    .describe('c', 'Vega config object. Either a JSON file or a .js file that exports the config object.');
-
-  args.string('f')
-    .alias('f', 'format')
-    .describe('f', 'Number format locale descriptor. Either a JSON file or a .js file that exports the locale object.');
-
-  args.string('t')
-    .alias('t', 'timeFormat')
-    .describe('t', 'Date/time format locale descriptor. Either a JSON file or a .js file that exports the locale object.');
-
-  if (type === 'svg') {
-    args.boolean('h')
-      .alias('h', 'header')
-      .describe('h', 'Include XML header and SVG doctype.');
-  }
-
-  args.number('s')
-    .alias('s', 'scale')
-    .default('s', 1)
-    .describe('s', 'Output resolution scale factor.');
-
-  args.number('seed')
-    .describe('seed', 'Seed for random number generation.');
-
-  if (type === 'pdf') {
-    args.boolean('test')
-      .describe('test', 'Disable default PDF metadata for test suites.');
-  }
-  else if (type === 'png') {
-    args.number('ppi').describe('ppi', 'Resolution in ppi.');
-  }
-
-  return args.help().version().argv;
-};
+    const args = yargs(hideBin(process.argv)).usage(helpText)
+        .demand(0);
+    args.string('b')
+        .alias('b', 'base')
+        .describe('b', 'Base directory for data loading. Defaults to the directory of the input spec.');
+    args.string('l')
+        .alias('l', 'loglevel')
+        .describe('l', 'Level of log messages written to stderr. One of "error", "warn" (default), "info", or "debug".');
+    args.string('c')
+        .alias('c', 'config')
+        .describe('c', 'Vega config object. Either a JSON file or a .js file that exports the config object.');
+    args.string('f')
+        .alias('f', 'format')
+        .describe('f', 'Number format locale descriptor. Either a JSON file or a .js file that exports the locale object.');
+    args.string('t')
+        .alias('t', 'timeFormat')
+        .describe('t', 'Date/time format locale descriptor. Either a JSON file or a .js file that exports the locale object.');
+    if (type === 'svg') {
+        args.boolean('h')
+            .alias('h', 'header')
+            .describe('h', 'Include XML header and SVG doctype.');
+    }
+    args.number('s')
+        .alias('s', 'scale')
+        .default('s', 1)
+        .describe('s', 'Output resolution scale factor.');
+    args.number('seed')
+        .describe('seed', 'Seed for random number generation.');
+    if (type === 'pdf') {
+        args.boolean('test')
+            .describe('test', 'Disable default PDF metadata for test suites.');
+    }
+    else if (type === 'png') {
+        args.number('ppi').describe('ppi', 'Resolution in ppi.');
+    }
+    return args.help().version().argv;
+};

package/src/read.js

@@ -1,13 +1,12 @@
-const fs = require('fs');
+import fs from 'fs';
 
-module.exports = (file) => {
-  return new Promise((resolve, reject) => {
-    const input = file ? fs.createReadStream(file) : process.stdin;
-    let text = '';
-        
-    input.setEncoding('utf8');
-    input.on('error', err => { reject(err); });
-    input.on('data', chunk => { text += chunk; });
-    input.on('end', () => { resolve(text); });
-  });
+export default (file) => {
+    return new Promise((resolve, reject) => {
+        const input = file ? fs.createReadStream(file) : process.stdin;
+        let text = '';
+        input.setEncoding('utf8');
+        input.on('error', err => { reject(err); });
+        input.on('data', chunk => { text += chunk; });
+        input.on('end', () => { resolve(text); });
+    });
 };

package/src/render.js

@@ -1,67 +1,55 @@
-const vega = require('vega'),
-      path = require('path'),
-      args = require('./args'),
-      read = require('./read');
+import * as vega from 'vega';
+import path from 'path';
+import args from './args.js';
+import read from './read.js';
 
-function load(file) {
-  return require(path.resolve(file));
-}
+function load(file) {}
 
 const Levels = {
-  error: vega.Error,
-  warn:  vega.Warn,
-  info:  vega.Info,
-  debug: vega.Debug
+    error: vega.Error,
+    warn: vega.Warn,
+    info: vega.Info,
+    debug: vega.Debug
 };
 
-module.exports = function(type, callback, opt) {
-  // parse command line arguments
-  const arg = args(type);
-
-  // set baseURL, if specified. default to input spec directory
-  const base = arg.base || (arg._[0] ? path.dirname(arg._[0]) : null);
-
-  // set log level, defaults to logging warning messages
-  const loglevel = Levels[String(arg.loglevel).toLowerCase()] || vega.Warn;
-
-  // load config file, if specified
-  const config = arg.config ? load(arg.config) : null;
-
-  // set output image scale factor
-  const scale = arg.scale || undefined;
-
-  // Allows for other ppi settings than 72 for png files
-  const ppi = arg.ppi || 72;
-
-  // use a seeded random number generator, if specified
-  if (typeof arg.seed !== 'undefined') {
-    if (Number.isNaN(arg.seed)) throw 'Illegal seed value: must be a valid number.';
-    vega.setRandom(vega.randomLCG(arg.seed));
-  }
-
-  // locale options, load custom number/time formats if specified
-  const locale = {
-    number: arg.format ? load(arg.format) : null,
-    time: arg.timeFormat ? load(arg.timeFormat) : null
-  };
-
-  // instantiate view and invoke headless render method
-  function render(spec) {
-    const view = new vega.View(vega.parse(spec, config), {
-        locale: locale,                         // set locale options
-        loader: vega.loader({baseURL: base}),   // load files from base path
-        logger: vega.logger(loglevel, 'error'), // route all logging to stderr
-        renderer: 'none'                        // no primary renderer needed
-      }).finalize();                            // clear any timers, etc
-
-    return (type === 'svg'
-        ? view.toSVG(scale)
-        : view.toCanvas(scale * ppi / 72, opt)
-      ).then(_ => callback(_, arg));
-  }
-
-  // read input from file or stdin
-  read(arg._[0] || null)
-    .then(text => render(JSON.parse(text)))
-    .catch(err => { process.exitCode = 1; console.error(err); }); // eslint-disable-line no-console
+export default function(type, callback, opt) {
+    // parse command line arguments
+    const arg = args(type);
+    // set baseURL, if specified. default to input spec directory
+    const base = arg.base || (arg._[0] ? path.dirname(arg._[0]) : null);
+    // set log level, defaults to logging warning messages
+    const loglevel = Levels[String(arg.loglevel).toLowerCase()] || vega.Warn;
+    // load config file, if specified
+    const config = arg.config ? load(arg.config) : null;
+    // set output image scale factor
+    const scale = arg.scale || undefined;
+    // Allows for other ppi settings than 72 for png files
+    const ppi = arg.ppi || 72;
+    // use a seeded random number generator, if specified
+    if (typeof arg.seed !== 'undefined') {
+        if (Number.isNaN(arg.seed))
+            throw 'Illegal seed value: must be a valid number.';
+        vega.setRandom(vega.randomLCG(arg.seed));
+    }
+    // locale options, load custom number/time formats if specified
+    const locale = {
+        number: arg.format ? load(arg.format) : null,
+        time: arg.timeFormat ? load(arg.timeFormat) : null
+    };
+    // instantiate view and invoke headless render method
+    function render(spec) {
+        const view = new vega.View(vega.parse(spec, config), {
+            locale: locale, // set locale options
+            loader: vega.loader({ baseURL: base }), // load files from base path
+            logger: vega.logger(loglevel, 'error'), // route all logging to stderr
+            renderer: 'none' // no primary renderer needed
+        }).finalize(); // clear any timers, etc
+        return (type === 'svg'
+            ? view.toSVG(scale)
+            : view.toCanvas(scale * ppi / 72, opt)).then(_ => callback(_, arg));
+    }
+    // read input from file or stdin
+    read(arg._[0] || null)
+        .then(text => render(JSON.parse(text)))
+        .catch(err => { process.exitCode = 1; console.error(err); }); // eslint-disable-line no-console
 };

package/LICENSE

@@ -1,27 +0,0 @@
-Copyright (c) 2015-2023, University of Washington Interactive Data Lab
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-  may be used to endorse or promote products derived from this software
-  without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.