docs: list of codemods

Author: bjohansebas

.github/actions/generate-help-docs.mjs

@@ -1,6 +1,7 @@
 import { execSync } from 'node:child_process'
 import { readFile, writeFile } from 'node:fs/promises'
 import { join } from 'node:path'
+import { TRANSFORM_OPTIONS } from '../../config.js'
 
 let output = execSync('node ../../index.js --help', {
   encoding: 'utf-8',
@@ -14,9 +15,16 @@ output = output.replace(
 const readmePath = join('..', '..', 'README.md')
 const readme = await readFile(readmePath, 'utf-8')
 
-const updatedReadme = readme.replace(
-  /(?<=<!-- GENERATED START -->\n\n```\n)[\s\S]*?(?=```\n\n<!-- GENERATED END -->)/,
-  output,
-)
+let updatedReadme = readme.replace(/(?<=<!-- USAGE START -->\n\n```\n)[\s\S]*?(?=```\n\n<!-- USAGE END -->)/, output)
+
+const codemods = TRANSFORM_OPTIONS.map(({ value, description, version }) => {
+  return `### ${value.replaceAll('-', ' ')} (v${version})
+
+${description}
+
+`
+}).join('')
+
+updatedReadme = updatedReadme.replace(/(?<=<!-- CODEMODS START -->\n\n)[\s\S]*?(?=<!-- CODEMODS END -->)/, codemods)
 
 await writeFile(readmePath, updatedReadme, 'utf-8')

.github/workflows/generate-readme.yml

@@ -6,6 +6,7 @@ on:
       - main
     paths: 
       - index.ts
+      - config.ts
 
 jobs:
   generate-readme:

README.md

@@ -27,18 +27,40 @@ npm i -g @expressjs/codemod # or pnpm, bun, etc.
 
 Use `@expressjs/codemod -h` to explore available command-line options.
 
-<!-- GENERATED START -->
+<!-- USAGE START -->
 
 ```
 Usage: @expressjs/codemod [codemod] [source] [options]
 
 Options:
   -v, --version  Output the current version of @expressjs/codemod.
   -d, --dry      Dry run (no changes are made to files)
+  -p, --print    Print transformed files to stdout
+  --verbose      Show more information about the transform process
   -h, --help     Display this help message.
 ```
 
-<!-- GENERATED END -->
+<!-- USAGE END -->
+
+## Available Codemods
+
+All the available codemods to update your express server:
+
+<!-- CODEMODS START -->
+
+### magic redirect (5.0.0)
+
+Transform the deprecated magic string "back"
+
+### pluralized methods (5.0.0)
+
+Transform the methods to their pluralized versions
+
+### v4 deprecated signatures (5.0.0)
+
+Transform the deprecated signatures in Express v4
+
+<!-- CODEMODS END -->
 
 ##  Contributing
 

config.ts

@@ -9,9 +9,9 @@ export const TRANSFORM_OPTIONS = [
     value: 'pluralized-methods',
     version: '5.0.0',
   },
-  { 
-    description: 'Transform the deprecated signatures in Express v4', 
-    value: 'v4-deprecated-signatures', 
-    version: '5.0.0'
+  {
+    description: 'Transform the deprecated signatures in Express v4',
+    value: 'v4-deprecated-signatures',
+    version: '5.0.0',
   },
 ]