datagrok-tools 4.6.0 → 4.6.2

package/bin/commands/check.js

@@ -8,6 +8,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.check = check;
+exports.checkFuncSignatures = checkFuncSignatures;
+exports.checkImportStatements = checkImportStatements;
+exports.extractExternals = extractExternals;
 
 var _fs = _interopRequireDefault(require("fs"));
 
@@ -31,44 +34,66 @@ 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) return false;
+  if (args['_'].length !== 1 || nOptions > 1 && (!args.dir || typeof args.dir !== 'string') || nOptions > 2) return false;
   var curDir = process.cwd();
 
-  if (!utils.isPackageDir(curDir)) {
-    color.error('File `package.json` not found. Run the command from the package directory');
-    return false;
-  }
+  if (args.dir && typeof args.dir === 'string') {
+    var packagesDir = _path["default"].isAbsolute(args.dir) ? args.dir : _path["default"].join(curDir, args.dir);
+
+    _fs["default"].readdirSync(packagesDir).forEach(function (file) {
+      var filepath = _path["default"].join(packagesDir, file);
 
-  var files = _ignoreWalk["default"].sync({
-    ignoreFiles: ['.npmignore', '.gitignore']
-  });
+      var stats = _fs["default"].statSync(filepath);
 
-  var jsTsFiles = files.filter(function (f) {
-    return f.endsWith('.js') || f.endsWith('.ts');
-  });
-  var packageFiles = ['src/package.ts', 'src/detectors.ts', 'src/package.js', 'src/detectors.js', 'src/package-test.ts', 'src/package-test.js', 'package.js', 'detectors.js'];
-  var funcFiles = jsTsFiles.filter(function (f) {
-    return packageFiles.includes(f);
-  });
+      if (stats.isDirectory() && utils.isPackageDir(filepath)) {
+        console.log("Checking package ".concat(file, "..."));
+        runChecks(filepath);
+      }
+    });
+  } else {
+    if (!utils.isPackageDir(curDir)) {
+      color.error('File `package.json` not found. Run the command from the package directory');
+      return false;
+    }
 
-  var webpackConfigPath = _path["default"].join(curDir, 'webpack.config.js');
+    console.log("Checking package ".concat(_path["default"].basename(curDir), "..."));
+    runChecks(curDir);
+  }
 
