datagrok-tools 4.7.11 → 4.8.1

package/README.md

@@ -61,7 +61,7 @@ Read more about package development in [Datagrok's documentation](https://datagr
   - `--ide` adds an IDE-specific configuration for debugging (vscode)
   - `--js` creates a JavaScript package template
   - `--ts` creates a TypeScript package template (default)
-  - `--jest` adds a basic configuration for `jest`
+  - `--test` adds tests support to package
 - `add` puts an object template to your package:
 
   ```shell
@@ -100,6 +100,8 @@ Read more about package development in [Datagrok's documentation](https://datagr
   Running `grok publish` is the same as running `grok publish defaultHost --build --debug`.
 - `check` checks package content (function signatures, import statements of external modules,
   etc.). The check is also run during package publication.
+- `init` modifies a package template by adding config files for linters, IDE, and so on
+  (applies the same options as `create`).
 - `test` runs package tests. First, it builds a package and publishes it (these
   steps can be skipped with flags `--skip-build` and `--skip-publish`
   correspondingly).

package/bin/commands/check.js

@@ -13,6 +13,8 @@ exports.checkImportStatements = checkImportStatements;
 exports.checkPackageFile = checkPackageFile;
 exports.extractExternals = extractExternals;
 
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
@@ -39,19 +41,38 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 
 function check(args) {
   var nOptions = Object.keys(args).length - 1;
-  if (args['_'].length !== 1 || nOptions > 0 && (!args.dir || typeof args.dir !== 'string') || nOptions > 1) return false;
+  if (args['_'].length !== 1 || nOptions > 2 || nOptions > 0 && !args.r && !args.recursive) return false;
   var curDir = process.cwd();
 
-  if (args.dir && typeof args.dir === 'string') {
-    var packagesDir = _path["default"].isAbsolute(args.dir) ? args.dir : _path["default"].join(curDir, args.dir);
+  if (args.recursive) {
+    var runChecksRec = function runChecksRec(dir) {
+      var files = _fs["default"].readdirSync(dir);
+
+      var _iterator = _createForOfIteratorHelper(files),
+          _step;
 
-    _fs["default"].readdirSync(packagesDir).forEach(function (file) {
-      var filepath = _path["default"].join(packagesDir, file);
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var file = _step.value;
 
-      var stats = _fs["default"].statSync(filepath);
+          var filepath = _path["default"].join(dir, file);
 
-      if (stats.isDirectory() && utils.isPackageDir(filepath)) runChecks(filepath);
-    });
+          var stats = _fs["default"].statSync(filepath);
+
+          if (stats.isDirectory()) {
+            if (utils.isPackageDir(filepath)) runChecks(filepath);else {
+              if (file !== 'node_modules' && !file.startsWith('.')) runChecksRec(_path["default"].join(dir, file));
+            }
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+    };
+
+    runChecksRec(curDir);
   } else {
     if (!utils.isPackageDir(curDir)) {
       color.error('File `package.json` not found. Run the command from the package directory');
@@ -80,17 +101,22 @@ function check(args) {
 
     var isWebpack = _fs["default"].existsSync(webpackConfigPath);
 
+    var externals = null;
+
     if (isWebpack) {
       var content = _fs["default"].readFileSync(webpackConfigPath, {
         encoding: 'utf-8'
       });
 
-      var externals = extractExternals(content);
+      externals = extractExternals(content);
       if (externals) warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkImportStatements(packagePath, jsTsFiles, externals)));
     }
 
     warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkFuncSignatures(packagePath, funcFiles)));
-    warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkPackageFile(packagePath)));
+    warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkPackageFile(packagePath, {
+      isWebpack: isWebpack,
+      externals: externals
+    })));
 
     if (warnings.length) {
       console.log("Checking package ".concat(_path["default"].basename(packagePath), "..."));
@@ -102,12 +128,12 @@ function check(args) {
 }
 
 function extractExternals(config) {
-  var externalsRegex = /(?<=externals\s*:\s*)(\{[\S\s]*?\})/;
+  var externalsRegex = /(?<=externals)\s*:\s*(\{[\S\s]*?\})/;
   var match = config.match(externalsRegex);
 
   if (match) {
-    // Replace single quotes and a trailing comma to make a string JSON-like
-    var externalStr = match[1].replace(/'/g, '"').replace(/(?<=[\S\s]),(?=\s*\})/, '');
+    // Replace single quotes, comments, and a trailing comma to make a string JSON-like
+    var externalStr = match[1].replace(/'/g, '"').replace(/\/\/.*(\r\n|\r|\n)/, '').replace(/(?<=[\S\s]),(?=\s*\})/, '');
 
     try {
       var externals = JSON.parse(externalStr);
@@ -123,9 +149,9 @@ function extractExternals(config) {
 function checkImportStatements(packagePath, files, externals) {
   var modules = [];
 
-  for (var key in externals) {
-    modules.push(key);
-    if (key.includes('/')) modules.push(key.split('/', 1)[0]);
+  for (var _key in externals) {
+    modules.push(_key);
+    if (_key.includes('/')) modules.push(_key.split('/', 1)[0]);
   }
 
   var importRegex = new RegExp("^(?!\\/{2})\\s*import\\s+.*(".concat(modules.join('|'), ").*(?=\\s+?)"), 'g');
@@ -141,12 +167,12 @@ function checkImportStatements(packagePath, files, externals) {
     };
   }
 
-  var _iterator = _createForOfIteratorHelper(files),
-      _step;
+  var _iterator2 = _createForOfIteratorHelper(files),
+      _step2;
 
   try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var file = _step.value;
+    for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var file = _step2.value;
 
       var content = _fs["default"].readFileSync(_path["default"].join(packagePath, file), {
         encoding: 'utf-8'
@@ -155,26 +181,26 @@ function checkImportStatements(packagePath, files, externals) {
       var matchedImports = content.match(importRegex);
 
       if (matchedImports) {
-        var _iterator2 = _createForOfIteratorHelper(matchedImports),
-            _step2;
+        var _iterator3 = _createForOfIteratorHelper(matchedImports),
+            _step3;
 
         try {
-          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-            var match = _step2.value;
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var match = _step3.value;
             var vr = validateImport(file, match);
             if (!vr.value) warnings.push(vr.message);
           }
         } catch (err) {
-          _iterator2.e(err);
+          _iterator3.e(err);
         } finally {
-          _iterator2.f();
+          _iterator3.f();
         }
       }
     }
   } catch (err) {
-    _iterator.e(err);
+    _iterator2.e(err);
   } finally {
-    _iterator.f();
+    _iterator2.f();
   }
 
   return warnings;
@@ -183,9 +209,33 @@ function checkImportStatements(packagePath, files, externals) {
 function checkFuncSignatures(packagePath, files) {
   var warnings = [];
   var checkFunctions = {
-    semTypeDetector: function semTypeDetector(_ref) {
-      var inputs = _ref.inputs,
-          outputs = _ref.outputs;
+    app: function app(_ref) {
+      var name = _ref.name;
+      var value = true;
+      var message = '';
+
+      if (name && typeof name === 'string') {
+        var lowerCaseName = name.toLocaleLowerCase();
+
+        if (lowerCaseName.startsWith('app')) {
+          value = false;
+          message += 'Prefix "App" is not needed. Consider removing it.\n';
+        }
+
+        if (lowerCaseName.endsWith('app')) {
+          value = false;
+          message += 'Postfix "App" is not needed. Consider removing it.\n';
+        }
+      }
+
+      return {
+        value: value,
+        message: message
+      };
+    },
+    semTypeDetector: function semTypeDetector(_ref2) {
+      var inputs = _ref2.inputs,
+          outputs = _ref2.outputs;
       var value = true;
       var message = '';
 
@@ -204,9 +254,9 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    cellRenderer: function cellRenderer(_ref2) {
-      var inputs = _ref2.inputs,
-          outputs = _ref2.outputs;
+    cellRenderer: function cellRenderer(_ref3) {
+      var inputs = _ref3.inputs,
+          outputs = _ref3.outputs;
       var value = true;
       var message = '';
 
@@ -225,9 +275,9 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    viewer: function viewer(_ref3) {
-      var inputs = _ref3.inputs,
-          outputs = _ref3.outputs;
+    viewer: function viewer(_ref4) {
+      var inputs = _ref4.inputs,
+          outputs = _ref4.outputs;
       var value = true;
       var message = '';
 
@@ -246,10 +296,10 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    fileViewer: function fileViewer(_ref4) {
-      var inputs = _ref4.inputs,
-          outputs = _ref4.outputs,
-          tags = _ref4.tags;
+    fileViewer: function fileViewer(_ref5) {
+      var inputs = _ref5.inputs,
+          outputs = _ref5.outputs,
+          tags = _ref5.tags;
       var value = true;
       var message = '';
 
@@ -275,8 +325,8 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    fileExporter: function fileExporter(_ref5) {
-      var description = _ref5.description;
+    fileExporter: function fileExporter(_ref6) {
+      var description = _ref6.description;
       var value = true;
       var message = '';
 
@@ -290,8 +340,8 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    packageSettingsEditor: function packageSettingsEditor(_ref6) {
-      var outputs = _ref6.outputs;
+    packageSettingsEditor: function packageSettingsEditor(_ref7) {
+      var outputs = _ref7.outputs;
       var value = true;
       var message = '';
 
@@ -308,12 +358,12 @@ function checkFuncSignatures(packagePath, files) {
   };
   var functionRoles = Object.keys(checkFunctions);
 
-  var _iterator3 = _createForOfIteratorHelper(files),
-      _step3;
+  var _iterator4 = _createForOfIteratorHelper(files),
+      _step4;
 
   try {
-    for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
-      var file = _step3.value;
+    for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+      var file = _step4.value;
 
       var content = _fs["default"].readFileSync(_path["default"].join(packagePath, file), {
         encoding: 'utf-8'
@@ -321,12 +371,12 @@ function checkFuncSignatures(packagePath, files) {
 
       var functions = getFuncMetadata(content);
 
-      var _iterator4 = _createForOfIteratorHelper(functions),
-          _step4;
+      var _iterator5 = _createForOfIteratorHelper(functions),
+          _step5;
 
       try {
         var _loop = function _loop() {
-          var f = _step4.value;
+          var f = _step5.value;
           var roles = functionRoles.filter(function (role) {
             var _f$tags;
 
@@ -341,25 +391,43 @@ function checkFuncSignatures(packagePath, files) {
           }
         };
 
-        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
           _loop();
         }
       } catch (err) {
-        _iterator4.e(err);
+        _iterator5.e(err);
       } finally {
-        _iterator4.f();
+        _iterator5.f();
       }
     }
   } catch (err) {
-    _iterator3.e(err);
+    _iterator4.e(err);
   } finally {
-    _iterator3.f();
+    _iterator4.f();
   }
 
   return warnings;
 }
 
-function checkPackageFile(packagePath) {
+var sharedLibExternals = {
+  'common/html2canvas.min.js': {
+    'exceljs': 'ExcelJS'
+  },
+  'common/exceljs.min.js': {
+    'html2canvas': 'html2canvas'
+  },
+  'common/ngl_viewer/ngl.js': {
+    'NGL': 'NGL'
+  },
+  'common/openchemlib-full.js': {
+    'openchemlib/full': 'OCL'
+  },
+  'common/codemirror/codemirror.js': {
+    'codemirror': 'CodeMirror'
+  }
+};
+
+function checkPackageFile(packagePath, options) {
   var warnings = [];
 
   var packageFilePath = _path["default"].join(packagePath, 'package.json');
@@ -371,18 +439,18 @@ function checkPackageFile(packagePath) {
   if (!json.description) warnings.push('File "package.json": "description" field is empty. Provide a package description.');
 
   if (Array.isArray(json.properties) && json.properties.length > 0) {
-    var _iterator5 = _createForOfIteratorHelper(json.properties),
-        _step5;
+    var _iterator6 = _createForOfIteratorHelper(json.properties),
+        _step6;
 
     try {
-      for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-        var propInfo = _step5.value;
+      for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+        var propInfo = _step6.value;
         if ((0, _typeof2["default"])(propInfo) !== 'object') warnings.push('File "package.json": Invalid property annotation in the "properties" field.');else if (!propInfo.name) warnings.push('File "package.json": Add a property name for each property in the "properties" field.');else if (!utils.propertyTypes.includes(propInfo.propertyType)) warnings.push("File \"package.json\": Invalid property type for property ".concat(propInfo.name, "."));
       }
     } catch (err) {
-      _iterator5.e(err);
+      _iterator6.e(err);
     } finally {
-      _iterator5.f();
+      _iterator6.f();
     }
   }
 
@@ -390,21 +458,44 @@ function checkPackageFile(packagePath) {
   if (json.author == null && isPublicPackage) warnings.push('File "package.json": add the "author" field.');
 
   if (Array.isArray(json.sources) && json.sources.length > 0) {
-    var _iterator6 = _createForOfIteratorHelper(json.sources),
-        _step6;
+    var _iterator7 = _createForOfIteratorHelper(json.sources),
+        _step7;
 
     try {
-      for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
-        var source = _step6.value;
+      for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+        var source = _step7.value;
         if (typeof source !== 'string') warnings.push("File \"package.json\": Only file paths and URLs are allowed in sources. Modify the source ".concat(source));
-        if (source.startsWith('common/') || utils.absUrlRegex.test(source)) continue;
+        if (utils.absUrlRegex.test(source)) continue;
+
+        if (source.startsWith('common/')) {
+          if (options !== null && options !== void 0 && options.isWebpack && source.endsWith('.js')) {
+            if (options !== null && options !== void 0 && options.externals) {
+              if (source in sharedLibExternals) {
+                var _Object$entries$ = (0, _slicedToArray2["default"])(Object.entries(sharedLibExternals[source])[0], 2),
+                    _lib = _Object$entries$[0],
+                    name = _Object$entries$[1];
+
+                if (!(_lib in options.externals && options.externals[_lib] === name)) {
+                  warnings.push("Webpack config parsing: Consider adding source \"".concat(source, "\" to webpack externals:\n") + "'".concat(_lib, "': '").concat(name, "'\n"));
+                }
+              } else {
+                warnings.push("File \"package.json\": source \"".concat(source, "\" not in the list of shared libraries"));
+              }
+            } else {
+              warnings.push('Webpack config parsing: External modules not found.\n' + "Consider adding source \"".concat(source, "\" to webpack externals") + (source in sharedLibExternals ? ':\n' + "'".concat(Object.keys(sharedLibExternals[source])[0], "': '").concat(Object.values(sharedLibExternals[source])[0], "'\n") : ''));
+            }
+          }
+
+          continue;
+        }
+
         if (source.startsWith('src/') && _fs["default"].existsSync(_path["default"].join(packagePath, 'webpack.config.js'))) warnings.push('File "package.json": Sources cannot include files from the \`src/\` directory. ' + "Move file ".concat(source, " to another folder."));
         if (!_fs["default"].existsSync(_path["default"].join(packagePath, source))) warnings.push("Source ".concat(source, " not found in the package."));
       }
     } catch (err) {
-      _iterator6.e(err);
+      _iterator7.e(err);
     } finally {
-      _iterator6.f();
+      _iterator7.f();
     }
   }
 
@@ -426,12 +517,12 @@ function getFuncMetadata(script) {
     outputs: []
   };
 
-  var _iterator7 = _createForOfIteratorHelper(script.split('\n')),
-      _step7;
+  var _iterator8 = _createForOfIteratorHelper(script.split('\n')),
+      _step8;
 
   try {
-    for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
-      var line = _step7.value;
+    for (_iterator8.s(); !(_step8 = _iterator8.n()).done;) {
+      var line = _step8.value;
       if (!line) continue;
       var match = line.match(utils.paramRegex);
 
@@ -463,9 +554,9 @@ function getFuncMetadata(script) {
       }
     }
   } catch (err) {
-    _iterator7.e(err);
+    _iterator8.e(err);
   } finally {
-    _iterator7.f();
+    _iterator8.f();
   }
 
   return funcData;

package/bin/commands/create.js

@@ -57,7 +57,7 @@ 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 jest = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : false;
+  var test = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : false;
 
   var filesToCreate = _fs["default"].readdirSync(templateDir);
 
@@ -114,7 +114,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
           });
         }
 
-        if (jest) {
+        if (test) {
           Object.assign(_package.dependencies, {
             '@datagrok-libraries/utils': 'latest'
           });
@@ -168,13 +168,13 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
       _fs["default"].mkdirSync(copyFilePath); // recursive call
 
 
-      createDirectoryContents(name, config, origFilePath, copyFilePath, ide, ts, eslint, jest);
+      createDirectoryContents(name, config, origFilePath, copyFilePath, ide, ts, eslint, test);
     }
   });
 }
 
 function create(args) {
-  var options = ['ide', 'js', 'ts', 'eslint', 'jest'];
+  var options = ['ide', 'js', 'ts', 'eslint', 'test'];
   var nOptions = Object.keys(args).length - 1;
   var nArgs = args['_'].length;
   if (nArgs > 2 || nOptions > 4) return false;
@@ -253,7 +253,7 @@ function create(args) {
 
       process.exit();
     });
-    createDirectoryContents(name, config, templateDir, packageDir, args.ide, ts, !!args.eslint, !!args.jest);
+    createDirectoryContents(name, config, templateDir, packageDir, args.ide, ts, !!args.eslint, !!args.test);
     color.success('Successfully created package ' + name);
     console.log(_entHelpers.help["package"](ts));
     console.log("\nThe package has the following dependencies:\n".concat(dependencies.join(' '), "\n"));

package/bin/commands/help.js

@@ -4,13 +4,14 @@ 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    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    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_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";
-var HELP_CONFIG = "\nUsage: grok config\n\nCreate or update a configuration file\n\nOptions:\n[--reset] [--server] [--alias] [--key]\n\n--reset     Restore the default config file template\n--server    Use to add a server to the config (`grok config add --alias alias --server url --key key`)\n--alias     Use in conjunction with the `server` option to set the server name\n--key       Use in conjunction with the `server` option to set the developer key\n--default   Use in conjunction with the `server` option to set the added server as default\n";
-var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--js|--ts]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--js        Create a JavaScript package\n--ts        Create a TypeScript package (default)\n";
-var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:\n[--build|--rebuild] [--debug|--release] [--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[--dir]\n\n--dir       Check all packages in a specified directory\n\nCheck package content (function signatures, import statements of external modules, etc.)\n";
+var HELP_CONFIG = "\nUsage: grok config\n\nCreate or update a configuration file\n\nOptions:\n[--reset] [--server] [--alias] [-k | --key]\n\n--reset     Restore the default config file template\n--server    Use to add a server to the config (`grok config add --alias alias --server url --key key`)\n--alias     Use in conjunction with the `server` option to set the server name\n--key       Use in conjunction with the `server` option to set the developer key\n--default   Use in conjunction with the `server` option to set the added server as default\n";
+var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--js | --ts] [--test]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--js        Create a JavaScript package\n--ts        Create a TypeScript package (default)\n--test      Add tests support (TypeScript packages only)\n";
+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";
@@ -21,6 +22,7 @@ var help = {
   check: HELP_CHECK,
   config: HELP_CONFIG,
   create: HELP_CREATE,
+  init: HELP_INIT,
   link: HELP_LINK,
   unlink: HELP_UNLINK,
   publish: HELP_PUBLISH,

package/bin/commands/init.js

@@ -0,0 +1,253 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.init = init;
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _os = _interopRequireDefault(require("os"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _jsYaml = _interopRequireDefault(require("js-yaml"));
+
+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; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var curDir = process.cwd();
+
+var platform = _os["default"].platform();
+
+var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
+
+var confPath = _path["default"].join(grokDir, 'config.yaml');
+
+var packageJsonPath = _path["default"].join(curDir, 'package.json');
+
+var tsConfigPath = _path["default"].join(curDir, 'tsconfig.json');
+
+var webpackConfigPath = _path["default"].join(curDir, 'webpack.config.js');
+
+var templateDir = _path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'package-template');
+
+function init(args) {
+  var options = ['ide', 'eslint', 'test', 'ts'];
+  var nOptions = Object.keys(args).length - 1;
+  var nArgs = args['_'].length;
+
+  if (nArgs > 1 || nOptions > options.length) {
+    color.error('Incorrect number of arguments and options.');
+    return false;
+  }
+
+  var passedOptions = Object.keys(args).slice(1);
+
+  if (nOptions) {
+    var hasUnknownOpt = false;
+
+    var _iterator = _createForOfIteratorHelper(passedOptions),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var op = _step.value;
+
+        if (!options.includes(op)) {
+          if (op !== 'h' && op !== 'help') color.error("Unknown option: ".concat(op));
+          hasUnknownOpt = true;
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    if (hasUnknownOpt) return false;
+  }
+
+  if (!utils.isPackageDir(curDir)) {
+    color.error('File `package.json` not found. Run the command from the package directory');
+    return false;
+  }
+
+  if (args.ts) {
+    _fs["default"].writeFileSync(webpackConfigPath, _fs["default"].readFileSync(_path["default"].join(templateDir, 'ts.webpack.config.js')));
+
+    _fs["default"].writeFileSync(tsConfigPath, _fs["default"].readFileSync(_path["default"].join(templateDir, 'tsconfig.json')));
+
+    var packageJsPath = _path["default"].join(curDir, 'src', 'package.js');
+
+    _fs["default"].writeFileSync(_path["default"].join(curDir, 'src', 'package.ts'), _fs["default"].existsSync(packageJsPath) ? _fs["default"].readFileSync(packageJsPath) : _fs["default"].readFileSync(_path["default"].join(templateDir, 'src', 'package.ts')));
+
+    var packageData = JSON.parse(_fs["default"].readFileSync(packageJsonPath, 'utf-8'));
+    Object.assign(packageData.devDependencies, {
+      'ts-loader': 'latest',
+      'typescript': 'latest'
+    });
+    if ('eslint' in packageData.devDependencies) Object.assign(packageData.devDependencies, {
+      '@typescript-eslint/eslint-plugin': 'latest',
+      '@typescript-eslint/parser': 'latest'
+    });
+
+    _fs["default"].writeFileSync(packageJsonPath, JSON.stringify(packageData, null, 2), 'utf-8');
+
+    color.success('TypeScript support has been added.');
+  }
+
+  if (args.ide) {
+    var config = _jsYaml["default"].load(_fs["default"].readFileSync(confPath, {
+      encoding: 'utf-8'
+    }));
+
+    var confTest = (0, _configValidator.validateConf)(config);
+
+    if (!confTest.value) {
+      color.warn('Invalid configuration. Skipping `ide`...');
+      color.error(confTest.message);
+    }
+
+    if (args.ide === 'vscode') {
+      var ideConfPath = _path["default"].join(curDir, '.vscode');
+
+      var templateConfPath = _path["default"].join(templateDir, '.vscode');
+
+      if (!_fs["default"].existsSync(ideConfPath)) _fs["default"].mkdirSync(ideConfPath);
+
+      var files = _fs["default"].readdirSync(templateConfPath);
+
+      var _iterator2 = _createForOfIteratorHelper(files),
+          _step2;
+
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var file = _step2.value;
+
+          var contents = _fs["default"].readFileSync(_path["default"].join(templateConfPath, file), 'utf-8');
+
+          if (file === 'tasks.json' && platform !== 'win32') contents = contents.replace(/(?<="command": ").*(?=")/, 'webpack && grok publish #{GROK_HOST_ALIAS}');
+          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);
+
+          _fs["default"].writeFileSync(_path["default"].join(ideConfPath, file), contents, 'utf-8');
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+
+      color.success('IDE configuration has been added.');
+    }
+  }
+
+  if (args.eslint) {
+    var _packageData = JSON.parse(_fs["default"].readFileSync(packageJsonPath, 'utf-8'));
+
+    Object.assign(_packageData.devDependencies, {
+      'eslint': 'latest',
+      'eslint-config-google': 'latest'
+    });
+
+    var ts = _fs["default"].existsSync(tsConfigPath);
+
+    if (ts) {
+      Object.assign(_packageData.devDependencies, {
+        '@typescript-eslint/eslint-plugin': 'latest',
+        '@typescript-eslint/parser': 'latest'
+      });
+    }
+
+    Object.assign(_packageData.scripts, {
+      'lint': "eslint src".concat(ts ? ' --ext .ts' : ''),
+      'lint-fix': "eslint src".concat(ts ? ' --ext .ts' : '', " --fix")
+    });
+
+    _fs["default"].writeFileSync(packageJsonPath, JSON.stringify(_packageData, null, 2), 'utf-8');
+
+    var eslintConfigPath = _path["default"].join(curDir, '.eslintrc.json');
+
+    var eslintTemplatePath = _path["default"].join(templateDir, '.eslintrc.json');
+
+    if (ts) {
+      var _contents = _fs["default"].readFileSync(eslintTemplatePath, 'utf-8');
+
+      var eslintConf = JSON.parse(_contents);
+      eslintConf.parser = '@typescript-eslint/parser';
+      eslintConf.plugins = ['@typescript-eslint'];
+      _contents = JSON.stringify(eslintConf, null, 2);
+
+      _fs["default"].writeFileSync(eslintConfigPath, _contents, 'utf-8');
+    } else _fs["default"].writeFileSync(eslintConfigPath, eslintTemplatePath);
+
+    color.success('Linter configuration has been added.');
+  }
+
+  if (args.test) {
+    var tsPath = _path["default"].join(curDir, 'src', 'package.ts');
+
+    if (!_fs["default"].existsSync(tsPath)) {
+      color.warn('Tests can only be added to TypeScript packages. Skipping `test`...');
+    } else if (!_fs["default"].existsSync(webpackConfigPath)) {
+      color.warn('Webpack configuration not found. Skipping `test`...');
+    } else {
+      var _config = _fs["default"].readFileSync(webpackConfigPath, 'utf-8');
+
+      if (!/(?<=entry:\s*{\s*(\r\n|\r|\n))[^}]*test:/.test(_config)) {
+        var entryIdx = _config.search(/(?<=entry:\s*{\s*(\r\n|\r|\n)).*/);
+
+        if (entryIdx === -1) color.error('Entry point not found during webpack config parsing');else {
+          var testEntry = "    test: {filename: 'package-test.js', library: " + "{type: 'var', name:`${packageName}_test`}, import: './src/package-test.ts'},";
+
+          _fs["default"].writeFileSync(webpackConfigPath, _config.slice(0, entryIdx) + testEntry + _config.slice(entryIdx), 'utf-8');
+        }
+      }
+
+      var _packageData2 = JSON.parse(_fs["default"].readFileSync(packageJsonPath, 'utf-8'));
+
+      Object.assign(_packageData2.dependencies, {
+        '@datagrok-libraries/utils': 'latest'
+      });
+      Object.assign(_packageData2.scripts, {
+        'test': 'grok test'
+      });
+
+      _fs["default"].writeFileSync(packageJsonPath, JSON.stringify(_packageData2, null, 2), 'utf-8');
+
+      var packageTestPath = _path["default"].join(curDir, 'src', 'package-test.ts');
+
+      if (!_fs["default"].existsSync(packageTestPath)) _fs["default"].writeFileSync(packageTestPath, _fs["default"].readFileSync(_path["default"].join(templateDir, 'src', 'package-test.ts')));
+
+      var testsDir = _path["default"].join(curDir, 'src', 'tests');
+
+      if (!_fs["default"].existsSync(testsDir)) _fs["default"].mkdirSync(testsDir);
+
+      _fs["default"].writeFileSync(_path["default"].join(testsDir, 'test-examples.ts'), _fs["default"].readFileSync(_path["default"].join(_path["default"].dirname(templateDir), 'entity-template', 'test.ts')));
+
+      _fs["default"].writeFileSync(packageTestPath, "import './tests/test-examples';\n" + _fs["default"].readFileSync(packageTestPath, 'utf-8'), 'utf-8');
+
+      color.success('Tests support has been added.');
+    }
+  }
+
+  return true;
+}

package/bin/commands/link.js

@@ -121,16 +121,15 @@ function link(args) {
           var lib = _step2.value;
 
           if ("".concat(libScope, "/").concat(lib.name) in dependencies) {
-            if (lib.isSymbolicLink()) {
-              console.log("Package \"".concat(lib.name, "\" is linked. Skipping..."));
-            } else {
-              console.log("Linking \"".concat(lib.name, "\"..."));
-              (0, _child_process.exec)('npm install && npm run build && npm link', {
-                cwd: _path["default"].join(paths[libScope], lib.name)
-              }, function (err, stdout, stderr) {
-                if (err) throw err;else console.log(stderr, stdout);
-              });
-            }
+            var libPath = _path["default"].join(paths[libScope], lib.name);
+
+            var isLinked = lib.isSymbolicLink();
+            console.log(isLinked ? "Package \"".concat(lib.name, "\" is linked. Updating dependencies and running the build script...") : "Linking \"".concat(lib.name, "\"..."));
+            (0, _child_process.exec)(isLinked ? 'npm update && npm run build' : 'npm install && npm run build && npm link', {
+              cwd: libPath
+            }, function (err, stdout, stderr) {
+              if (err) throw err;else console.log(stderr, stdout);
+            });
           }
         }
       } catch (err) {
@@ -145,43 +144,38 @@ function link(args) {
         return m.name === 'utils';
       }), 1)[0];
 
-      if (utilsModule.isSymbolicLink()) {
-        console.log("Package \"".concat(utilsModule.name, "\" is linked. Skipping..."));
-      } else {
-        console.log("Linking \"".concat(utilsModule.name, "\"..."));
-        (0, _child_process.exec)('npm install && npm run build && npm link', {
-          cwd: _path["default"].join(paths[libScope], 'utils')
-        }, function (err, stdout, stderr) {
-          if (err) throw err;else {
-            console.log(stderr, stdout);
-            f();
-          }
-        });
-      }
-    } else {
-      f();
-    }
-  }
+      var libPath = _path["default"].join(paths[libScope], 'utils');
 
-  if (apiModule != null) {
-    if (apiModule.isSymbolicLink()) {
-      console.log("Package \"".concat(apiModule.name, "\" is linked. Skipping..."));
-      installLibs(libs);
-    } else {
-      console.log("Linking \"".concat(apiModule.name, "\"..."));
-      (0, _child_process.exec)("npm install && npm run build && npm link", {
-        cwd: paths[apiPackageName]
+      var isLinked = utilsModule.isSymbolicLink();
+      console.log(isLinked ? "Package \"".concat(utilsModule.name, "\" is linked. Updating dependencies and running the build script...") : "Linking \"".concat(utilsModule.name, "\"..."));
+      (0, _child_process.exec)(isLinked ? 'npm update && npm run build' : 'npm install && npm run build && npm link', {
+        cwd: libPath
       }, function (err, stdout, stderr) {
         if (err) throw err;else {
           console.log(stderr, stdout);
-          installLibs(libs);
-          var packageNames = Object.keys(dependencies).join(' ');
-          (0, _child_process.exec)("npm link ".concat(packageNames));
+          f();
         }
       });
+    } else {
+      f();
     }
   }
 
+  if (apiModule != null) {
+    var isLinked = apiModule.isSymbolicLink();
+    console.log(isLinked ? "Package \"".concat(apiModule.name, "\" is linked. Updating dependencies and running the build script...") : "Linking \"".concat(apiModule.name, "\"..."));
+    (0, _child_process.exec)(isLinked ? "npm update && npm run build" : "npm install && npm run build && npm link", {
+      cwd: paths[apiPackageName]
+    }, function (err, stdout, stderr) {
+      if (err) throw err;else {
+        console.log(stderr, stdout);
+        installLibs(libs);
+        var packageNames = Object.keys(dependencies).join(' ');
+        (0, _child_process.exec)("npm link ".concat(packageNames));
+      }
+    });
+  }
+
   return true;
 }
 /** Unlinks local packages and runs `npm i`. */

package/bin/grok.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
-const argv = require('minimist')(process.argv.slice(2), {alias: {k: 'key'}});
+const argv = require('minimist')(process.argv.slice(2), {
+  alias: { k: 'key', h: 'help', r: 'recursive' },
+});
 const help = require('./commands/help').help;
 
 const commands = {
@@ -8,6 +10,7 @@ const commands = {
   check: require('./commands/check').check,
   config: require('./commands/config').config,
   create: require('./commands/create').create,
+  init: require('./commands/init').init,
   link: require('./commands/link').link,
   unlink: require('./commands/link').unlink,
   publish: require('./commands/publish').publish,

package/package-template/.vscode/tasks.json

@@ -3,8 +3,8 @@
   "tasks": [
     {
       "type": "shell",
-      "command": "cmd.exe /c 'call webpack && call grok publish {GROK_HOST_ALIAS}'",
+      "command": "cmd.exe /c 'call webpack && call grok publish #{GROK_HOST_ALIAS}'",
       "label": "rebuild"
     }
   ]
-}
+}

package/package-template/ts.webpack.config.js

@@ -27,6 +27,7 @@ module.exports = {
     'dayjs': 'dayjs',
     'wu': 'wu',
     'exceljs': 'ExcelJS',
+    'html2canvas': 'html2canvas',
   },
   output: {
     filename: '[name].js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.7.11",
+  "version": "4.8.1",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {