datagrok-tools 4.8.4 → 4.9.0

package/README.md

@@ -118,4 +118,4 @@ Read more about package development in [Datagrok's documentation](https://datagr
   save a test run result, add the `--csv` flag (the report will be saved in a
   CSV file in the package folder). You can find more details in [local package testing
   instructions](https://datagrok.ai/help/develop/how-to/test-packages#local-testing).
-- `link` / `unlink` commands are used for public plugins development to (un)link `datagrok-api` and libraries.
+- `link` command is used for public plugins development to link `datagrok-api` and libraries.

package/bin/commands/create.js

@@ -132,7 +132,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
           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');
@@ -148,7 +148,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
           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);
         }
       }
 
@@ -248,7 +248,7 @@ function create(args) {
         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();

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

package/bin/commands/link.js

@@ -8,7 +8,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.link = link;
-exports.unlink = unlink;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -34,22 +33,20 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 
 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; }
 
-/**
- * Link: api > utils > other libs - npm install, npm run build, npm link
- * Unlink: npm install in the package and its dependencies, npm unlink
- */
 var curDir = process.cwd();
 
-var packageDir = _path["default"].join(curDir, 'package.json');
+var repositoryDir = _path["default"].dirname(_path["default"].dirname(curDir));
 
 var apiPackageName = 'datagrok-api';
 var libScope = '@datagrok-libraries';
-var paths = (_paths = {}, (0, _defineProperty2["default"])(_paths, apiPackageName, _path["default"].join(_path["default"].dirname(_path["default"].dirname(curDir)), 'js-api')), (0, _defineProperty2["default"])(_paths, libScope, _path["default"].join(_path["default"].dirname(_path["default"].dirname(curDir)), 'libraries')), _paths);
+var paths = (_paths = {}, (0, _defineProperty2["default"])(_paths, apiPackageName, _path["default"].join(repositoryDir, 'js-api')), (0, _defineProperty2["default"])(_paths, libScope, _path["default"].join(repositoryDir, 'libraries')), _paths);
+var packageDependencies = {};
 /** Links local packages. */
 
 function link(args) {
   var nOptions = Object.keys(args).length - 1;
-  if (nOptions > 0 || args['_'].length > 1) return false;
+  if (nOptions > 1 || args['_'].length > 1 || nOptions === 1 && !args.local && !args.npm) return false;
+  var local = args.npm ? false : true; // args.local is default
 
   if (!utils.isPackageDir(curDir)) {
     color.error('File `package.json` not found. Run the command from the package directory');
@@ -65,173 +62,181 @@ function link(args) {
     }
   }
 
-  var dependencies = readDependencies(JSON.parse(_fs["default"].readFileSync(packageDir, 'utf-8')));
+  var dependencies = readDependencies(curDir);
 
-  var modulesDir = _path["default"].join(curDir, 'node_modules');
-
-  if (!_fs["default"].existsSync(modulesDir)) {
-    console.log('Running `npm install` to get the required dependencies...\n');
-    (0, _child_process.exec)('npm install', function (err, stdout, stderr) {
-      if (err) throw err;else console.log(stderr, stdout);
-    });
-  } // The order should start with js-api, then libraries/utils, then other libraries
+  if (local) {
+    var _link = function _link(packagePath) {
+      var packageJsonPath = _path["default"].join(packagePath, 'package.json');
 
+      var json = JSON.parse(_fs["default"].readFileSync(packageJsonPath, 'utf-8'));
+      json.scripts['link-all'] = generateLinkScript(packagePath, packageHierarchy);
+      json.scripts['build-all'] = generateBuildScript(packagePath, packageHierarchy);
 
-  var apiModule = null;
-  var hasUtils = false;
-  var libs = [];
+      _fs["default"].writeFileSync(packageJsonPath, JSON.stringify(json, null, 2), 'utf-8');
 
-  var allModules = _fs["default"].readdirSync(modulesDir, {
-    encoding: 'utf-8',
-    withFileTypes: true
-  });
-
-  var _iterator = _createForOfIteratorHelper(allModules),
-      _step;
+      (0, _child_process.exec)('npm install && npm link && npm run link-all', {
+        cwd: packagePath
+      }, function (err, stdout, stderr) {
+        if (err) throw err;else console.log(stderr, stdout);
+      });
+    };
 
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var m = _step.value;
-      if (m.name === apiPackageName) apiModule = m;else if (m.name === libScope) {
-        libs = _fs["default"].readdirSync(_path["default"].join(modulesDir, m.name), {
-          encoding: 'utf-8',
-          withFileTypes: true
-        });
+    var packageHierarchy = getHierarchy(curDir);
+    packageHierarchy.forEach(function (packageName) {
+      return _link(getPackagePath(packageName));
+    });
 
-        var _iterator3 = _createForOfIteratorHelper(libs),
-            _step3;
-
-        try {
-          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
-            var lib = _step3.value;
-            if (lib.name === 'utils') hasUtils = true;
-          }
-        } catch (err) {
-          _iterator3.e(err);
-        } finally {
-          _iterator3.f();
-        }
-      }
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
+    _link(curDir);
+  } else {
+    runScript(curDir, 'npm install', dependencies, {
+      dirMessage: 'Unlinking local packages in ',
+      successMessage: 'Local packages have been successfully unlinked.'
+    });
   }
 
