Support "npm run writers" to display a list of writer-focused tools (#58326)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: sarahs

package-lock.json

@@ -19,11 +19,13 @@
     "build": "next build --webpack",
     "check-content-type": "tsx src/workflows/check-content-type.ts",
     "check-github-github-links": "tsx src/links/scripts/check-github-github-links.ts",
+    "clone-early-access": "./src/early-access/scripts/clone-locally",
     "clone-translations": "./src/languages/scripts/clone-translations.sh",
     "cmp-files": "tsx src/workflows/cmp-files.ts",
     "content-changes-table-comment": "tsx src/workflows/content-changes-table-comment.ts",
     "copy-fixture-data": "tsx src/tests/scripts/copy-fixture-data.ts",
     "count-translation-corruptions": "cross-env NODE_OPTIONS=--max-old-space-size=8192 tsx src/languages/scripts/count-translation-corruptions.ts",
+    "create-early-access-branch": "./src/early-access/scripts/create-branch",
     "create-enterprise-issue": "tsx src/ghes-releases/scripts/create-enterprise-issue.ts",
     "cta-builder": "tsx src/content-render/scripts/cta-builder.ts",
     "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.ts",
@@ -102,7 +104,8 @@
     "validate-asset-images": "tsx src/assets/scripts/validate-asset-images.ts",
     "validate-github-github-docs-urls": "tsx src/links/scripts/validate-github-github-docs-urls/index.ts",
     "warmup-remotejson": "tsx src/archives/scripts/warmup-remotejson.ts",
-    "what-docs-early-access-branch": "tsx src/early-access/scripts/what-docs-early-access-branch.ts"
+    "what-docs-early-access-branch": "tsx src/early-access/scripts/what-docs-early-access-branch.ts",
+    "writers": "tsx src/workflows/writers-help-metadata.ts"
   },
   "lint-staged": {
     "*.{ts,tsx}": "eslint --cache --fix",

package.json

@@ -1,6 +1,8 @@
 /**
- * This script iterates over all pages and all reusables and looks for
- * mentions of variables in Liquid syntax. For example,
+ * @purpose Writer tool
+ * @description Look for mentions of variables in Liquid syntax across all pages
+ *
+ * For example,
  *
  *    ---
  *    title: '{% data variables.product.prodname_mobile %} is cool'

src/content-linter/scripts/find-unsed-variables.ts

@@ -1,3 +1,7 @@
+/**
+ * @purpose Writer tool
+ * @description Run the Docs content linter, specifying paths and optional rules
+ */
 // @ts-nocheck
 import fs from 'fs'
 import path from 'path'

src/content-linter/scripts/lint-content.ts

@@ -1,7 +1,7 @@
-// This script auto-populates the `contentType` frontmatter property based on
-// the directory location of the content file.
-// Run with:
-// npm run-script -- add-content-type --help
+/**
+ * @purpose Writer tool
+ * @description Auto-populate the `contentType` frontmatter property based on the directory location of the content file
+ */
 
 import fs from 'fs'
 import path from 'path'

src/content-render/scripts/add-content-type.ts

@@ -1,3 +1,7 @@
+/**
+ * @purpose Writer tool
+ * @description Create a properly formatted Call-to-Action URL with tracking parameters
+ */
 import { Command } from 'commander'
 import readline from 'readline'
 import chalk from 'chalk'