validate-npm-package-name icon indicating copy to clipboard operation
validate-npm-package-name copied to clipboard

[Feature Request] Simple CLI tool to validate package names

Open aarondill opened this issue 2 years ago • 6 comments

This package would be even further useful if a simple CLI was included for use in scripts. I envision this tool as something along the following:

validate-npm-package-name "valid-name" # Returns 0, no output

validate-npm-package-name "Invalid name:here" # Returns 1
# Stderr: 
# name can no longer contain capital letters
# name can only contain URL-friendly characters

This would allow for usage in scripts, and would further the usability of this tool. The errors given would be the exact same as those given by the 'errors' property in the Javascript API. By default, this tool would return errors if the name is no longer acceptable, but perhaps a `--legacy`` option could be adopted to return errors only on legacy errors. Alternatively, the tool could provide different return values depending on invalidity, (ie, if valid: 0, if legacy valid: 1, if never valid: 2).

aarondill avatar Jan 04 '23 03:01 aarondill

Hey @aarondill , is this issue still open?

CodeVibranium avatar Jun 16 '23 09:06 CodeVibranium

yes. although it seems like maybe this repo is in maintenance-only mode?

aarondill avatar Jun 16 '23 16:06 aarondill

yes. although it seems like maybe this repo is in maintenance-only mode? @aarondill , If there are any issues to fix please let me know.

CodeVibranium avatar Jun 16 '23 17:06 CodeVibranium

@lukekarrys: Would you be open to a PR for this? Any opinions about what the name of the CLI should be?

broofa avatar Apr 22 '24 17:04 broofa

Sure, I'm in. CLI name, give me some time @broofa

CodeVibranium avatar Apr 22 '24 18:04 CodeVibranium

I think the current package name, although a little verbose, makes the most sense.

A good pattern to follow would be this repo where I recently separated the index and bin script https://github.com/npm/installed-package-contents/pull/72

lukekarrys avatar Apr 23 '24 01:04 lukekarrys