-  function installLibs(libs) {
-    if (!libs.length) return;
-
-    var f = function f() {
-      var _iterator2 = _createForOfIteratorHelper(libs),
-          _step2;
+  return true;
+}
 
-      try {
-        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-          var lib = _step2.value;
+function readDependencies(packagePath) {
+  if (packagePath in packageDependencies) return packageDependencies[packagePath];
 
-          if ("".concat(libScope, "/").concat(lib.name) in dependencies) {
-            var libPath = _path["default"].join(paths[libScope], lib.name);
+  var fileContent = _fs["default"].readFileSync(_path["default"].join(packagePath, 'package.json'), 'utf-8');
 
-            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 link-all && npm run build && npm link', {
-              cwd: libPath
-            }, function (err, stdout, stderr) {
-              if (err) throw err;else console.log(stderr, stdout);
-            });
-          }
-        }
-      } catch (err) {
-        _iterator2.e(err);
-      } finally {
-        _iterator2.f();
-      }
-    };
+  var json = JSON.parse(fileContent);
+  var libs = {};
 
-    if (hasUtils) {
-      var utilsModule = libs.splice(libs.findIndex(function (m) {
-        return m.name === 'utils';
-      }), 1)[0];
+  for (var dep in json.dependencies) {
+    if (dep === apiPackageName || dep.startsWith("".concat(libScope, "/"))) libs[dep] = json.dependencies[dep];
+  }
 
-      var libPath = _path["default"].join(paths[libScope], 'utils');
+  packageDependencies[packagePath] = libs;
+  return libs;
+}
 
-      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 link-all && npm run build && npm link', {
-        cwd: libPath
-      }, function (err, stdout, stderr) {
-        if (err) throw err;else {
-          console.log(stderr, stdout);
-          f();
+function getPackagePath(packageName) {
+  return packageName === apiPackageName ? paths[packageName] : _path["default"].join(paths[libScope], packageName.split('/')[1]);
+}
+/** Forms a hierarchy to understand in which order packages should be linked. */
+
+
+function getHierarchy(packageDir) {
+  var hierarchy = [];
+  var dependencies = Object.keys(readDependencies(packageDir));
+  var cachedHierarchy = {};
+
+  for (var _i2 = 0, _dependencies = dependencies; _i2 < _dependencies.length; _i2++) {
+    var _cachedHierarchy$depP;
+
+    var dep = _dependencies[_i2];
+    var idx = hierarchy.indexOf(dep);
+    if (idx === -1) idx = hierarchy.push(dep) - 1;
+    var depPath = getPackagePath(dep);
+    var internalHierarchy = (_cachedHierarchy$depP = cachedHierarchy[depPath]) !== null && _cachedHierarchy$depP !== void 0 ? _cachedHierarchy$depP : getHierarchy(depPath);
+    if (!(depPath in cachedHierarchy)) cachedHierarchy[depPath] = internalHierarchy;
+
+    var _iterator = _createForOfIteratorHelper(internalHierarchy),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var internalDep = _step.value;
+        var depIdx = hierarchy.indexOf(internalDep);
+
+        if (depIdx === -1) {
+          // Insert the internal dependency before the main package
+          hierarchy.splice(idx, 0, internalDep);
+          idx++;
+        } else if (depIdx > idx) {
+          // Remove the internal dependency from the list and place it before the main package
+          // (doesn't affect the order of same-level libraries, their order is arbitrary)
+          hierarchy.splice(depIdx, 1);
+          idx = hierarchy.indexOf(dep);
+          hierarchy.splice(idx, 0, internalDep);
+          idx++;
         }
-      });
-    } 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));
       }
