datagrok-tools 4.12.11 → 4.12.12

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Datagrok-tools changelog
+
+## 4.12.12 (WIP)
+
+### Features
+
+* Check for datagrok-api dependency
+
+### Bug Fixes
+
+* Latest package version in CHANGELOG check fix
+
+## 4.12.11 (2023-08-04)
+
+### Features
+
+* GROK-13643 Check improvements:
+  * There is no beta property in package.json
+  * No datagrok-tools in dependencies (or latest version)
+  * Latest version from package.json is in CHANGELOG (warning)
+  * Ignore CHANGELOG checks for service packages ("servicePackage" property in package.json)
+  * Change supported h2 formats (1.7.9 (2023-07-24) and 1.7.9 (WIP))
+  * For packages < 1.0.0 exit with exit code 0, and only show warnings. And for packages >= 1.0.0, exit with a non-zero code (only for check command)
+  * If an invalid flag/command is specified, output the help and exit with exit code 1
+
+## 4.12.10 (2023-08-01)
+
+### Features
+
+* Video recording enhancements
+
+### Bug Fixes
+
+* FuncSignatures check fix
+
+## 4.12.7 (2023-07-28)
+
+### Features
+
+* Tools: Changelog h2 new format
+
+## 4.12.4 (2023-07-24)
+
+### Features
+
+* GROK-13573 Tools: simplify output (add --verbose flag)
+* GROK-13573 Tools: checks for changelog

package/bin/commands/check.js

@@ -73,12 +73,17 @@ function runChecks(packagePath) {
   if (warnings.length) {
     console.log("Checking package ".concat(_path["default"].basename(packagePath), "..."));
     warn(warnings);
-    if (json.version.startsWith('0') || warnings.length === 1 && warnings[0].startsWith('Latest package version')) return true;
+    if (json.version.startsWith('0') || warnings.every(function (w) {
+      return warns.some(function (ww) {
+        return w.includes(ww);
+      });
+    })) return true;
     testUtils.exitWithCode(1);
   }
   console.log("Checking package ".concat(_path["default"].basename(packagePath), "...\t\t\t\u2713 OK"));
   return true;
 }
+var warns = ['Latest package version', 'Datagrok API version should contain'];
 function runChecksRec(dir) {
   var files = _fs["default"].readdirSync(dir);
   var _iterator = _createForOfIteratorHelper(files),
@@ -346,7 +351,7 @@ var sharedLibExternals = {
   }
 };
 function checkPackageFile(packagePath, json, options) {
-  var _json$devDependencies, _json$devDependencies2, _json$dependencies;
+  var _json$dependencies, _json$devDependencies, _json$devDependencies2, _json$dependencies2;
   var warnings = [];
   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.');
@@ -367,7 +372,11 @@ function checkPackageFile(packagePath, json, options) {
   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 (json.version.includes('beta') && isPublicPackage) warnings.push('File "package.json": public package cannot be beta version.');
-  var dt = (_json$devDependencies = (_json$devDependencies2 = json.devDependencies) === null || _json$devDependencies2 === void 0 ? void 0 : _json$devDependencies2['datagrok-tools']) !== null && _json$devDependencies !== void 0 ? _json$devDependencies : (_json$dependencies = json.dependencies) === null || _json$dependencies === void 0 ? void 0 : _json$dependencies['datagrok-tools'];
+  var api = (_json$dependencies = json.dependencies) === null || _json$dependencies === void 0 ? void 0 : _json$dependencies['datagrok-api'];
+  if (api) {
+    if (api === '../../js-api') {} else if (api === 'latest') warnings.push('File "package.json": you should specify Datagrok API version constraint.');else if (!(api.startsWith('^') || api.startsWith('>'))) warnings.push('File "package.json": Datagrok API version should contain "^" or ">" symbol, otherwise it is locked to the single Datagrok version.');
+  }
+  var dt = (_json$devDependencies = (_json$devDependencies2 = json.devDependencies) === null || _json$devDependencies2 === void 0 ? void 0 : _json$devDependencies2['datagrok-tools']) !== null && _json$devDependencies !== void 0 ? _json$devDependencies : (_json$dependencies2 = json.dependencies) === null || _json$dependencies2 === void 0 ? void 0 : _json$dependencies2['datagrok-tools'];
   if (dt && dt !== 'latest') warnings.push('File "package.json": "datagrok-tools" dependency must be "latest" version.');
   if (Array.isArray(json.sources) && json.sources.length > 0) {
     var _iterator6 = _createForOfIteratorHelper(json.sources),
@@ -408,7 +417,7 @@ function checkPackageFile(packagePath, json, options) {
   return warnings;
 }
 function checkChangelog(packagePath, json) {
-  var _h2$0$match;
+  var _h2$0$match, _h2$, _h2$$match;
   var warnings = [];
   var clf;
   try {
@@ -435,8 +444,9 @@ function checkChangelog(packagePath, json) {
     _iterator7.f();
   }
   regex = /^## (\d+\.\d+\.\d+)/;
-  var v = (_h2$0$match = h2[0].match(regex)) === null || _h2$0$match === void 0 ? void 0 : _h2$0$match[1];
-  if (v && v !== json.version) warnings.push("Latest package version (".concat(json.version, ") is not in CHANGELOG"));
+  var v1 = (_h2$0$match = h2[0].match(regex)) === null || _h2$0$match === void 0 ? void 0 : _h2$0$match[1];
+  var v2 = (_h2$ = h2[1]) === null || _h2$ === void 0 ? void 0 : (_h2$$match = _h2$.match(regex)) === null || _h2$$match === void 0 ? void 0 : _h2$$match[1];
+  if (v1 !== json.version && v2 !== json.version) warnings.push("Latest package version (".concat(json.version, ") is not in CHANGELOG"));
   return warnings;
 }
 function warn(warnings) {

package/package.json

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