datagrok-tools 4.7.7 → 4.7.9

package/bin/commands/check.js

@@ -2,7 +2,7 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _typeof = require("@babel/runtime/helpers/typeof");
+var _typeof3 = require("@babel/runtime/helpers/typeof");
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -10,8 +10,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.check = check;
 exports.checkFuncSignatures = checkFuncSignatures;
 exports.checkImportStatements = checkImportStatements;
+exports.checkPackageFile = checkPackageFile;
 exports.extractExternals = extractExternals;
 
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
 var _fs = _interopRequireDefault(require("fs"));
 
 var _path = _interopRequireDefault(require("path"));
@@ -24,7 +27,7 @@ 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; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof3(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; } } }; }
 
@@ -34,7 +37,7 @@ 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 > 1 && (!args.dir || typeof args.dir !== 'string') || nOptions > 2) return false;
+  if (args['_'].length !== 1 || nOptions > 0 && (!args.dir || typeof args.dir !== 'string') || nOptions > 1) return false;
   var curDir = process.cwd();
 
   if (args.dir && typeof args.dir === 'string') {
@@ -84,14 +87,11 @@ function check(args) {
       });
 
       var externals = extractExternals(content);
-      if (externals) checkImportStatements(packagePath, jsTsFiles, externals).forEach(function (warning) {
-        return color.warn(warning);
-      });
+      if (externals) warn(checkImportStatements(packagePath, jsTsFiles, externals));
     }
 
-    checkFuncSignatures(packagePath, funcFiles).forEach(function (warning) {
-      return color.warn(warning);
-    });
+    warn(checkFuncSignatures(packagePath, funcFiles));
+    warn(checkPackageFile(packagePath));
   }
 
   return true;
@@ -334,11 +334,66 @@ function checkFuncSignatures(packagePath, files) {
   return warnings;
 }
 