-    });
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
   }
 
-  return true;
+  return hierarchy;
 }
-/** Unlinks local packages and runs `npm i`. */
+/** Executes a script for a package and its dependencies with messages on the current progress. */
 
 
-function unlink(args) {
-  var nOptions = Object.keys(args).length - 1;
-  if (nOptions > 0 || args['_'].length > 1) return false;
-
-  if (!utils.isPackageDir(curDir)) {
-    color.error('File `package.json` not found. Run the command from the package directory');
-    return false;
-  }
-
-  var dependencies = readDependencies(JSON.parse(_fs["default"].readFileSync(packageDir, 'utf-8')));
-  var packageNames = Object.keys(dependencies).join(' '); // npm unlink ${packageNames}
-
-  (0, _child_process.exec)("npm install", function (err, stdout, stderr) {
-    console.log("Unlinking local packages in ".concat(_path["default"].basename(curDir)));
+function runScript(packageDir, script, dependencies) {
+  var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  (0, _child_process.exec)(script, {
+    cwd: packageDir
+  }, function (err, stdout, stderr) {
+    if (options.dirMessage) console.log("".concat(options.dirMessage).concat(_path["default"].basename(packageDir)));
+    if (options.callback) options.callback(packageDir);
     if (err) throw err;else {
       console.log(stderr, stdout);
 
       var _loop = function _loop(dep) {
-        var depPath = dep === apiPackageName ? paths[dep] : _path["default"].join(paths[libScope], dep.split('/')[1]);
-        (0, _child_process.exec)("npm install", {
+        var depPath = getPackagePath(dep);
+        (0, _child_process.exec)(script, {
           cwd: depPath
         }, function (err, stdout, stderr) {
-          console.log("Unlinking local packages in ".concat(_path["default"].basename(depPath)));
+          if (options.dirMessage) console.log("".concat(options.dirMessage).concat(_path["default"].basename(depPath)));
+          if (options.callback) options.callback(depPath);
           if (err) throw err;else console.log(stderr, stdout);
         });
       };
 
       for (var dep in dependencies) {
         _loop(dep);
-      }
+      } // if (options.successMessage)
+      //   setTimeout(() => color.success(options.successMessage!), 5000);
+
     }
   });
-  return true;
 }
+/** Generates a package script to build all dependencies using the provided hierarchy. */
 
-function readDependencies(json) {
-  var libs = {};
 
-  for (var dep in json.dependencies) {
-    if (dep === apiPackageName || dep.startsWith("".concat(libScope, "/"))) libs[dep] = json.dependencies[dep];
+function generateBuildScript(packagePath, hierarchy) {
+  var dependencies = Object.keys(readDependencies(packagePath));
+  var packageNames = hierarchy.filter(function (p) {
+    return dependencies.includes(p);
+  });
+  var prefix = "./".concat(_path["default"].relative(packagePath, repositoryDir).split(_path["default"].sep).join('/'), "/");
+  var script = '';
+
+  var _iterator2 = _createForOfIteratorHelper(packageNames),
+      _step2;
+
+  try {
+    for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var packageName = _step2.value;
+      script += "npm --prefix ".concat(prefix).concat(packageName === apiPackageName ? 'js-api' : "libraries/".concat(packageName.split('/')[1]), " run build && ");
+    }
+  } catch (err) {
+    _iterator2.e(err);
+  } finally {
+    _iterator2.f();
   }
 
-  return libs;
+  return "".concat(script ? script : '', "npm run build");
+}
+/** Generates a package script to link all dependencies using the provided hierarchy. */
+
+
+function generateLinkScript(packagePath, hierarchy) {
+  var dependencies = Object.keys(readDependencies(packagePath));
+  var packageNames = hierarchy.filter(function (p) {
+    return dependencies.includes(p);
+  });
+
+  for (var _i3 = 0, _dependencies2 = dependencies; _i3 < _dependencies2.length; _i3++) {
+    var dep = _dependencies2[_i3];
+    if (!packageNames.includes(dep)) color.error("Hierarchy does not include package ".concat(dep));
+  }
+
+  var script = "npm link".concat(packageNames.length ? ' ' + packageNames.join(' ') : '');
+  return script;
 }

package/bin/grok.js

@@ -12,7 +12,6 @@ const commands = {
   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,
   test: require('./commands/test').test,
 };

package/package.json

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