can-npm-publish - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

bin/cmd.js

@@ -33,3 +33,5 @@ #!/usr/bin/env node
 
-canNpmPublish(cli.input[0])
+canNpmPublish(cli.input[0], {
+    verbose: cli.flags.verbose
+})
     .then(() => {
@@ -36,0 +38,0 @@ process.exit(0);

lib/can-npm-publish.js

@@ -8,15 +8,22 @@ // MIT © 2018 azu
  * Return rejected promise if the package name is invalid
- * @param packagePath
+ * @param {string} packagePath
+ * @param {{verbose:boolean}} options
  * @returns {Promise}
  */
-const checkPkgName = packagePath => {
+const checkPkgName = (packagePath, options) => {
     return readPkg(packagePath).then(pkg => {
         const name = pkg["name"];
         const result = validatePkgName(name);
-        if (!result.validForNewPackages) {
+        // Treat Legacy Names as valid
+        // https://github.com/npm/validate-npm-package-name#legacy-names
+        // https://github.com/azu/can-npm-publish/issues/8
+        const isInvalidNamingInNewRule = !result.validForNewPackages;
+        if (isInvalidNamingInNewRule) {
             if (Array.isArray(result.errors)) {
                 return Promise.reject(new Error(result.errors.join("\n")));
-            } else {
-                return Promise.reject(new Error(JSON.stringify(result)));
             }
+            // warning is ignored by default
+            if (options.verbose && result.warnings) {
+                console.log(result.warnings.join("\n"));
+            }
         }
@@ -28,3 +35,3 @@ });
  * Return rejected promise if the package is not `private:true`
- * @param packagePath
+ * @param {string} packagePath
  * @returns {Promise}
@@ -93,5 +100,15 @@ */
 };
-const canNpmPublish = packagePath => {
-    return Promise.all([checkPkgName(packagePath), checkAlreadyPublish(packagePath), checkPrivateField(packagePath)]);
+/**
+ *
+ * @param {string} packagePath
+ * @param {{verbose : boolean}} options
+ * @returns {Promise<[any]>}
+ */
+const canNpmPublish = (packagePath, options = { verbose: false }) => {
+    return Promise.all([
+        checkPkgName(packagePath, options),
+        checkAlreadyPublish(packagePath),
+        checkPrivateField(packagePath)
+    ]);
 };
 module.exports.canNpmPublish = canNpmPublish;

package.json

 {
   "name": "can-npm-publish",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A command line tool that check to see if `npm publish` is possible.",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

8878

increased by7.22%

Lines of code

145

increased by15.08%

No dependency changes