DEV Community

Ramu Narasinga
Ramu Narasinga

Posted on • Edited on

Scan for CLI flags and arguments using MRI package

In this article, an overview of MRI package is provided with a usage example picked from Changesets source code.

MRI package:

You can use MRI package to quickly scan for flags and arguments. It is an alternative to yargs-parser.

Install

npm install - save mri
Enter fullscreen mode Exit fullscreen mode

Usage

// Example CLI with options 
$ demo-cli - foo - bar=baz -mtv - hello world
Enter fullscreen mode Exit fullscreen mode

The following code is picked from MRI npm package documentation.

const mri = require('mri');
const argv = process.argv.slice(2);
mri(argv);
//=> { _: ['hello', 'world'], foo:true, bar:'baz', m:true, t:true, v:true }
mri(argv, { boolean:['bar'] });
//=> { _: ['baz', 'hello', 'world'], foo:true, bar:true, m:true, t:true, v:true }
mri(argv, {
 alias: {
 b: 'bar',
 foo: ['f', 'fuz']
 }
});
//=> { _: ['hello', 'world'], foo:true, f:true, fuz:true, b:'baz', bar:'baz', m:true, t:true, v:true }
Enter fullscreen mode Exit fullscreen mode

Read more about the options:

In essence, we get the CLI args converted into an object. Now that we understand the basics of MRI, it is time we look at its usage in Changesets.

MRI usage in Changesets:

MRI is found to be imported in Changesets CLI package

Image description

When you add a changeset using the command npx changeset add or npx changeset, these are accessed in the CLI package as shown below.

const args = process.argv.slice(2);
Enter fullscreen mode Exit fullscreen mode

Parsing CLI args in changeset

The below code shows how mri used in Changeset CLI package

const parsed = mri(args, {
 boolean: ["sinceMaster", "verbose", "empty", "open", "gitTag", "snapshot"],
 string: [
 "output",
 "otp",
 "since",
 "ignore",
 "tag",
 "snapshot",
 "snapshotPrereleaseTemplate",
 ],
 alias: {
 // Short flags
 v: "verbose",
 o: "output",
 // Support kebab-case flags
 "since-master": "sinceMaster",
 "git-tag": "gitTag",
 "snapshot-prerelease-template": "snapshotPrereleaseTemplate",
 // Deprecated flags
 "update-changelog": "updateChangelog",
 "is-public": "isPublic",
 "skip-c-i": "skipCI",
 },
 default: {
 gitTag: true,
 },
});
Enter fullscreen mode Exit fullscreen mode

parsed value will look like below, I deduced this based on the documentation:

{
 // string value (if you have used 'add' in npx changeset add)
 ['add'],
// boolean values
 "sinceMaster": true, 
 "verbose": true, 
 "empty": true, 
 "open": true, 
 "gitTag": true, 
 "snapshot": true
// string values
 // Note: if you have passed these options in your CLI, these keys will be parsed as string, no matter the what you pass in
 // example: if you pass in - otp=123, 123 here, even though is a number, gets parsed as string since otp is configured to be parsed as
 // string in the above code
 "output",
 "otp",
 "since",
 "ignore",
 "tag",
 "snapshot",
 "snapshotPrereleaseTemplate",
// The alias option in mri allows you to define alternative names (aliases) for CLI arguments.
 // This is particularly useful for supporting:
// Short flags: Such as -v for - verbose.
 // Kebab-case flags: Allowing flags like - since-master to map to camelCase variables in JavaScript (e.g., sinceMaster).
 // Deprecated flags: If you want to support older names for backward compatibility but still map them to the current property names.
}
Enter fullscreen mode Exit fullscreen mode

parsed variable is used in a function named run imported from /run.ts

// run function call
run(parsed._, parsed, cwd).catch((err)
Enter fullscreen mode Exit fullscreen mode

The first parameter is pared._ because in the documentation, it is provided that parsed commands like ‘add’ looks like { _: [‘add’]}

// run function definition
export async function run(
 input: string[],
 flags: { [name: string]: any },
 cwd: string
) {
Enter fullscreen mode Exit fullscreen mode

parsed contains mri parsed object based on the CLI args and the configuration set for booleans, strings, defaults, aliases.

cwd is a current working directory, you can get this with process.cwd()

About me:

Hey, my name is Ramu Narasinga. I study large open-source projects and create content about their codebase architecture and best practices, sharing it through articles, videos.

I am open to work on an interesting project. Send me an email at ramu.narasinga@gmail.com

My Github - https://github.com/ramu-narasinga
My website - https://ramunarasinga.com
My Youtube channel - https://www.youtube.com/@thinkthroo
Learning platform - https://thinkthroo.com
Codebase Architecture - https://app.thinkthroo.com/architecture
Best practices - https://app.thinkthroo.com/best-practices
Production-grade projects - https://app.thinkthroo.com/production-grade-projects

References:

  1. https://www.npmjs.com/package/mri

  2. https://github.com/changesets/changesets/blob/main/packages/cli/src/index.ts#L1C18-L1C21

  3. https://github.com/changesets/changesets/blob/main/packages/cli/src/index.ts#L9

Postgres on Neon - Get the Free Plan

No credit card required. The database you love, on a serverless platform designed to help you build faster.

Get Postgres on Neon

Top comments (0)

👋 Kindness is contagious

Discover a treasure trove of wisdom within this insightful piece, highly respected in the nurturing DEV Community enviroment. Developers, whether novice or expert, are encouraged to participate and add to our shared knowledge basin.

A simple "thank you" can illuminate someone's day. Express your appreciation in the comments section!

On DEV, sharing ideas smoothens our journey and strengthens our community ties. Learn something useful? Offering a quick thanks to the author is deeply appreciated.

Okay