datagrok-tools 5.1.2 → 5.1.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Datagrok-tools changelog
 
+## 5.1.3 (2026-02-03)
+
+* GROK-19407:
+  * Improved developer experience for grok check, grok api, grok publish
+  * Fixed warnings all over the packages when using grok check
+
+### Bug Fixes
+
 ## 4.14.72 (2026-01-13)
 
 ### Bug Fixes

package/bin/commands/api.js

@@ -21,11 +21,13 @@ const funcFilePath = _path.default.join(_fs.default.existsSync(srcDir) ? srcDir
 const packagePath = _path.default.join(curDir, 'package.json');
 const names = new Set();
 let _package = {};
-function generateQueryWrappers() {
+function generateQueryWrappers(verbose) {
   const queriesDir = _path.default.join(curDir, 'queries');
   if (!_fs.default.existsSync(queriesDir)) {
-    color.warn(`Directory ${queriesDir} not found`);
-    console.log('Skipping API generation for queries...');
+    if (verbose) {
+      color.warn(`Directory ${queriesDir} not found`);
+      console.log('Skipping API generation for queries...');
+    }
     return;
   }
   const files = _ignoreWalk.default.sync({
@@ -51,14 +53,16 @@ function generateQueryWrappers() {
       wrappers.push(tb.build(1));
     }
   }
-  saveWrappersToFile('queries', wrappers);
+  saveWrappersToFile('queries', wrappers, verbose);
 }
-function generateScriptWrappers() {
+function generateScriptWrappers(verbose) {
   const scriptsDir = _path.default.join(curDir, 'scripts');
   const pythonDir = _fs.default.existsSync(srcDir) ? _path.default.join(srcDir, 'python') : _path.default.join(curDir, 'python');
   if (!_fs.default.existsSync(scriptsDir)) {
-    color.warn(`Directory ${scriptsDir} not found`);
-    console.log('Skipping API generation for scripts...');
+    if (verbose) {
+      color.warn(`Directory ${scriptsDir} not found`);
+      console.log('Skipping API generation for scripts...');
+    }
     return;
   }
   const wrappers = [];
@@ -85,9 +89,9 @@ function generateScriptWrappers() {
       wrappers.push(tb.build(1));
     }
   }
-  saveWrappersToFile('scripts', wrappers);
+  saveWrappersToFile('scripts', wrappers, verbose);
 }
-function generateFunctionWrappers() {
+function generateFunctionWrappers(verbose) {
   let filesToParse = packageFuncDirs.map(e => _path.default.join(curDir, 'src', e)).filter(e => _fs.default.existsSync(e));
   const annotaionRegex = /(?:\/\/[^\n]*\n)+export[^{]*/g;
   const nameRegex = /\s*export(?:\sasync)?\s*function\s*([^\s(]*)/;
@@ -109,17 +113,17 @@ function generateFunctionWrappers() {
       wrappers.push(tb.build(1));
     }
   }
-  saveWrappersToFile('funcs', wrappers);
+  saveWrappersToFile('funcs', wrappers, verbose);
 }
-function saveWrappersToFile(namespaceName, wrappers) {
+function saveWrappersToFile(namespaceName, wrappers, verbose) {
   if (wrappers.length === 0) return;
-  if (!_fs.default.existsSync(funcFilePath)) createApiFile();
+  if (!_fs.default.existsSync(funcFilePath)) createApiFile(verbose);
   const scriptApi = new utils.TemplateBuilder(utils.namespaceTemplate).replace('PACKAGE_NAMESPACE', namespaceName).replace('NAME', wrappers.join(sep.repeat(2)));
   _fs.default.appendFileSync(funcFilePath, sep + scriptApi.build() + sep);
-  color.success(`Successfully generated file ${apiFile}${sep}`);
+  if (verbose) color.success(`Successfully generated file ${apiFile}${sep}`);
 }
-function createApiFile() {
-  if (_fs.default.existsSync(funcFilePath)) {
+function createApiFile(verbose) {
+  if (_fs.default.existsSync(funcFilePath) && verbose) {
     color.warn(`The file ${funcFilePath} already exists`);
     console.log('Rewriting its contents...');
   }
@@ -130,19 +134,20 @@ function checkNameColision(name) {
   names.add(name);
 }
 function api(args) {
+  const verbose = args.verbose || args.v || false;
   _package = JSON.parse(_fs.default.readFileSync(packagePath, {
     encoding: 'utf-8'
   }));
   if (_package.friendlyName) _package.friendlyName = _package.friendlyName.replaceAll(' ', '');
-  const nOptions = Object.keys(args).length - 1;
+  const nOptions = Object.keys(args).length - 1 - (args.verbose ? 1 : 0) - (args.v ? 1 : 0);
   if (args['_'].length !== 1 || nOptions > 0) return false;
   if (!utils.isPackageDir(process.cwd())) {
     color.error('File `package.json` not found. Run the command from the package directory');
     return false;
   }
-  createApiFile();
-  generateScriptWrappers();
-  generateQueryWrappers();
-  generateFunctionWrappers();
+  createApiFile(verbose);
+  generateScriptWrappers(verbose);
+  generateQueryWrappers(verbose);
+  generateFunctionWrappers(verbose);
   return true;
 }

package/bin/commands/check.js

@@ -26,16 +26,17 @@ const warns = ['Latest package version', 'Datagrok API version should contain'];
 const forbiddenNames = ['function', 'class', 'export'];
 const namesInFiles = new Map();
 function check(args) {
+  const verbose = args.verbose || args.v || false;
   const curDir = args._.length == 2 ? args._[1] : process.cwd();
-  if (args.recursive) return runChecksRec(curDir, args.soft ?? false);else {
+  if (args.recursive) return runChecksRec(curDir, args.soft ?? false, verbose);else {
     if (!utils.isPackageDir(curDir)) {
       color.error('File `package.json` not found. Run the command from the package directory');
       return false;
     }
-    return runChecks(curDir, args.soft ?? false);
+    return runChecks(curDir, args.soft ?? false, false, verbose);
   }
 }
-function runChecks(packagePath, soft = false, noExit = false) {
+function runChecks(packagePath, soft = false, noExit = false, verbose = false) {
   if (packagePath.includes(`${_path.default.sep}node_modules${_path.default.sep}`)) return true;
   const files = _ignoreWalk.default.sync({
     path: packagePath,
@@ -89,10 +90,10 @@ function runChecks(packagePath, soft = false, noExit = false) {
     if (soft || json.version.startsWith('0') || errors.every(w => warns.some(ww => w.includes(ww)))) return true;
     if (noExit) return false;else testUtils.exitWithCode(1);
   }
-  console.log(`Checking package ${_path.default.basename(packagePath)}...\t\t\t\u2713 OK`);
+  if (verbose) console.log(`Checking package ${_path.default.basename(packagePath)}...\t\t\t\u2713 OK`);
   return true;
 }
-function runChecksRec(dir, soft = false) {
+function runChecksRec(dir, soft = false, verbose = false) {
   const files = _fs.default.readdirSync(dir);
   let allPassed = true;
   for (const file of files) {
@@ -100,11 +101,11 @@ function runChecksRec(dir, soft = false) {
     const stats = _fs.default.statSync(filepath);
     if (stats.isDirectory()) {
       if (utils.isPackageDir(filepath)) {
-        const passed = runChecks(filepath, soft, true);
+        const passed = runChecks(filepath, soft, true, verbose);
         allPassed = allPassed && passed;
       } else {
         if (file !== 'node_modules' && !file.startsWith('.')) {
-          const passed = runChecksRec(_path.default.join(dir, file), soft);
+          const passed = runChecksRec(_path.default.join(dir, file), soft, verbose);
           allPassed = allPassed && passed;
         }
       }
@@ -492,10 +493,14 @@ function checkNpmIgnore(packagePath) {
 }
 function checkScriptNames(packagePath) {
   const warnings = [];
+  // Only check source code files - test data and documentation can have descriptive names with spaces
+  const sourceExtensions = ['.ts', '.js', '.py', '.r', '.jl', '.m', '.sql'];
   try {
     if (_fs.default.existsSync(packagePath)) {
       const filesInDirectory = getAllFilesInDirectory(packagePath);
       for (const fileName of filesInDirectory) {
+        const ext = _path.default.extname(fileName).toLowerCase();
+        if (!sourceExtensions.includes(ext)) continue;
         if (fileName.match(new RegExp('^[A-Za-z0-9._-]*$'))?.length !== 1) warnings.push(`${fileName}: file name contains inappropriate symbols`);
       }
     }
@@ -503,13 +508,14 @@ function checkScriptNames(packagePath) {
   return warnings;
 }
 function getAllFilesInDirectory(directoryPath) {
-  const excludedFilesToCheck = ['node_modules', 'dist'];
+  // Exclude directories that typically contain test data, fixtures, or documentation
+  const excludedDirs = ['node_modules', 'dist', 'files', 'fixtures', 'data', 'templates', 'test-data', 'scenarios', 'samples', 'demo', 'docs', 'documentation'];
   let fileNames = [];
   const entries = _fs.default.readdirSync(directoryPath);
   entries.forEach(entry => {
     const entryPath = _path.default.join(directoryPath, entry);
     const stat = _fs.default.statSync(entryPath);
-    if (stat.isFile()) fileNames.push(entry);else if (stat.isDirectory() && !excludedFilesToCheck.includes(entry)) {
+    if (stat.isFile()) fileNames.push(entry);else if (stat.isDirectory() && !excludedDirs.includes(entry.toLowerCase())) {
       const subDirectoryFiles = getAllFilesInDirectory(entryPath);
       fileNames = fileNames.concat(subDirectoryFiles);
     }

package/bin/commands/help.js

@@ -70,6 +70,11 @@ const HELP_API = `
 Usage: grok api
 
 Create wrapper functions for package scripts and queries
+
+Options:
+[-v | --verbose]
+
+--verbose         Print detailed output
 `;
 const HELP_CONFIG = `
 Usage: grok config
@@ -111,15 +116,15 @@ Uploads a package
 Checks for errors before publishing — the package won't be published if there are any.
 
 Options:
-[--all] [--refresh] [--link] [--build] [--release] [--skip-check] 
+[--all] [--refresh] [--link] [--build] [--release] [--skip-check] [-v | --verbose]
 
---all             Publish all available packages(run in packages directory)
---refresh         Publish all available already loaded packages(run in packages directory)
---link  	        Link the package to local packages
---build  	        Builds the package
+--all             Publish all available packages (run in packages directory)
+--refresh         Publish all available already loaded packages (run in packages directory)
+--link            Link the package to local packages
+--build           Builds the package
 --release         Publish package as release version
---skip-check      Skip check stage 
---verbose         Show debug information
+--skip-check      Skip check stage
+--verbose         Print detailed output
 
 Running \`grok publish\` is the same as running \`grok publish defaultHost --build --debug\`
 `;
@@ -127,10 +132,11 @@ const HELP_CHECK = `
 Usage: grok check <pluginFolder>
 
 Options:
-[-r | --recursive]
+[-r | --recursive] [-v | --verbose]
 
 --recursive       Check all packages in the current directory
 --soft            Even if an error occurs, it doesn't throw an exception
+--verbose         Print detailed output
 
 Check package content (function signatures, import statements of external modules, etc.)
 `;

package/bin/commands/publish.js

@@ -35,7 +35,7 @@ let curDir = process.cwd();
 const packDir = _path.default.join(curDir, 'package.json');
 const packageFiles = ['src/package.ts', 'src/detectors.ts', 'src/package.js', 'src/detectors.js', 'src/package-test.ts', 'src/package-test.js', 'package.js', 'detectors.js'];
 let config;
-async function processPackage(debug, rebuild, host, devKey, packageName, dropDb, suffix, verbose) {
+async function processPackage(debug, rebuild, host, devKey, packageName, dropDb, suffix, hostAlias, verbose = false) {
   // Get the server timestamps
   verbose = verbose || false;
   let timestamps = {};
@@ -84,9 +84,7 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
       rebuild = true;
     }
   }
-
-  // let contentValidationLog = '';
-  console.log('Starting package checks...');
+  if (verbose) console.log('Starting package checks...');
   const checkStart = Date.now();
   const jsTsFiles = files.filter(f => !f.startsWith('dist/') && (f.endsWith('.js') || f.endsWith('.ts')));
   const packageFilePath = _path.default.join(curDir, 'package.json');
@@ -98,20 +96,9 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
     const content = _fs.default.readFileSync(webpackConfigPath, {
       encoding: 'utf-8'
     });
-    // const externals = extractExternals(content);
-    // if (externals) {
-    //   const importWarnings = checkImportStatements(curDir, jsTsFiles, externals);
-    //   contentValidationLog += importWarnings.join('\n') + (importWarnings.length ? '\n' : '');
-    // }
   }
   const funcFiles = jsTsFiles.filter(f => packageFiles.includes(f));
-  // const funcWarnings = checkFuncSignatures(curDir, funcFiles);
-  // contentValidationLog += funcWarnings.join('\n') + (funcWarnings.length ? '\n' : '');
-  // const packageWarnings = checkPackageFile(curDir, json);
-  // contentValidationLog += packageWarnings.join('\n') + (packageWarnings.length ? '\n' : '');
-  // const changelogWarnings = checkChangelog(curDir, json);
-  // contentValidationLog += changelogWarnings.join('\n') + '';
-  console.log(`Checks finished in ${Date.now() - checkStart} ms`);
+  if (verbose) console.log(`Checks finished in ${Date.now() - checkStart} ms`);
   const reg = new RegExp(/\${(\w*)}/g);
   const errs = [];
   files.forEach(file => {
@@ -127,13 +114,10 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
     }
     if (relativePath.startsWith('upload.keys.json')) return;
     if (relativePath === 'zip') return;
-    // if (!utils.checkScriptLocation(canonicalRelativePath)) {
-    //   contentValidationLog += `Warning: file \`${canonicalRelativePath}\`` +
-    //     ` should be in directory \`${path.basename(curDir)}/scripts/\`\n`;
-    // }
     const t = _fs.default.statSync(fullPath).mtime.toUTCString();
     localTimestamps[canonicalRelativePath] = t;
     if (debug && timestamps[canonicalRelativePath] === t) {
+      if (verbose) console.log(`Skipping ${canonicalRelativePath}`);
       return;
     }
     if (canonicalRelativePath.startsWith('connections/')) {
@@ -152,11 +136,13 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
       zip.append(f, {
         name: relativePath
       });
+      if (verbose) console.log(`Adding ${canonicalRelativePath}...`);
       return;
     }
     zip.append(_fs.default.createReadStream(fullPath), {
       name: relativePath
     });
+    if (verbose) console.log(`Adding ${canonicalRelativePath}...`);
   });
   if (errs.length) {
     errs.forEach(e => color.error(e));
@@ -184,8 +170,10 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
         console.error(log['innerMessage']);
         console.log(log);
         return 1;
-      } else console.log(log);
-      // color.warn(contentValidationLog);
+      } else {
+        if (verbose) console.log(log);
+        color.success(`✓ Published to ${hostAlias || new URL(host).hostname}`);
+      }
     }
   } catch (error) {
     if (utils.isConnectivityError(error)) color.error(`Server is possibly offline: ${url}`);
@@ -195,8 +183,10 @@ async function processPackage(debug, rebuild, host, devKey, packageName, dropDb,
   return 0;
 }
 async function publish(args) {
+  const verbose = args.verbose || args.v || false;
   if (!args['skip-check'] && !args['all'] && !args['refresh']) (0, _check.check)({
-    _: ['check']
+    _: ['check'],
+    verbose: verbose
   });
   config = _jsYaml.default.load(_fs.default.readFileSync(confPath, {
     encoding: 'utf-8'
@@ -218,27 +208,27 @@ async function publish(args) {
       packagesToLoad = (await (await (0, _nodeFetch.default)(url, {
         method: 'GET',
         headers: {
-          'Authorization': token // Attach cookies here
+          'Authorization': token
         }
       })).json()).map(item => item.name);
     }
-    console.log('Loading packages:');
+    if (verbose) console.log('Loading packages:');
     await (0, _testUtils.loadPackages)(curDir, packagesToLoad.join(' '), host, false, false, args.link, args.release);
   } else {
     if (args.link) {
-      console.log('Linking');
+      if (verbose) console.log('Linking');
       await utils.runScript(`npm install`, curDir);
       await utils.runScript(`grok link`, curDir);
       await utils.runScript(`npm run build`, curDir);
     }
-    await publishPackage(args);
+    await publishPackage(args, verbose);
   }
 }
-async function publishPackage(args) {
+async function publishPackage(args, verbose) {
   const nArgs = args['_'].length;
   if (!args.link) {
     if (args.build || args.rebuild) {
-      console.log('Building');
+      if (verbose) console.log('Building');
       await utils.runScript('npm install', curDir, false);
       await utils.runScript('npm run build', curDir, false);
     }
@@ -247,7 +237,7 @@ async function publishPackage(args) {
     color.error('Incompatible options: --debug and --release');
     return false;
   }
-  console.log('Publishing...');
+  if (verbose) console.log('Publishing...');
   // 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));
@@ -296,12 +286,12 @@ async function publishPackage(args) {
         if (!args.suffix && stdout) args.suffix = stdout.toString().substring(0, 8);
       });
       await utils.delay(100);
-      code = await processPackage(!args.release, Boolean(args.rebuild), url, key, packageName, args.dropDb ?? false, args.suffix, args.verbose);
+      code = await processPackage(!args.release, Boolean(args.rebuild), url, key, packageName, args.dropDb ?? false, args.suffix, host, verbose);
     } catch (error) {
       console.error(error);
       code = 1;
     }
-    console.log(`Exiting with code ${code}`);
+    if (verbose) console.log(`Exiting with code ${code}`);
     process.exit(code);
   });
   return true;

package/package.json

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