✏️ Validation of Application Name

Author: alexlee-dev

CHANGELOG.md

@@ -9,10 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Interactive option. Use the flag `--interactive` to use this mode.
+- Interactive option. Use the flag `--interactive` to use this mode
 - Comments :)
 - Cleanup on global error
 - Option for Author Name
+- Validation of application name according to NPM conventions
 
 ### Changed
 

README.md

@@ -68,6 +68,7 @@ Want support for an additional language? Feel free to open a [new issue](https:/
 - [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner.
 - [pickitt](https://pickitt.netlify.com/) - When you need a computer to just pick it, reach for Pickitt!
 - [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript.
+- [validate-npm-package-name](https://github.com/npm/validate-npm-package-name) - Is the given string an acceptable npm package name?
 
 ## ✍️ Authors <a name = "authors"></a>
 

package-lock.json

@@ -38,6 +38,7 @@
     "@types/fs-extra": "^9.0.1",
     "@types/inquirer": "^6.5.0",
     "@types/node": "^14.0.5",
+    "@types/validate-npm-package-name": "^3.0.0",
     "@types/yargs": "^15.0.5",
     "copyfiles": "^2.2.0",
     "typescript": "^3.9.3"
@@ -52,6 +53,7 @@
     "fs-extra": "^9.0.0",
     "inquirer": "^7.1.0",
     "ora": "^4.0.4",
-    "pickitt": "^3.2.0"
+    "pickitt": "^3.2.0",
+    "validate-npm-package-name": "^3.0.0"
   }
 }

package.json

@@ -22,7 +22,7 @@ import {
   replaceTemplateValues,
 } from "./init";
 import { handleIncorrectApplicationName } from "./program";
-import { cleanupError } from "./util";
+import { cleanupError, validateApplicationName } from "./util";
 
 /**
  * Main CLI Program
@@ -70,12 +70,9 @@ const main = async (): Promise<void> => {
       })
       .parse(process.argv);
 
-    // TODO - Catch names like "my.app.name" or "my app name"
-
     // * Application Name must exist, and not consist of illegal characters
-    if (applicationName === "." || !applicationName) {
-      return handleIncorrectApplicationName(program);
-    }
+    validateApplicationName(applicationName);
+    if (!applicationName) return;
 
     if (program.interactive) {
       // * Interactive walk-thru

src/index.ts

@@ -1,6 +1,8 @@
+import chalk from "chalk";
 import { spawn } from "child_process";
 import fs from "fs-extra";
 import path from "path";
+import validateProjectName from "validate-npm-package-name";
 
 /**
  * Executes a command in a spawned process.
@@ -74,3 +76,29 @@ export const valueReplacer = (
     return;
   });
 };
+
+/**
+ * Validates the application name according to NPM naming conventions.
+ * @param applicationName Name of application.
+ */
+export const validateApplicationName = (applicationName: any) => {
+  const validation = validateProjectName(applicationName);
+  if (!validation.validForNewPackages) {
+    console.error(
+      `Cannot create an application named ${chalk.red(
+        `"${applicationName}"`
+      )} because of npm naming restrictions:`
+    );
+    console.log("");
+
+    [...(validation.errors || []), ...(validation.warnings || [])].forEach(
+      (error) => {
+        console.error(chalk.red(`  * ${error}`));
+      }
+    );
+
+    console.log("");
+    console.error("Please choose a different application name.");
+    process.exit(1);
+  }
+};