-  var isWebpack = _fs["default"].existsSync(webpackConfigPath);
+  function runChecks(packagePath) {
+    var files = _ignoreWalk["default"].sync({
+      path: packagePath,
+      ignoreFiles: ['.npmignore', '.gitignore']
+    });
 
-  if (isWebpack) {
-    var content = _fs["default"].readFileSync(webpackConfigPath, {
-      encoding: 'utf-8'
+    var jsTsFiles = files.filter(function (f) {
+      return !f.startsWith('dist/') && (f.endsWith('.js') || f.endsWith('.ts'));
+    });
+    var packageFiles = ['src/package.ts', 'src/detectors.ts', 'src/package.js', 'src/detectors.js', 'src/package-test.ts', 'src/package-test.js', 'package.js', 'detectors.js'];
+    var funcFiles = jsTsFiles.filter(function (f) {
+      return packageFiles.includes(f);
     });
 
-    var externals = extractExternals(content);
-    if (externals) checkImportStatements(jsTsFiles, externals).forEach(function (warning) {
+    var webpackConfigPath = _path["default"].join(packagePath, 'webpack.config.js');
+
+    var isWebpack = _fs["default"].existsSync(webpackConfigPath);
+
+    if (isWebpack) {
+      var content = _fs["default"].readFileSync(webpackConfigPath, {
+        encoding: 'utf-8'
+      });
+
+      var externals = extractExternals(content);
+      if (externals) checkImportStatements(packagePath, jsTsFiles, externals).forEach(function (warning) {
+        return color.warn(warning);
+      });
+    }
+
+    checkFuncSignatures(packagePath, funcFiles).forEach(function (warning) {
       return color.warn(warning);
     });
   }
 
-  checkFuncSignatures(funcFiles).forEach(function (warning) {
-    return color.warn(warning);
-  });
   return true;
 }
 
@@ -91,7 +116,7 @@ function extractExternals(config) {
   return null;
 }
 
-function checkImportStatements(files, externals) {
+function checkImportStatements(packagePath, files, externals) {
   var modules = [];
 
   for (var key in externals) {
@@ -119,7 +144,7 @@ function checkImportStatements(files, externals) {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
       var file = _step.value;
 
-      var content = _fs["default"].readFileSync(_path["default"].join(process.cwd(), file), {
+      var content = _fs["default"].readFileSync(_path["default"].join(packagePath, file), {
         encoding: 'utf-8'
       });
 
@@ -151,7 +176,7 @@ function checkImportStatements(files, externals) {
   return warnings;
 }
 
-function checkFuncSignatures(files) {
+function checkFuncSignatures(packagePath, files) {
   var warnings = [];
   var checkFunctions = {
     semTypeDetector: function semTypeDetector(_ref) {
@@ -162,12 +187,12 @@ function checkFuncSignatures(files) {
 
       if (inputs.length !== 1 || inputs[0].type !== 'column') {
         value = false;
-        message += 'Semantic type detectors must have one input of type "column"';
+        message += 'Semantic type detectors must have one input of type "column"\n';
       }
 
       if (outputs.length !== 1 || outputs[0].type !== 'string') {
         value = false;
-        message += 'Semantic type detectors must have one output of type "string"';
+        message += 'Semantic type detectors must have one output of type "string"\n';
       }
 
       return {
@@ -183,12 +208,12 @@ function checkFuncSignatures(files) {
 
       if (inputs.length !== 0) {
         value = false;
-        message += 'Cell renderer functions should take no arguments';
+        message += 'Cell renderer functions should take no arguments\n';
       }
 
       if (outputs.length !== 1 || outputs[0].type !== 'grid_cell_renderer') {
         value = false;
-        message += 'Cell renderer functions must have one output of type "grid_cell_renderer"';
+        message += 'Cell renderer functions must have one output of type "grid_cell_renderer"\n';
       }
 
       return {
@@ -207,17 +232,17 @@ function checkFuncSignatures(files) {
         return t.startsWith('fileViewer');
       }).length < 2) {
         value = false;
-        message += 'File viewers must have at least two special tags: "fileViewer" and "fileViewer-<extension>"';
+        message += 'File viewers must have at least two special tags: "fileViewer" and "fileViewer-<extension>"\n';
       }
 
       if (inputs.length !== 1 || inputs[0].type !== 'file') {
         value = false;
-        message += 'File viewers must have one input of type "file"';
+        message += 'File viewers must have one input of type "file"\n';
       }
 
       if (outputs.length !== 1 || outputs[0].type !== 'view') {
         value = false;
-        message += 'File viewers must have one output of type "view"';
+        message += 'File viewers must have one output of type "view"\n';
       }
 
       return {
@@ -232,7 +257,7 @@ function checkFuncSignatures(files) {
 
       if (description == null || description === '') {
         value = false;
-        message += 'File exporters should have a description parameter';
+        message += 'File exporters should have a description parameter\n';
       }
 
       return {
@@ -247,7 +272,7 @@ function checkFuncSignatures(files) {
 
       if (outputs.length === 1 && outputs[0].type === 'widget') {
         value = false;
-        message += 'Package settings editors must have one output of type "widget"';
+        message += 'Package settings editors must have one output of type "widget"\n';
       }
 
       return {
@@ -265,7 +290,7 @@ function checkFuncSignatures(files) {
     for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
       var file = _step3.value;
 
-      var content = _fs["default"].readFileSync(_path["default"].join(process.cwd(), file), {
+      var content = _fs["default"].readFileSync(_path["default"].join(packagePath, file), {
         encoding: 'utf-8'
       });
 

package/bin/commands/help.js

@@ -10,7 +10,7 @@ var HELP_API = "\nUsage: grok api\n\nCreate wrapper functions for package script
 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] [--jest]\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--jest      Add a configuration for jest\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\nCheck package content (function signatures, import statements of external modules, etc.)\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_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,

package/bin/commands/publish.js

@@ -28,6 +28,8 @@ var _ignoreWalk = _interopRequireDefault(require("ignore-walk"));
 
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
 
+var _check = require("./check");
+
 var utils = _interopRequireWildcard(require("../utils/utils"));
 
 var color = _interopRequireWildcard(require("../utils/color-utils"));
@@ -52,13 +54,15 @@ var curDir = process.cwd();
 
 var packDir = _path["default"].join(curDir, 'package.json');
 
+var packageFiles = ['src/package.ts', 'src/detectors.ts', 'src/package.js', 'src/detectors.js', 'src/package-test.ts', 'src/package-test.js', 'package.js', 'detectors.js'];
+
 function processPackage(_x, _x2, _x3, _x4, _x5, _x6) {
   return _processPackage.apply(this, arguments);
 }
 
 function _processPackage() {
   _processPackage = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(debug, rebuild, host, devKey, packageName, suffix) {
-    var timestamps, url, zip, localTimestamps, files, isWebpack, distFiles, contentValidationLog, uploadPromise, log;
+    var timestamps, url, zip, localTimestamps, files, isWebpack, distFiles, contentValidationLog, checkStart, jsTsFiles, webpackConfigPath, content, externals, importWarnings, funcFiles, funcWarnings, uploadPromise, log;
     return _regenerator["default"].wrap(function _callee3$(_context3) {
       while (1) {
         switch (_context3.prev = _context3.next) {
@@ -151,6 +155,31 @@ function _processPackage() {
 
           case 34:
             contentValidationLog = '';
+            console.log('Starting package checks...');
+            checkStart = Date.now();
+            jsTsFiles = files.filter(function (f) {
+              return !f.startsWith('dist/') && (f.endsWith('.js') || f.endsWith('.ts'));
+            });
+
+            if (isWebpack) {
+              webpackConfigPath = _path["default"].join(curDir, 'webpack.config.js');
+              content = _fs["default"].readFileSync(webpackConfigPath, {
+                encoding: 'utf-8'
+              });
+              externals = (0, _check.extractExternals)(content);
+
+              if (externals) {
+                importWarnings = (0, _check.checkImportStatements)(curDir, jsTsFiles, externals);
+                contentValidationLog += importWarnings.join('\n') + (importWarnings.length ? '\n' : '');
+              }
+            }
+
+            funcFiles = jsTsFiles.filter(function (f) {
+              return packageFiles.includes(f);
+            });
+            funcWarnings = (0, _check.checkFuncSignatures)(curDir, funcFiles);
+            contentValidationLog += funcWarnings.join('\n') + (funcWarnings.length ? '\n' : '');
+            console.log("Checks finished in ".concat(Date.now() - checkStart, " ms"));
             files.forEach(function (file) {
               var fullPath = file;
 
@@ -236,21 +265,21 @@ function _processPackage() {
             })["catch"](function (error) {
               console.error(error);
             });
-            _context3.next = 42;
+            _context3.next = 50;
             return zip.finalize();
 
-          case 42:
-            _context3.prev = 42;
-            _context3.next = 45;
+          case 50:
+            _context3.prev = 50;
+            _context3.next = 53;
             return uploadPromise;
 
-          case 45:
+          case 53:
             log = _context3.sent;
 
             _fs["default"].unlinkSync('zip');
 
             if (!(log['#type'] === 'ApiError')) {
-              _context3.next = 53;
+              _context3.next = 61;
               break;
             }
 
@@ -258,29 +287,29 @@ function _processPackage() {
             console.error(log['innerMessage']);
             return _context3.abrupt("return", 1);
 
-          case 53:
+          case 61:
             console.log(log);
             color.warn(contentValidationLog);
 
-          case 55:
-            _context3.next = 61;
+          case 63:
+            _context3.next = 69;
             break;
 
-          case 57:
-            _context3.prev = 57;
-            _context3.t1 = _context3["catch"](42);
+          case 65:
+            _context3.prev = 65;
+            _context3.t1 = _context3["catch"](50);
             console.error(_context3.t1);
             return _context3.abrupt("return", 1);
 
-          case 61:
+          case 69:
             return _context3.abrupt("return", 0);
 
-          case 62:
+          case 70:
           case "end":
             return _context3.stop();
         }
       }
-    }, _callee3, null, [[3, 14], [42, 57]]);
+    }, _callee3, null, [[3, 14], [50, 65]]);
   }));
   return _processPackage.apply(this, arguments);
 }
@@ -294,7 +323,7 @@ function publish(args) {
   })) return false;
 
   if (args.build && args.rebuild) {
-    color.error('Incompatible options: --build and');
+    color.error('Incompatible options: --build and --rebuild');
     return false;
   }
 

package/package-template/webpack.config.js

@@ -18,6 +18,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.6.0",
+  "version": "4.6.2",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {