Skip to content

Readme run through - minor fixes - #1236

Merged
BethGriggs merged 5 commits into
nodejs:mainfrom
pacostas:readme-run-through
Nov 12, 2026
Merged

BethGriggs merged 5 commits into
nodejs:mainfrom
pacostas:readme-run-through

Conversation

@pacostas

@pacostas pacostas commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR:

  • syncs the Readme file with the correct output of the citgm and citgm-all help commands
  • On the readme examples, updates the lodash tag version with one that exists on the releases
  • Moves the citgm-all CLI example from the common-args.js file to citgm-all.js file with the rest of the citgm-all examples
Checklist
  • npm test passes
  • documentation is changed or added
  • contribution guidelines followed
    here

@codecov-commenter

codecov-commenter commented Nov 9, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.11%. Comparing base (c31531d) to head (89c76d6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1236   +/-   ##
=======================================
  Coverage   96.11%   96.11%           
=======================================
  Files          29       29           
  Lines        2213     2213           
=======================================
  Hits         2127     2127           
  Misses         86       86           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

MikeMcC399

This comment was marked as resolved.

@MikeMcC399 MikeMcC399 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@pacostas

Copy link
Copy Markdown
Contributor Author

Do you think is better to update the Readme file with the exact output (in terms of format) that citgm gives at the current moment? E.g. Currently the citgm output is the following:

citgm [options] <module>

Options:
  -h, --help                 Show help                                 [boolean]
      --version              Show version number                       [boolean]
      --config               Path to JSON config file
  -v, --verbose, --loglevel  Verbose output
        [choices: "silly", "verbose", "info", "warn", "error"] [default: "info"]
  -q, --npm-loglevel         Verbose output for npm
        [choices: "silly", "verbose", "info", "warn", "error", "http", "silent"]
                                                              [default: "error"]
  -l, --lookup               Use the lookup table provided at <path>    [string]
  -d, --nodedir              Path to the node source to use when compiling
                             native addons                              [string]
      --tmpDir               Directory to test modules in               [string]
  -p, --test-path            Path to prepend to $PATH when running tests[string]
  -a, --append               Append results to file rather than replace[boolean]
  -n, --no-color             Turns off colorized output                [boolean]
  -s, --su                   Allow running the tool as root.           [boolean]
  -m, --markdown             Output results in markdown                [boolean]
  -t, --tap                  Output results in tap with optional file path
      --customTest           Run a custom node test script instead of "npm test"
                                                                        [string]
  -x, --junit                Output results in junit xml with optional file path
  -o, --timeout              Set timeout for `install` and `test` phases[number]
  -y, --yarn                 Install and test the project using yarn instead of
                             npm                      [boolean] [default: false]
      --pnpm                 Install and test the project using pnpm instead of
                             npm                      [boolean] [default: false]
  -u, --uid                  Set the uid (posix only)                   [number]
  -g, --gid                  Set the gid (posix only)                   [number]
  -c, --sha                  Install module from commit-sha, branch or tag
                                                                        [string]

Examples:
  citgm-all --customTest                    Runs a custom node test script
  /path/to/customTest.js                    instead of "npm test"

compared to what is on the Readme file.

Usage: citgm [options] <module>

Options:

  -h, --help                  output usage information
  --version                   output the version number
  --config                    Path to a JSON config file
  -v, --verbose, --loglevel [level], Verbose output (silly, verbose, info, warn, error)
  -q, --npm-loglevel [level]  Verbose output (silent, error, warn, http, info, verbose, silly)
  -l, --lookup <path>         Use the lookup table provided at <path>
  -d, --nodedir <path>        Path to the node source to use when compiling native addons
  -p, --test-path <path>      Path to prepend to $PATH when running tests
  -n, --no-color              Turns off colorized output
  -s, --su                    Allow running the tool as root.
  -m, --markdown              Output results in markdown
  -t, --tap [path]            Output results in tap with optional file path
  --customTest <path>         Run a custom node test script instead of "npm test"
  -x, --junit [path]          Output results in junit xml with optional file path
  -o, --timeout <length>      Set timeout for npm install
  -c, --sha <commit-sha>      Install module from commit-sha, branch or tag
  -y, --yarn                  Install and test the project using yarn instead of npm
  --pnpm                      Install and test the project using pnpm instead of npm
  -u, --uid <uid>             Set the uid (posix only)
  -g, --gid <uid>             Set the gid (posix only)
  -a, --append                Turns on append results to file mode rather than replace
  --tmpDir <path>             Directory to test modules in

The output is different, probably due to the yargs package has changed the default format since the last time the help output on the readme got updated.

@MikeMcC399

Copy link
Copy Markdown
Member

Do you think is better to update the Readme file with the exact output (in terms of format) that citgm gives at the current moment? E.g. Currently the citgm output is the following:

I didn't check it exactly, however it does seem more logical to have the README and the help text exactly aligned. You could wait for feedback from maintainers of the repo. I'm just a contributor here like you are.

@BethGriggs

Copy link
Copy Markdown
Member

@pacostas, I like the idea of syncing it exactly

@pacostas

pacostas commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor Author

@BethGriggs I agree, I updated it. Is better to have the current format, despite the many diffs on this PR for the --help, on subsequent PRs it will be only a few characters each time the --help is getting updated.

@BethGriggs
BethGriggs merged commit 1204259 into nodejs:main Nov 12, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants