datagrok-tools 4.4.4 → 4.5.0

package/README.md

@@ -4,27 +4,33 @@ Utility to upload and publish [packages](https://datagrok.ai/help/develop/develo
 
 ## Installation
 
-```
+```shell
 npm install datagrok-tools -g
 ```
 
 ## Usage
 
 1. Configure your environment with the following command:
-    ```
+
+    ```shell
     grok config
     ```
+
    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).
 2. Create a new package by running this command:
-    ```
+
+    ```shell
     grok create <package-name>
     ```
+
    A new folder `<package-name>` will be created automatically as well as its contents.
-3. Run `npm install` in your package directory to get the required dependencies.
-4. Start working on the functionality of your package. Use `  grok add` to create function templates.
+3. Run `npm install` in your package directory to get the required dependencies (the command is called
+   automatically after package creation, if it ran successfully, skip this step).
+4. Start working on the functionality of your package. Use `grok add` to create function templates.
 5. Once you have completed the work on your package, upload it by running:
-    ```
+
+    ```shell
     grok publish
     ```
 
@@ -38,21 +44,27 @@ Read more about package development in [Datagrok's documentation](https://datagr
   keys and offers to interactively change them. It is also possible to reset the current configuration.
 - `create` adds a package template to the current working directory when used without the `name` argument. The directory
   must be empty:
-  ```
+
+  ```shell
   grok create
   ```
+
   When called with an argument, the command creates a package in a folder with the specified name:
-  ```
+
+  ```shell
   grok create <package-name>
   ```
+
   Package name may only include letters, numbers, underscores, or hyphens. Read more about naming
   conventions [here](https://datagrok.ai/help/develop/develop#naming-conventions). Options:
-    - `--eslint` adds a basic configuration for `eslint`
-    - `--ide` adds an IDE-specific configuration for debugging (vscode)
-    - `--ts` creates a TypeScript package template
-    - `--jest` adds a basic configuration for `jest`
+  - `--eslint` adds a basic configuration for `eslint`
+  - `--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`
 - `add` puts an object template to your package:
-  ```
+
+  ```shell
   cd <package-name>
   grok add app <name>
   grok add connection <name>
@@ -63,22 +75,25 @@ Read more about package development in [Datagrok's documentation](https://datagr
   grok add view <name>
   grok add viewer <name>
   ```
+
   In general, entity names follow naming rules for functions. Views and viewers should have class names, we recommend
   that you postfix them with 'View' and 'Viewer' respectively. Supported languages for scripts are `javascript`, `julia`
   , `node`, `octave`, `python`, `r`. Available function tags: `panel`, `init`.
 - `api` creates wrapper functions for package scripts and queries. The output is stored in files `/src/scripts-api.ts`
   and `/src/queries-api.ts` respectively.
 - `publish` uploads a package to the specified server (pass either a URL or a server alias from the `config.yaml` file).
-  ```
+
+  ```shell
   cd <package-name>
   grok publish [host]
   ```
+
   Options:
-    - `--build` or `--rebuild`: boolean flags that indicate whether a local webpack bundle should be used or it should
-      be generated on the server side
-    - `--debug` or `--release`: boolean flags that determine whether to publish a debug version of the package visible
-      only to the developer or a release version accessible by all eligible users and user groups
-    - `--key`: a string containing a developer key that is not listed in the config file, e.g., the key for a new server
-    - `--suffix`: a string containing package version hash
+  - `--build` or `--rebuild`: boolean flags that indicate whether a local webpack bundle should be used or it should
+    be generated on the server side
+  - `--debug` or `--release`: boolean flags that determine whether to publish a debug version of the package visible
+    only to the developer or a release version accessible by all eligible users and user groups
+  - `--key`: a string containing a developer key that is not listed in the config file, e.g., the key for a new server
+  - `--suffix`: a string containing package version hash
 
   Running `grok publish` is the same as running `grok publish defaultHost --build --debug`.

package/bin/commands/create.js

@@ -55,7 +55,7 @@ var dependencies = [];
 
 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] : false;
+  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;
 
@@ -90,8 +90,8 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
 
         for (var server in config.servers) {
           if (server === config["default"]) continue;
-          _package['scripts']["debug-".concat(name.toLowerCase(), "-").concat(server)] = "grok publish ".concat(server, " --rebuild");
-          _package['scripts']["release-".concat(name.toLowerCase(), "-").concat(server)] = "grok publish ".concat(server, " --rebuild --release");
+          _package['scripts']["debug-".concat(name.toLowerCase(), "-").concat(server)] = "webpack && grok publish ".concat(server);
+          _package['scripts']["release-".concat(name.toLowerCase(), "-").concat(server)] = "webpack && grok publish ".concat(server, " --release");
         }
 
         if (ts) Object.assign(_package.devDependencies, {
@@ -177,12 +177,14 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
 }
 
 function create(args) {
+  var options = ['ide', 'js', 'ts', 'eslint', 'jest'];
   var nOptions = Object.keys(args).length - 1;
   var nArgs = args['_'].length;
-  if (nArgs > 2 || nOptions > 3) return false;
+  if (nArgs > 2 || nOptions > 4) return false;
   if (nOptions && !Object.keys(args).slice(1).every(function (op) {
-    return ['ide', 'ts', 'eslint', 'jest'].includes(op);
-  })) return false; // Create `config.yaml` if it doesn't exist yet
+    return options.includes(op);
+  })) return false;
+  if (args.js && args.ts) return color.error('Incompatible options: --js and --ts'); // Create `config.yaml` if it doesn't exist yet
 
   if (!_fs["default"].existsSync(grokDir)) _fs["default"].mkdirSync(grokDir);
   if (!_fs["default"].existsSync(confPath)) _fs["default"].writeFileSync(confPath, _jsYaml["default"].dump(confTemplate));
@@ -253,8 +255,9 @@ function create(args) {
 
       process.exit();
     });
