datagrok-tools 4.8.4 → 4.10.0

package/bin/commands/config.js

@@ -1,46 +1,28 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.config = config;
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
 var _fs = _interopRequireDefault(require("fs"));
-
 var _inquirer = _interopRequireDefault(require("inquirer"));
-
 var _os = _interopRequireDefault(require("os"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
-
 var _configValidator = require("../validators/config-validator");
-
 var color = _interopRequireWildcard(require("../utils/color-utils"));
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 var confTemplateDir = _path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'config-template.yaml');
-
 var confTemplate = _jsYaml["default"].load(_fs["default"].readFileSync(confTemplateDir, {
   encoding: 'utf-8'
 }));
-
 var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
-
 var confPath = _path["default"].join(grokDir, 'config.yaml');
-
 function validateKey(key) {
   if (!key || /^([A-Za-z\d-])+$/.test(key)) {
     return true;
@@ -48,7 +30,6 @@ function validateKey(key) {
     return 'Developer key may only include letters, numbers, or hyphens';
   }
 }
-
 function generateKeyQ(server, url) {
   var origin = new URL(url).origin;
   var question = {
@@ -57,18 +38,14 @@ function generateKeyQ(server, url) {
     message: "Developer key (get it from ".concat(origin, "/u or press ENTER to skip):"),
     validate: validateKey
   };
-
   if (server.startsWith('local')) {
     question.message = "Developer key for ".concat(origin, " (press ENTER to skip):");
   }
-
   return question;
 }
-
 function addNewServer(_x) {
   return _addNewServer.apply(this, arguments);
 }
-
 function _addNewServer() {
   _addNewServer = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(config) {
     var addServer, name, url, key;
@@ -80,7 +57,6 @@ function _addNewServer() {
               _context2.next = 21;
               break;
             }
-
             _context2.next = 3;
             return _inquirer["default"].prompt({
               name: 'add-server',
@@ -88,22 +64,18 @@ function _addNewServer() {
               message: 'Do you want to add a server?',
               "default": false
             });
-
           case 3:
             addServer = _context2.sent['add-server'];
-
             if (!addServer) {
               _context2.next = 18;
               break;
             }
-
             _context2.next = 7;
             return _inquirer["default"].prompt({
               name: 'server-name',
               type: 'input',
               message: 'Enter a name:'
             });
-
           case 7:
             name = _context2.sent['server-name'];
             _context2.next = 10;
@@ -112,12 +84,10 @@ function _addNewServer() {
               type: 'input',
               message: 'Enter a URL:'
             });
-
           case 10:
             url = _context2.sent['server-url'];
             _context2.next = 13;
             return _inquirer["default"].prompt(generateKeyQ(name, url));
-
           case 13:
             _context2.t0 = name;
             key = _context2.sent[_context2.t0];
@@ -127,14 +97,11 @@ function _addNewServer() {
             };
             _context2.next = 19;
             break;
-
           case 18:
             return _context2.abrupt("break", 21);
-
           case 19:
             _context2.next = 0;
             break;
-
           case 21:
           case "end":
             return _context2.stop();
@@ -144,25 +111,20 @@ function _addNewServer() {
   }));
   return _addNewServer.apply(this, arguments);
 }
-
 function config(args) {
   var nOptions = Object.keys(args).length - 1;
   var interactiveMode = args['_'].length === 1 && (nOptions < 1 || nOptions === 1 && args.reset);
   var hasAddServerCommand = args['_'].length === 2 && args['_'][1] === 'add' && args.server && args.key && args.k && args.alias && (nOptions === 4 || nOptions === 5 && args["default"]);
   if (!interactiveMode && !hasAddServerCommand) return false;
-
   if (!_fs["default"].existsSync(grokDir)) {
     _fs["default"].mkdirSync(grokDir);
   }
-
   if (!_fs["default"].existsSync(confPath) || args.reset) {
     _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(confTemplate));
   }
-
   var config = _jsYaml["default"].load(_fs["default"].readFileSync(confPath, {
     encoding: 'utf-8'
   }));
-
   if (hasAddServerCommand) {
     try {
       new URL(args.server);
@@ -170,32 +132,25 @@ function config(args) {
       color.error('URL parsing error. Please, provide a valid server URL.');
       return false;
     }
-
     config.servers[args.alias] = {
       url: args.server,
       key: args.key
     };
     color.success("Successfully added the server to ".concat(confPath, "."));
     console.log("Use this command to deploy packages: grok publish ".concat(args.alias));
-
     if (args["default"]) {
       config["default"] = args.alias;
     }
-
     _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(config));
-
     return true;
   }
-
   console.log("Your config file (".concat(confPath, "):"));
   console.log(config);
   var valRes = (0, _configValidator.validateConf)(config);
-
   if (!config || !valRes.value) {
     color.error(valRes.message);
     return false;
   }
-
   if (valRes.warnings.length) color.warn(valRes.warnings.join('\n'));
   (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
     var answers, server, url, question, devKey, defaultServer;
@@ -211,40 +166,32 @@ function config(args) {
               message: 'Do you want to edit it?',
               "default": false
             });
-
           case 3:
             answers = _context.sent;
-
             if (!answers['edit-config']) {
               _context.next = 24;
               break;
             }
-
             _context.t0 = _regenerator["default"].keys(config.servers);
-
           case 6:
             if ((_context.t1 = _context.t0()).done) {
               _context.next = 17;
               break;
             }
-
             server = _context.t1.value;
             url = config['servers'][server]['url'];
             question = generateKeyQ(server, url);
             question["default"] = config['servers'][server]['key'];
             _context.next = 13;
             return _inquirer["default"].prompt(question);
-
           case 13:
             devKey = _context.sent;
             config['servers'][server]['key'] = devKey[server];
             _context.next = 6;
             break;
-
           case 17:
             _context.next = 19;
             return addNewServer(config);
-
           case 19:
             _context.next = 21;
             return _inquirer["default"].prompt({
@@ -260,24 +207,19 @@ function config(args) {
               },
               "default": config["default"]
             });
-
           case 21:
             defaultServer = _context.sent;
             config["default"] = defaultServer['default-server'];
-
             _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(config));
-
           case 24:
             _context.next = 31;
             break;
-
           case 26:
             _context.prev = 26;
             _context.t2 = _context["catch"](0);
             color.error('The file is corrupted. Please run `grok config --reset` to restore the default template');
             console.error(_context.t2);
             return _context.abrupt("return", false);
-
           case 31:
           case "end":
             return _context.stop();
@@ -285,8 +227,6 @@ function config(args) {
       }
     }, _callee, null, [[0, 26]]);
   }))();
