Merge pull request #1259 from Agoric/mk/better-format-hint

lint: highlight `yarn format` usage on errors

Author: mujahidkay

package.json

@@ -12,7 +12,7 @@
     "lint-fix": "yarn lint --fix",
     "lint": "eslint 'snippets/**/*.js'",
     "format": "node scripts/markdown-js-snippets-linter.mjs 'main/**/*.md' --fix && prettier --write '**/*.md' --config .prettierrc.json",
-    "lint:format": "node scripts/markdown-js-snippets-linter.mjs 'main/**/*.md' && prettier --check '**/*.md' --config .prettierrc.json",
+    "lint:format": "node scripts/format.mjs",
     "build": "exit 0"
   },
   "packageManager": "[email protected]",

scripts/format.mjs

@@ -0,0 +1,12 @@
+import { exec } from 'child_process';
+
+exec('node scripts/markdown-js-snippets-linter.mjs "main/**/*.md" && prettier --check "**/*.md" --config .prettierrc.json', (err, stdout, stderr) => {
+  if (err) {
+    const modifiedStderr = stderr.replace(
+      'Run Prettier with --write to fix',
+      'Run `yarn format` to fix'
+    );
+    console.warn(modifiedStderr);
+    process.exit(1);
+  }
+});

scripts/markdown-js-snippets-linter.mjs

@@ -206,7 +206,7 @@ const processFiles = async (globPattern, fix = false) => {
       if (fix) {
         console.log("All matching files have been updated with the necessary changes.");
       } else {
-        console.error("Run with --fix to automatically fix these errors and replace \`\`\`javascript with \`\`\`js.");
+        console.error("Run `yarn format` to automatically fix these errors");
       }
     } else {
       console.log("No errors found in any of the matching files.");