Cleanup

Author: OEvgeny

package.json

@@ -173,7 +173,8 @@
     "start:test-dev-server": "cd packages && cd test && cd dev-server && npm start",
     "start:test-harness": "cd packages && cd test && cd harness && npm start",
     "start:test-page-object": "cd packages && cd test && cd page-object && npm start",
-    "test": "jest"
+    "test": "jest",
+    "vg": "vg"
   },
   "pinDependencies": {
     "@testing-library/react": [

packages/vibe-grep/README.md

@@ -25,6 +25,8 @@ Built on top of [`ast-grep`](https://ast-grep.github.io/), vibe-grep provides ex
 Create a `.js` file in the `commands/` directory:
 
 ```js
+export const description = 'Short command description.';
+
 export function help(...args) {
    // Print command help (optional)
 }

packages/vibe-grep/src/commands/ast-check.js

@@ -11,15 +11,17 @@ const dirname = path.dirname(new URL(import.meta.url).pathname);
 
 const parseAllToJSON = yamlContent => YAML.parseAllDocuments(yamlContent).map(doc => doc.toJSON());
 
+export const description = 'Verify one or more files using an AST-Grep preset.';
+
 export function help() {
   console.log(`Usage: vg ast-check <preset> <files...>
 
-Verify one or more files using an AST‑Grep preset.
+${description}
 
 Arguments:
-  <preset>   Name of the preset to use.  Presets are located in the "rules"
+  <preset>   Name of the preset to use. Presets are located in the "rules"
              directory next to this script and can be YAML or JS files.
-  <files...> One or more files to verify.  Shell glob expansion happens
+  <files...> One or more files to verify. Shell glob expansion happens
              outside this tool, so pass files directly.
 `);
 
@@ -28,7 +30,6 @@ Arguments:
     .readdirSync(path.resolve(dirname, '../rules'))
     .filter(file => file.endsWith('.yaml') || file.endsWith('.yml') || file.endsWith('.js'));
 
-  const examples = [];
   console.log('Available presets:');
   for (const rule of rules) {
     // eslint-disable-next-line security/detect-non-literal-fs-filename
@@ -42,27 +43,23 @@ Arguments:
     for (const ruleData of rules) {
       console.log(`    ${ruleData.id || '(unnamed)'} - ${ruleData.description || 'No description provided.'}`);
       if (ruleData.args && Array.isArray(ruleData.args)) {
-        examples.push(`vg ast-check ${ruleName} ${ruleData.args.join(' ')}`);
+        console.log(`      Example: vg ast-check ${ruleName} ${ruleData.args.join(' ')}`);
       }
     }
   }
-  if (examples.length > 0) {
-    console.log('\nExample usage:');
-    for (const example of examples) {
-      console.log(`  ${example}`);
-    }
-  }
 }
 
 export default async function run(...args) {
   if (args.length === 0) {
     console.error('Error: no preset specified for ast-check command.');
+    help();
     return;
   }
   const preset = args.shift();
   const files = args;
   if (files.length === 0) {
     console.error('Error: no files provided for ast-check command.');
+    help();
     return;
   }
   // Resolve the preset file.
@@ -132,13 +129,14 @@ export default async function run(...args) {
       const matches = root.findAll(matcher);
       if (matches.length > 0) {
         hasViolation = isFatalRule || hasViolation;
-        console.error(`❌ FAIL ${file}: found ${matches.length} violation(s) for rule '${id}'.`);
+        console.error(
+          `${isFatalRule ? '🔴 FAIL' : '🟡 SKIP'} ${file}: found ${matches.length} violation(s) for rule '${id}'.`
+        );
         // Print custom message from the rule if provided.
         if (rule.message) {
           console.error(`   ${rule.severity || 'note'}: ${rule.message}`);
         }
         try {
-          // Extract 1‑based line numbers for each match using ast‑grep's range API.
           const lines = matches.map(node => {
             const rng = node.range();
             return rng.start.line + 1;
@@ -153,7 +151,7 @@ export default async function run(...args) {
           console.error(`      ${file}: <unable to determine line numbers>`);
         }
       } else {
-        console.log(`✅ PASS ${file}: ${id}.`);
+        console.log(`🟢 PASS ${file}: ${id}.`);
       }
     }
   }

packages/vibe-grep/src/commands/help.js

@@ -7,13 +7,15 @@ import path from 'node:path';
 
 const dirname = path.dirname(new URL(import.meta.url).pathname);
 
+export const description = 'Show help information for available commands.';
+
 export function help(...args) {
   const command = args.shift();
 
   if (command === 'help') {
     console.log(`Usage: vg help [command]
 
-Show help information.  If a command is specified, show help for that command.`);
+${description}`);
     return;
   }
 
@@ -30,17 +32,26 @@ Show help information.  If a command is specified, show help for that command.`)
   console.log(`Unknown command: ${command}`);
 }
 
-export default function run(...args) {
+export default async function run(...args) {
   // eslint-disable-next-line security/detect-non-literal-fs-filename
   const commands = fs.readdirSync(dirname).filter(file => file.endsWith('.js'));
 
   if (args.length === 0) {
     console.log('Available commands:');
-    for (const commandFile of commands) {
+    const modules = await Promise.all(
+      commands.map(command =>
+        import(`./${command}`).catch(() => ({
+          description: '<error loading command module>'
+        }))
+      )
+    );
+    for (let i = 0; i < commands.length; i++) {
+      const commandFile = commands.at(i);
+      const commandModule = modules.at(i);
       const command = commandFile.slice(0, -3);
-      console.log(`  ${command}`);
+      console.log(`  ${command} - ${commandModule.description || '(no description provided)'}`);
     }
-    console.log(`\nUse 'vg help <command>' to get help for a specific command.`);
+    console.log(`\nUse 'vg help [command]' to get help for a specific command.`);
     return;
   }
   return help(...args);

packages/vibe-grep/src/rules/dist-types.yaml

@@ -2,7 +2,7 @@
 # This rule checks that generated TypeScript declaration files do not 
 # contain any import or export statements that reference modules
 # under the '@msinternal/' namespace. Such imports/exports indicate
-# that the declarations were not rolled up by the dtsroll tool.
+# that the declarations were not processed by the dtsroll tool.
 
 id: no-msinternal
 language: TypeScript