README.md

nest.land

Return it's a valid nest.land package name or not.
All functions never throw an error.

In Deno you can import as follows:

import {
  isValidNestLand,
  validateNestLand
} from "https://deno.land/x/is_valid_package_name/nest_land/mod.ts";

For Node.js, you can get the same functionality by looking at here and installing the package.

Overview

isValidNestLand:

isValidNestLand(undefined); // false
isValidNestLand(null); // false
isValidNestLand("~"); // false
isValidNestLand("is-valid-package-name"); // false
isValidNestLand("Abc"); // false
isValidNestLand("?hogehoge"); // false

validateNestLand:

validateNestLand(undefined); // [false, INVALID_NOT_STRING]
validateNestLand(undefined, true); // [false, [INVALID_NOT_STRING]]
validateNestLand("a"); // [false, INVALID_LESS_THAN_2]
validateNestLand("is_valid_package_name"); // [true, '']

Naming Rules

Below is a list of rules that valid npm package name should conform to.

The rules from source code.

Rule	Name	Return value
The input type is string.	INVALID_NOT_STRING	Name must be a string
Package name length must be greater than zero.	INVALID_LENGTH_0	Name length must be greater than zero
Package name should not contain any leading or trailing spaces.	INVALID_TRIMMABLE	Name cannot contain leading or trailing spaces
Package name length should be greater than 1.	INVALID_LESS_THAN_2	Name length must be greater than 1
Package name length should be less than 41.	INVALID_GREATER_THAN_40	Name length must be less than 41
Package name should only the characters a-z, 0-9 and _ .	INVALID_SPECIAL_CHAR	Name contains only the characters a-z, 0-9 and _
Package name cannot be the same as core module name.	INVALID_CORE_MODULE_NAME	Name is standard module name
Package name cannot be the same as reserved name.	INVALID_RESERVED_NAME	Name is reserved name

core module and reserved name is here.

API

isValidNestLand

Returns whether the value is valid as a package name.

Type Definition:

declare const isValidNestLand: (val: unknown) => boolean;

Example

isValidNestLand(0); // false
isValidNestLand({}); // false
isValidNestLand("favicon.ico"); // false
isValidNestLand("is-valid-package-name"); // false
isValidNestLand("node"); // false
isValidNestLand("_package"); // true

validateNestLand

Returns a boolean and error message tuple indicating whether the value is valid as a package name.

Type Definition:

declare const validateNestLand: <T extends boolean = false>(
  val: unknown,
  checkAll?: T | undefined
) => T extends true ? [boolean, string[]] : [boolean, string];

Example

By default, it returns a result as soon as a validation error occurs.

validateNestLand(".package"); // [false, INVALID_SPECIAL_CHAR]
validateNestLand(" Abc"); // [false, INVALID_TRIMMABLE]
const [result, error] = validateNestLand("fonction"); // [true, '']

if (!result) {
  console.error(error);
}

checkAll?

The checkAll option must be true to return all validation errors.

const [result, errors] = validateNestLand("", true); // [false, [INVALID_LENGTH_0, INVALID_LESS_THAN_2, INVALID_SPECIAL_CHAR]]

if (!result) {
  errors.forEach(error => console.error(error));
}