datagrok-tools 4.7.9 → 4.7.11

package/README.md

@@ -17,7 +17,7 @@ npm install datagrok-tools -g
     ```
 
    Enter developer keys and set the default server. The developer key can be retrieved from your user profile (for
-   example, see https://public.datagrok.ai/u).
+   example, see <https://public.datagrok.ai/u>).
 2. Create a new package by running this command:
 
     ```shell
@@ -98,3 +98,22 @@ Read more about package development in [Datagrok's documentation](https://datagr
   - `--suffix`: a string containing package version hash
 
   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.
+- `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).
+
+  ```shell
+  cd <package-name>
+  grok test
+  ```
+
+  The default host from the `config.yaml` file is used. You
+  can specify another server alias via the `--host` option (e.g., `grok test
+  --host=dev`). The results are printed to the terminal. To see tests execution,
+  pass the `--gui` flag that disables the headless browser mode. If you want to
+  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.

package/bin/commands/check.js

@@ -15,6 +15,8 @@ exports.extractExternals = extractExternals;
 
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
 var _fs = _interopRequireDefault(require("fs"));
 
 var _path = _interopRequireDefault(require("path"));
@@ -48,10 +50,7 @@ function check(args) {
 
       var stats = _fs["default"].statSync(filepath);
 
-      if (stats.isDirectory() && utils.isPackageDir(filepath)) {
-        console.log("Checking package ".concat(file, "..."));
-        runChecks(filepath);
-      }
+      if (stats.isDirectory() && utils.isPackageDir(filepath)) runChecks(filepath);
     });
   } else {
     if (!utils.isPackageDir(curDir)) {
@@ -59,7 +58,6 @@ function check(args) {
       return false;
     }
 
-    console.log("Checking package ".concat(_path["default"].basename(curDir), "..."));
     runChecks(curDir);
   }
 
@@ -76,6 +74,7 @@ function check(args) {
     var funcFiles = jsTsFiles.filter(function (f) {
       return packageFiles.includes(f);
     });
+    var warnings = [];
 
     var webpackConfigPath = _path["default"].join(packagePath, 'webpack.config.js');
 
@@ -87,11 +86,16 @@ function check(args) {
       });
 
       var externals = extractExternals(content);
-      if (externals) warn(checkImportStatements(packagePath, jsTsFiles, externals));
+      if (externals) warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkImportStatements(packagePath, jsTsFiles, externals)));
     }
 
-    warn(checkFuncSignatures(packagePath, funcFiles));
-    warn(checkPackageFile(packagePath));
+    warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkFuncSignatures(packagePath, funcFiles)));
+    warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkPackageFile(packagePath)));
+
+    if (warnings.length) {
+      console.log("Checking package ".concat(_path["default"].basename(packagePath), "..."));
+      warn(warnings);
+    } else console.log("Checking package ".concat(_path["default"].basename(packagePath), "...\t\t\t\u2713 OK"));
   }
 
   return true;
@@ -221,10 +225,31 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    fileViewer: function fileViewer(_ref3) {
+    viewer: function viewer(_ref3) {
       var inputs = _ref3.inputs,
-          outputs = _ref3.outputs,
-          tags = _ref3.tags;
+          outputs = _ref3.outputs;
+      var value = true;
+      var message = '';
+
+      if (inputs.length !== 0) {
+        value = false;
+        message += 'Viewer functions should take no arguments\n';
+      }
+
+      if (outputs.length > 1 || outputs.length === 1 && outputs[0].type !== 'viewer') {
+        value = false;
+        message += 'Viewers must have one output of type "viewer"\n';
+      }
+
+      return {
+        value: value,
+        message: message
+      };
+    },
+    fileViewer: function fileViewer(_ref4) {
+      var inputs = _ref4.inputs,
+          outputs = _ref4.outputs,
+          tags = _ref4.tags;
       var value = true;
       var message = '';
 
@@ -250,8 +275,8 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    fileExporter: function fileExporter(_ref4) {
-      var description = _ref4.description;
+    fileExporter: function fileExporter(_ref5) {
+      var description = _ref5.description;
       var value = true;
       var message = '';
 
@@ -265,8 +290,8 @@ function checkFuncSignatures(packagePath, files) {
         message: message
       };
     },
-    packageSettingsEditor: function packageSettingsEditor(_ref5) {
-      var outputs = _ref5.outputs;
+    packageSettingsEditor: function packageSettingsEditor(_ref6) {
+      var outputs = _ref6.outputs;
       var value = true;
       var message = '';
 

package/package-template/README.md

@@ -1,3 +1,3 @@
 # #{PACKAGE_NAME}
 
-#{PACKAGE_NAME} is a [package](https://datagrok.ai/help/develop/develop#packages) for the [Datagrok](https://datagrok.ai) platform.
+`#{PACKAGE_NAME}` is a [package](https://datagrok.ai/help/develop/develop#packages) for the [Datagrok](https://datagrok.ai) platform

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

@@ -15,7 +15,7 @@ module.exports = {
       { test: /\.tsx?$/, loader: 'ts-loader' }
     ],
   },
-  devtool: 'inline-source-map',
+  devtool: 'source-map',
   externals: {
     'datagrok-api/dg': 'DG',
     'datagrok-api/grok': 'grok',

package/package-template/tsconfig.json

@@ -12,7 +12,7 @@
     // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
     // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    "sourceMap": true,                              /* Generates corresponding '.map' file. */
     // "outFile": "./",                             /* Concatenate and emit output to single file. */
     // "outDir": "./",                              /* Redirect output structure to the directory. */
     // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */

package/package-template/webpack.config.js

@@ -6,7 +6,7 @@ module.exports = {
   entry: {
     package: './src/package.js'
   },
-  devtool: 'inline-source-map',
+  devtool: 'source-map',
   externals: {
     'datagrok-api/dg': 'DG',
     'datagrok-api/grok': 'grok',

package/package.json

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