+function checkPackageFile(packagePath) {
+  var warnings = [];
+
+  var packageFilePath = _path["default"].join(packagePath, 'package.json');
+
+  var json = JSON.parse(_fs["default"].readFileSync(packageFilePath, {
+    encoding: 'utf-8'
+  }));
+  var isPublicPackage = _path["default"].basename(_path["default"].dirname(packagePath)) === 'packages' && _path["default"].basename(_path["default"].dirname(_path["default"].dirname(packagePath))) === 'public';
+  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;
+
+    try {
+      for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+        var propInfo = _step5.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);
+    } finally {
+      _iterator5.f();
+    }
+  }
+
+  if (json.repository == null && isPublicPackage) warnings.push('File "package.json": add the "repository" field.');
+  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;
+
+    try {
+      for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+        var source = _step6.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 (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);
+    } finally {
+      _iterator6.f();
+    }
+  }
+
+  return warnings;
+}
+
+function warn(warnings) {
+  warnings.forEach(function (w) {
+    return color.warn(w);
+  });
+}
+
 function getFuncMetadata(script) {
   var funcData = [];
-  var headerTags = ['name', 'description', 'help-url', 'input', 'output', 'tags', 'sample', 'language', 'returns', 'test', 'sidebar', 'condition', 'top-menu', 'environment', 'require', 'editor-for', 'schedule', 'reference', 'editor'];
-  var paramRegex = new RegExp("//\\s*(".concat(headerTags.join('|'), "|meta\\.[^:]*): *(\\S+) ?(\\S+)?"));
-  var nameRegex = /(?:|static|export\s+function|export\s+async\s+function)\s+([a-zA-Z_][a-zA-Z0-9_$]*)\s*\((.*?)\).*/;
   var isHeader = false;
   var data = {
     name: '',
@@ -346,14 +401,14 @@ function getFuncMetadata(script) {
     outputs: []
   };
 
-  var _iterator5 = _createForOfIteratorHelper(script.split('\n')),
-      _step5;
+  var _iterator7 = _createForOfIteratorHelper(script.split('\n')),
+      _step7;
 
   try {
-    for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-      var line = _step5.value;
+    for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+      var line = _step7.value;
       if (!line) continue;
-      var match = line.match(paramRegex);
+      var match = line.match(utils.paramRegex);
 
       if (match) {
         if (!isHeader) isHeader = true;
@@ -368,9 +423,9 @@ function getFuncMetadata(script) {
       }
 
       if (isHeader) {
-        var nm = line.match(nameRegex);
+        var nm = line.match(utils.nameRegex);
 
-        if (nm && !line.match(paramRegex)) {
+        if (nm && !line.match(utils.paramRegex)) {
           data.name = data.name || nm[1];
           funcData.push(data);
           data = {
@@ -383,9 +438,9 @@ function getFuncMetadata(script) {
       }
     }
   } catch (err) {
-    _iterator5.e(err);
+    _iterator7.e(err);
   } finally {
-    _iterator5.f();
+    _iterator7.f();
   }
 
   return funcData;

package/bin/commands/publish.js

@@ -62,7 +62,7 @@ function processPackage(_x, _x2, _x3, _x4, _x5, _x6) {
 
 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, checkStart, jsTsFiles, webpackConfigPath, content, externals, importWarnings, funcFiles, funcWarnings, uploadPromise, log;
+    var timestamps, url, zip, localTimestamps, files, isWebpack, distFiles, contentValidationLog, checkStart, jsTsFiles, webpackConfigPath, content, externals, importWarnings, funcFiles, funcWarnings, packageWarnings, uploadPromise, log;
     return _regenerator["default"].wrap(function _callee3$(_context3) {
       while (1) {
         switch (_context3.prev = _context3.next) {
@@ -179,6 +179,8 @@ function _processPackage() {
             });
             funcWarnings = (0, _check.checkFuncSignatures)(curDir, funcFiles);
             contentValidationLog += funcWarnings.join('\n') + (funcWarnings.length ? '\n' : '');
+            packageWarnings = (0, _check.checkPackageFile)(curDir);
+            contentValidationLog += packageWarnings.join('\n') + (packageWarnings.length ? '\n' : '');
             console.log("Checks finished in ".concat(Date.now() - checkStart, " ms"));
             files.forEach(function (file) {
               var fullPath = file;
@@ -265,21 +267,21 @@ function _processPackage() {
             })["catch"](function (error) {
               console.error(error);
             });
-            _context3.next = 50;
+            _context3.next = 52;
             return zip.finalize();
 
-          case 50:
-            _context3.prev = 50;
-            _context3.next = 53;
+          case 52:
+            _context3.prev = 52;
+            _context3.next = 55;
             return uploadPromise;
 
-          case 53:
+          case 55:
             log = _context3.sent;
 
             _fs["default"].unlinkSync('zip');
 
             if (!(log['#type'] === 'ApiError')) {
-              _context3.next = 61;
+              _context3.next = 63;
               break;
             }
 
@@ -287,29 +289,29 @@ function _processPackage() {
             console.error(log['innerMessage']);
             return _context3.abrupt("return", 1);
 
-          case 61:
+          case 63:
             console.log(log);
             color.warn(contentValidationLog);
 
-          case 63:
-            _context3.next = 69;
+          case 65:
+            _context3.next = 71;
             break;
 
-          case 65:
-            _context3.prev = 65;
-            _context3.t1 = _context3["catch"](50);
+          case 67:
+            _context3.prev = 67;
+            _context3.t1 = _context3["catch"](52);
             console.error(_context3.t1);
             return _context3.abrupt("return", 1);
 
-          case 69:
+          case 71:
             return _context3.abrupt("return", 0);
 
-          case 70:
+          case 72:
           case "end":
             return _context3.stop();
         }
       }
-    }, _callee3, null, [[3, 14], [50, 65]]);
+    }, _callee3, null, [[3, 14], [52, 67]]);
   }));
   return _processPackage.apply(this, arguments);
 }

package/bin/utils/interfaces.js

@@ -0,0 +1 @@
+"use strict";

package/bin/utils/utils.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TemplateBuilder = void 0;
+exports.absUrlRegex = exports.TemplateBuilder = void 0;
 exports.camelCaseToKebab = camelCaseToKebab;
 exports.checkScriptLocation = checkScriptLocation;
 exports.dgToTsTypeMap = exports.dgImports = exports.commentMap = void 0;
@@ -14,11 +14,12 @@ exports.getParam = getParam;
 exports.getScriptInputs = getScriptInputs;
 exports.getScriptName = getScriptName;
 exports.getScriptOutputType = getScriptOutputType;
+exports.headerTags = void 0;
 exports.isEmpty = isEmpty;
 exports.isPackageDir = isPackageDir;
 exports.kebabToCamelCase = kebabToCamelCase;
 exports.mapURL = mapURL;
-exports.queryWrapperTemplate = exports.queryExtension = exports.namespaceTemplate = void 0;
+exports.queryWrapperTemplate = exports.queryExtension = exports.propertyTypes = exports.paramRegex = exports.namespaceTemplate = exports.nameRegex = void 0;
 exports.removeScope = removeScope;
 exports.scriptWrapperTemplate = exports.scriptLangExtMap = exports.scriptExtensions = exports.replacers = void 0;
 exports.spaceToCamelCase = spaceToCamelCase;
@@ -264,6 +265,16 @@ var dgToTsTypeMap = {
   file: 'DG.FileInfo'
 };
 exports.dgToTsTypeMap = dgToTsTypeMap;
+var propertyTypes = ['bool', 'int', 'float', 'string', 'datetime', 'object', 'column', 'dataframe', 'bitset', 'cell', 'string_list', 'map'];
+exports.propertyTypes = propertyTypes;
+var headerTags = ['name', 'description', 'help-url', 'input', 'output', 'tags', 'sample', 'language', 'returns', 'test', 'sidebar', 'condition', 'top-menu', 'environment', 'require', 'editor-for', 'schedule', 'reference', 'editor'];
+exports.headerTags = headerTags;
+var paramRegex = new RegExp("//\\s*(".concat(headerTags.join('|'), "|meta\\.[^:]*): *(\\S+) ?(\\S+)?"));
+exports.paramRegex = paramRegex;
+var nameRegex = /(?:|static|export\s+function|export\s+async\s+function)\s+([a-zA-Z_][a-zA-Z0-9_$]*)\s*\((.*?)\).*/;
+exports.nameRegex = nameRegex;
+var absUrlRegex = new RegExp('^(?:[a-z+]+:)?//', 'i');
+exports.absUrlRegex = absUrlRegex;
 
 function getScriptOutputType(script) {
   var comment = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '#';

package/package.json

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