$comment

To add a comment to a script, use the $comment directive within the scripts object. This helps document your scripts, making them easier to understand and maintain.

export default {
  scripts: {
    "yourScript": "someCommand",
    "$comment (yourScript)": "This script will ..."
  }
}

info

When jko is executed without parameters, it lists the available scripts. Additionally, if a script has a comment, the comment will be displayed after the script's definition information.

$ jko
scripts:
  yourScript: someCommand
    This script will ...

Similarly, when jko gives suggestions, comments will also appear:

$ jko yourScript2
◤
 jko error - yourScript2 not found, similar scripts are:

  yourScript: 'someCommand'
    This script will ...
◣