-
   _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(config));
-
   return true;
 }

package/bin/commands/create.js

@@ -1,82 +1,50 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.create = create;
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _fs = _interopRequireDefault(require("fs"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _os = _interopRequireDefault(require("os"));
-
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
-
 var _child_process = require("child_process");
-
 var _entHelpers = require("../utils/ent-helpers");
-
 var utils = _interopRequireWildcard(require("../utils/utils"));
-
 var color = _interopRequireWildcard(require("../utils/color-utils"));
-
 var _configValidator = require("../validators/config-validator");
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 var platform = _os["default"].platform();
-
 var curDir = process.cwd();
-
 var curFolder = _path["default"].basename(curDir);
-
 var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
-
 var confPath = _path["default"].join(grokDir, 'config.yaml');
-
 var templateDir = _path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'package-template');
-
 var confTemplateDir = _path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'config-template.yaml');
-
 var confTemplate = _jsYaml["default"].load(_fs["default"].readFileSync(confTemplateDir, {
   encoding: 'utf-8'
 }));
-
 var dependencies = [];
-
 function createDirectoryContents(name, config, templateDir, packageDir) {
   var ide = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : '';
   var ts = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : true;
   var eslint = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : false;
   var test = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : false;
-
   var filesToCreate = _fs["default"].readdirSync(templateDir);
-
   filesToCreate.forEach(function (file) {
     var origFilePath = _path["default"].join(templateDir, file);
-
     var copyFilePath = _path["default"].join(packageDir, file);
-
     var stats = _fs["default"].statSync(origFilePath);
-
     if (stats.isFile()) {
       if (file === 'package.png') {
         _fs["default"].writeFileSync(copyFilePath, _fs["default"].readFileSync(origFilePath, 'base64'), 'base64');
-
         return false;
       }
-
       var contents = _fs["default"].readFileSync(file === 'webpack.config.js' && ts ? _path["default"].join(templateDir, 'ts.webpack.config.js') : origFilePath, 'utf8');
-
       contents = contents.replace(/#{PACKAGE_NAME}/g, name);
       contents = contents.replace(/#{PACKAGE_DETECTORS_NAME}/g, utils.kebabToCamelCase(name));
       contents = contents.replace(/#{PACKAGE_NAME_LOWERCASE}/g, name.toLowerCase());
@@ -84,22 +52,18 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
       contents = utils.replacers['PACKAGE_NAMESPACE'](contents, name);
       contents = contents.replace(/#{GROK_HOST_ALIAS}/g, config["default"]);
       contents = contents.replace(/#{GROK_HOST}/g, /localhost|127\.0\.0\.1/.test(config['servers'][config["default"]]['url']) ? 'http://localhost:63343/login.html' : new URL(config['servers'][config["default"]]['url']).origin);
-
       if (file === 'package.json') {
         // Generate scripts for non-default servers from `config.yaml`
         var _package = JSON.parse(contents);
-
         for (var server in config.servers) {
           if (server === config["default"]) continue;
           _package['scripts']["debug-".concat(name.toLowerCase(), "-").concat(server)] = "webpack && grok publish ".concat(server);
           _package['scripts']["release-".concat(name.toLowerCase(), "-").concat(server)] = "webpack && grok publish ".concat(server, " --release");
         }
-
         if (ts) Object.assign(_package.devDependencies, {
           'ts-loader': 'latest',
           'typescript': 'latest'
         });
-
         if (eslint) {
           Object.assign(_package.devDependencies, {
             'eslint': 'latest',
@@ -113,7 +77,6 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
             'lint-fix': "eslint src".concat(ts ? ' --ext .ts' : '', " --fix")
           });
         }
-
         if (test) {
           Object.assign(_package.dependencies, {
             '@datagrok-libraries/utils': 'latest'
@@ -121,58 +84,47 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
           Object.assign(_package.scripts, {
             'test': 'grok test'
           });
-        } // Save module names for installation prompt
-
+        }
 
+        // Save module names for installation prompt
         for (var _i = 0, _Object$entries = Object.entries(Object.assign({}, _package.dependencies, _package.devDependencies)); _i < _Object$entries.length; _i++) {
           var _Object$entries$_i = (0, _slicedToArray2["default"])(_Object$entries[_i], 2),
-              module = _Object$entries$_i[0],
-              tag = _Object$entries$_i[1];
-
+            module = _Object$entries$_i[0],
+            tag = _Object$entries$_i[1];
           dependencies.push("".concat(module, "@").concat(tag));
         }
-
-        contents = JSON.stringify(_package, null, '\t');
+        contents = JSON.stringify(_package, null, 2);
       }
-
       if (file === 'package.js' && ts) copyFilePath = _path["default"].join(packageDir, 'package.ts');
       if (file === 'package-test.js' && ts) return false;
       if (file === 'package-test.ts' && !ts) return false;
       if (file === 'tsconfig.json' && !ts) return false;
       if (file === 'ts.webpack.config.js') return false;
-
       if (file === '.eslintrc.json') {
         if (!eslint) return false;
-
         if (ts) {
           var eslintConf = JSON.parse(contents);
           eslintConf.parser = '@typescript-eslint/parser';
           eslintConf.plugins = ['@typescript-eslint'];
-          contents = JSON.stringify(eslintConf, null, '\t');
+          contents = JSON.stringify(eslintConf, null, 2);
         }
       }
-
       if (file === 'gitignore') {
         copyFilePath = _path["default"].join(packageDir, '.gitignore');
         if (ts) contents += '\n# Emitted *.js files\nsrc/**/*.js\n';
       }
-
       if (file === 'npmignore') {
         copyFilePath = _path["default"].join(packageDir, '.npmignore');
       }
-
       _fs["default"].writeFileSync(copyFilePath, contents, 'utf8');
     } else if (stats.isDirectory()) {
       if (file === '.vscode' && !(ide == 'vscode' && platform == 'win32')) return;
-
-      _fs["default"].mkdirSync(copyFilePath); // recursive call
-
-
+      _fs["default"].mkdirSync(copyFilePath);
+      // recursive call
       createDirectoryContents(name, config, origFilePath, copyFilePath, ide, ts, eslint, test);
     }
   });
 }
-
 function create(args) {
   var options = ['ide', 'js', 'ts', 'eslint', 'test'];
   var nOptions = Object.keys(args).length - 1;
@@ -182,43 +134,35 @@ function create(args) {
     return options.includes(op);
   })) return false;
   if (args.js && args.ts) return color.error('Incompatible options: --js and --ts');
-  var ts = !args.js && args.ts !== false; // Create `config.yaml` if it doesn't exist yet
+  var ts = !args.js && args.ts !== false;
 
+  // Create `config.yaml` if it doesn't exist yet
   if (!_fs["default"].existsSync(grokDir)) _fs["default"].mkdirSync(grokDir);
   if (!_fs["default"].existsSync(confPath)) _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(confTemplate));
-
   var config = _jsYaml["default"].load(_fs["default"].readFileSync(confPath, {
     encoding: 'utf-8'
   }));
-
   var confTest = (0, _configValidator.validateConf)(config);
-
   if (!confTest.value) {
     color.error(confTest.message);
     return false;
   }
-
   var name = nArgs === 2 ? args['_'][1] : curFolder;
   var validName = /^([A-Za-z\-_\d])+$/.test(name);
-
   if (validName) {
     var packageDir = curDir;
     var repositoryInfo = null;
-
     if (curFolder !== name) {
       packageDir = _path["default"].join(packageDir, name);
-
       if (!_fs["default"].existsSync(packageDir)) {
         _fs["default"].mkdirSync(packageDir);
       }
     }
-
     if (!utils.isEmpty(packageDir)) {
       console.log();
       color.error('The package directory should be empty');
       return false;
     }
-
     (0, _child_process.exec)('git rev-parse --is-inside-work-tree', {
       cwd: packageDir
     }, function (err) {
@@ -244,13 +188,10 @@ function create(args) {
     process.on('beforeExit', function () {
       if (repositoryInfo) {
         var packagePath = _path["default"].join(packageDir, 'package.json');
-
         var p = JSON.parse(_fs["default"].readFileSync(packagePath, 'utf-8'));
         p.repository = repositoryInfo;
-
-        _fs["default"].writeFileSync(packagePath, JSON.stringify(p, null, '\t'), 'utf-8');
+        _fs["default"].writeFileSync(packagePath, JSON.stringify(p, null, 2), 'utf-8');
       }
-
       process.exit();
     });
     createDirectoryContents(name, config, templateDir, packageDir, args.ide, ts, !!args.eslint, !!args.test);
@@ -266,6 +207,5 @@ function create(args) {
   } else {
     color.error('Package name may only include letters, numbers, underscores, or hyphens');
   }
-
   return true;
 }

package/bin/commands/help.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.help = void 0;
-var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCommands:\n    add       Add an object template\n    api       Create wrapper functions\n    check     Check package content (function signatures, etc.)\n    config    Create and manage config files\n    create    Create a package\n    init      Modify a package template\n    link      Link `datagrok-api` and libraries for local development\n    unlink    Revert `grok link`\n    publish   Upload a package\n    test      Run package tests\n\nTo get help on a particular command, use:\n    grok <command> --help\n\nRead more about the package development workflow:\nhttps://datagrok.ai/help/develop/develop\n";
+var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCommands:\n    add       Add an object template\n    api       Create wrapper functions\n    check     Check package content (function signatures, etc.)\n    config    Create and manage config files\n    create    Create a package\n    init      Modify a package template\n    link      Link `datagrok-api` and libraries for local development\n    publish   Upload a package\n    test      Run package tests\n\nTo get help on a particular command, use:\n    grok <command> --help\n\nRead more about the package development workflow:\nhttps://datagrok.ai/help/develop/develop\n";
 var HELP_ADD = "\nUsage: grok add <entity> <name>\n\nAdd an object template to your package:\n\ngrok add app <name>\ngrok add connection <name>\ngrok add detector <semantic-type-name>\ngrok add function [tag] <name>\ngrok add query <name>\ngrok add script [tag] <language> <name>\ngrok add view <name>\ngrok add viewer <name>\ngrok add tests\n\nPlease note that entity names may only include letters and numbers\n\nSupported languages for scripts:\njavascript, julia, node, octave, python, r\n\nAvailable tags:\npanel, init\n";
 var HELP_INIT = "\nUsage: grok init\n\nModify a package template by adding config files for linters, IDE, etc.\n\nOptions:\n[--eslint] [--ide] [--test] [--ts]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--test      Add tests support (TypeScript packages only)\n--ts        Convert a JavaScript package to TypeScript\n";
 var HELP_API = "\nUsage: grok api\n\nCreate wrapper functions for package scripts and queries\n";
@@ -13,8 +13,7 @@ var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok crea
 var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:\n[--build|--rebuild] [--debug|--release] [-k | --key] [--suffix]\n\nRunning `grok publish` is the same as running `grok publish defaultHost --build --debug`\n";
 var HELP_CHECK = "\nUsage: grok check\n\nOptions:\n[-r | --recursive]\n\n--recursive       Check all packages in the current directory\n\nCheck package content (function signatures, import statements of external modules, etc.)\n";
 var HELP_TEST = "\nUsage: grok test\n\nOptions:\n[--host] [--csv]\n\n--host           Host alias as in the config file\n--csv            Save the test report in a CSV file\n--gui            Launch graphical interface (non-headless mode)\n--skip-build     Skip the package build step\n--skip-publish   Skip the package publication step\n\nRun package tests\n\nSee instructions:\nhttps://datagrok.ai/help/develop/how-to/test-packages#local-testing\n";
-var HELP_LINK = "\nUsage: grok link\n\nLink `datagrok-api` and libraries for local development\n";
-var HELP_UNLINK = "\nUsage: grok unlink\n\nRevert `grok link`\n";
+var HELP_LINK = "\nUsage: grok link\n\nLink `datagrok-api` and libraries for local development\n\nOptions:\n[--local | --npm]\n\n--local   Default. Links libraries and updates package scripts (\"link-all\", \"build-all\")\n--npm     Unlinks local packages and runs `npm i`\n";
 var HELP_MIGRATE = "\nUsage: grok migrate\n\nSwitch to `grok` tools by copying your keys to the config\nfile and converting your scripts in the `package.json` file\n";
 var help = {
   add: HELP_ADD,
@@ -24,7 +23,6 @@ var help = {
   create: HELP_CREATE,
   init: HELP_INIT,
   link: HELP_LINK,
-  unlink: HELP_UNLINK,
   publish: HELP_PUBLISH,
   test: HELP_TEST,
   help: HELP