-    createDirectoryContents(name, config, templateDir, packageDir, args.ide, args.ts, args.eslint, args.jest);
-    console.log(_entHelpers.help["package"](name, args.ts));
+    createDirectoryContents(name, config, templateDir, packageDir, args.ide, !!args.ts, !!args.eslint, !!args.jest);
+    color.success('Successfully created package ' + name);
+    console.log(_entHelpers.help["package"](!!args.ts));
     console.log("\nThe package has the following dependencies:\n".concat(dependencies.join(' '), "\n"));
     console.log('Running `npm install` to get the required dependencies...\n');
     (0, _child_process.exec)('npm install', {

package/bin/commands/help.js

@@ -8,7 +8,7 @@ var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCom
 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>\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_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] [--ts] [--jest]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--ts        Create a TypeScript package\n--jest      Add a configuration for jest\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_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 = {

package/bin/utils/ent-helpers.js

@@ -38,9 +38,8 @@ var viewer = function viewer(viewerName) {
   return "\nThe viewer ".concat(viewerName, " has been added successfully\nRead more at https://datagrok.ai/help/develop/how-to/develop-custom-viewer\nSee examples at https://github.com/datagrok-ai/public/tree/master/packages/Viewers,\nhttps://public.datagrok.ai/js/samples/functions/custom-viewers/viewers");
 };
 
-var _package = function _package(name) {
-  var ts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return "\nSuccessfully created package `".concat(name, "`").concat(ts ? '' : '\nConsider TypeScript as a language for package development, to start over, run `grok create` with the `--ts` flag', "\nLikely next steps: `grok add` to add functionality, `grok publish` to upload the package");
+var _package = function _package(ts) {
+  return ts ? '' : 'Consider TypeScript as a language for package development, to start over, run `grok create` with the `--ts` flag\n' + 'Likely next steps: `grok add` to add functionality, `grok publish` to upload the package';
 };
 
 var help = {

package/package-template/package.json

@@ -16,7 +16,7 @@
   },
   "scripts": {
     "link-all": "",
-    "debug-#{PACKAGE_NAME_LOWERCASE}": "webpack && grok publish ",
+    "debug-#{PACKAGE_NAME_LOWERCASE}": "webpack && grok publish",
     "release-#{PACKAGE_NAME_LOWERCASE}": "webpack && grok publish --release",
     "build-#{PACKAGE_NAME_LOWERCASE}": "webpack",
     "build": "webpack"

package/package.json

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