@adobe/aio-cli-plugin-config - npm Package Compare versions

Comparing version 4.0.1 to 5.0.0

oclif.manifest.json

@@ -1,1 +0,477 @@
-{"version":"4.0.1","commands":{"config:clear":{"id":"config:clear","description":"clears all persistent config values","strict":true,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":[],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","hidden":true,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","hidden":true,"allowNo":false,"exclusive":["json"]},"force":{"name":"force","type":"boolean","char":"f","description":"do not prompt for confirmation","allowNo":false}},"args":[]},"config:delete":{"id":"config:delete","description":"deletes persistent config values","strict":false,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":["config:del","config:rm"],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","hidden":true,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","hidden":true,"allowNo":false,"exclusive":["json"]}},"args":[{"name":"keys...","required":true}]},"config:edit":{"id":"config:edit","description":"edit config file","strict":true,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":[],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","hidden":true,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","hidden":true,"allowNo":false,"exclusive":["json"]}},"args":[]},"config:get":{"id":"config:get","description":"gets a persistent config value","strict":true,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":[],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","description":"output in json","hidden":false,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","description":"output in yaml","hidden":false,"allowNo":false,"exclusive":["json"]},"env":{"name":"env","type":"boolean","char":"e","description":"environment variables","allowNo":false}},"args":[{"name":"key","required":true}]},"config":{"id":"config","description":"list, get, set, delete, and edit persistent configuration data","strict":true,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":["config:ls"],"examples":["$ aio config:list","$ aio config:get KEY","$ aio config:set KEY VALUE","$ aio config:delete KEY","$ aio config:clear"],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","description":"output in json","hidden":false,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","description":"output in yaml","hidden":false,"allowNo":false,"exclusive":["json"]},"env":{"name":"env","type":"boolean","char":"e","description":"environment variables","allowNo":false},"verbose":{"name":"verbose","type":"boolean","description":"show all config values","allowNo":false,"exclusive":["yaml","json"]}},"args":[]},"config:list":{"id":"config:list","description":"lists all persistent config values","strict":true,"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":["config:ls"],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","description":"output in json","hidden":false,"allowNo":false,"exclusive":["yaml"]},"yaml":{"name":"yaml","type":"boolean","char":"y","description":"output in yaml","hidden":false,"allowNo":false,"exclusive":["json"]},"env":{"name":"env","type":"boolean","char":"e","description":"environment variables","allowNo":false},"verbose":{"name":"verbose","type":"boolean","description":"show all config values","allowNo":false,"exclusive":["yaml","json"]}},"args":[]},"config:set":{"id":"config:set","description":"sets a persistent config value","strict":true,"usage":["config set key 'a value'       # set key to 'a value'","config set key -f value.json   # set key to the json found in the file value.json","config set -j key < value.json # set key to the json found in the file value.json"],"pluginName":"@adobe/aio-cli-plugin-config","pluginAlias":"@adobe/aio-cli-plugin-config","pluginType":"core","aliases":[],"flags":{"local":{"name":"local","type":"boolean","char":"l","description":"local config","allowNo":false,"exclusive":["global"]},"global":{"name":"global","type":"boolean","char":"g","description":"global config","allowNo":false,"exclusive":["local"]},"json":{"name":"json","type":"boolean","char":"j","description":"value is json","hidden":false,"allowNo":false},"yaml":{"name":"yaml","type":"boolean","char":"y","description":"value is yaml","hidden":false,"allowNo":false},"file":{"name":"file","type":"boolean","char":"f","description":"value is a path to a file","allowNo":false,"exclusive":["interactive"]},"interactive":{"name":"interactive","type":"boolean","char":"i","description":"prompt for value","allowNo":false,"exclusive":["file"]}},"args":[{"name":"key","required":true},{"name":"value|filename","required":false}]}}}
+{
+  "version": "5.0.0",
+  "commands": {
+    "config:clear": {
+      "id": "config:clear",
+      "description": "clears all persistent config values",
+      "strict": true,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "do not prompt for confirmation",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "config:delete": {
+      "id": "config:delete",
+      "description": "deletes persistent config values",
+      "strict": false,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:del",
+        "config:rm"
+      ],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        }
+      },
+      "args": {
+        "keys...": {
+          "name": "keys...",
+          "required": true
+        }
+      }
+    },
+    "config:edit": {
+      "id": "config:edit",
+      "description": "edit config file",
+      "strict": true,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "hidden": true,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "config:get": {
+      "id": "config:get",
+      "description": "gets a persistent config value",
+      "strict": true,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "description": "output in yaml",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        },
+        "env": {
+          "name": "env",
+          "type": "boolean",
+          "char": "e",
+          "description": "environment variables",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "key": {
+          "name": "key",
+          "required": true
+        }
+      }
+    },
+    "config": {
+      "id": "config",
+      "description": "list, get, set, delete, and edit persistent configuration data",
+      "strict": true,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:ls"
+      ],
+      "examples": [
+        "$ aio config:list",
+        "$ aio config:get KEY",
+        "$ aio config:set KEY VALUE",
+        "$ aio config:delete KEY",
+        "$ aio config:clear"
+      ],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "description": "output in yaml",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        },
+        "env": {
+          "name": "env",
+          "type": "boolean",
+          "char": "e",
+          "description": "environment variables",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "description": "show all config values",
+          "allowNo": false,
+          "exclusive": [
+            "yaml",
+            "json"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "config:list": {
+      "id": "config:list",
+      "description": "lists all persistent config values",
+      "strict": true,
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:ls"
+      ],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "yaml"
+          ]
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "description": "output in yaml",
+          "hidden": false,
+          "allowNo": false,
+          "exclusive": [
+            "json"
+          ]
+        },
+        "env": {
+          "name": "env",
+          "type": "boolean",
+          "char": "e",
+          "description": "environment variables",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "description": "show all config values",
+          "allowNo": false,
+          "exclusive": [
+            "yaml",
+            "json"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "config:set": {
+      "id": "config:set",
+      "description": "sets a persistent config value",
+      "strict": true,
+      "usage": [
+        "config set key 'a value'       # set key to 'a value'",
+        "config set key -f value.json   # set key to the json found in the file value.json",
+        "config set -j key < value.json # set key to the json found in the file value.json"
+      ],
+      "pluginName": "@adobe/aio-cli-plugin-config",
+      "pluginAlias": "@adobe/aio-cli-plugin-config",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "local": {
+          "name": "local",
+          "type": "boolean",
+          "char": "l",
+          "description": "local config",
+          "allowNo": false,
+          "exclusive": [
+            "global"
+          ]
+        },
+        "global": {
+          "name": "global",
+          "type": "boolean",
+          "char": "g",
+          "description": "global config",
+          "allowNo": false,
+          "exclusive": [
+            "local"
+          ]
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "value is json",
+          "hidden": false,
+          "allowNo": false
+        },
+        "yaml": {
+          "name": "yaml",
+          "type": "boolean",
+          "char": "y",
+          "description": "value is yaml",
+          "hidden": false,
+          "allowNo": false
+        },
+        "file": {
+          "name": "file",
+          "type": "boolean",
+          "char": "f",
+          "description": "value is a path to a file",
+          "allowNo": false,
+          "exclusive": [
+            "interactive"
+          ]
+        },
+        "interactive": {
+          "name": "interactive",
+          "type": "boolean",
+          "char": "i",
+          "description": "prompt for value",
+          "allowNo": false,
+          "exclusive": [
+            "file"
+          ]
+        }
+      },
+      "args": {
+        "key": {
+          "name": "key",
+          "required": true
+        },
+        "value|filename": {
+          "name": "value|filename",
+          "required": false
+        }
+      }
+    }
+  }
+}

package.json

 {
   "name": "@adobe/aio-cli-plugin-config",
   "description": "Config Plugin for the Adobe I/O CLI",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "author": "Adobe Inc.",
   "bugs": "https://github.com/adobe/aio-cli-plugin-config/issues",
   "dependencies": {
-    "@adobe/aio-lib-core-config": "^3.0.0",
+    "@adobe/aio-lib-core-config": "^5",
     "@oclif/core": "^1.3.5",
     "hjson": "^3.2.2",
-    "js-yaml": "^3.14.1"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@adobe/eslint-config-aio-lib-config": "^1.4.0",
+    "@adobe/eslint-config-aio-lib-config": "^2.0.1",
     "acorn": "^8.7.0",
     "chalk": "^4.0.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.46.0",
     "eslint-config-oclif": "^4.0.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^23.20.0",
-    "eslint-plugin-jsdoc": "^37.2.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-jsdoc": "^42.0.0",
+    "eslint-plugin-n": "^15.7",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.2.0",
+    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^4.0.1",
     "execa": "^4.0.2",
     "globby": "^11.0.0",
-    "jest": "^27.5.1",
-    "jest-haste-map": "^27.5.1",
-    "jest-junit": "^13.0.0",
-    "jest-resolve": "^27.5.1",
+    "jest": "^29",
+    "jest-haste-map": "^29.5.0",
+    "jest-junit": "^16.0.0",
+    "jest-resolve": "^29.5.0",
     "oclif": "^3.2.0",
-    "stdout-stderr": "^0.1.13"
+    "stdout-stderr": "^0.1.13",
+    "typescript": "^5.1.6"
   },
   "engines": {
-    "node": "^14.18 || ^16.13 || >=18"
+    "node": ">=18"
   },
@@ -38,0 +40,0 @@ "files": [

README.md

@@ -82,3 +82,3 @@ <!--
 
-_See code: [src/commands/config/index.js](https://github.com/adobe/aio-cli-plugin-config/blob/4.0.1/src/commands/config/index.js)_
+_See code: [src/commands/config/index.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/index.ts)_
 
@@ -102,2 +102,4 @@ ## `aio config clear`
 
+_See code: [src/commands/config/clear.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/clear.ts)_
+
 ## `aio config delete KEYS...`
@@ -109,3 +111,3 @@
 USAGE
-  $ aio config delete [KEYS...] [-l | -g]
+  $ aio config delete KEYS... [-l | -g]
 
@@ -124,2 +126,4 @@ FLAGS
 
+_See code: [src/commands/config/delete.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/delete.ts)_
+
 ## `aio config edit`
@@ -141,2 +145,4 @@
 
+_See code: [src/commands/config/edit.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/edit.ts)_
+
 ## `aio config get KEY`
@@ -148,3 +154,3 @@
 USAGE
-  $ aio config get [KEY] [-l | -g] [-j | -y] [-e]
+  $ aio config get KEY [-l | -g] [-j | -y] [-e]
 
@@ -162,2 +168,4 @@ FLAGS
 
+_See code: [src/commands/config/get.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/get.ts)_
+
 ## `aio config list`
@@ -186,2 +194,4 @@
 
+_See code: [src/commands/config/list.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/list.ts)_
+
 ## `aio config set key 'a value'       # set key to 'a value'`
@@ -208,2 +218,4 @@
 ```
+
+_See code: [src/commands/config/set.ts](https://github.com/adobe/aio-cli-plugin-config/blob/5.0.0/src/commands/config/set.ts)_
 <!-- commandsstop -->

src/base-command.js

@@ -38,3 +38,3 @@ /*
       } else if (format === 'yaml') {
-        this.log(yaml.safeDump(obj, { sortKeys: true, lineWidth: 1024, noCompatMode: true }))
+        this.log(yaml.dump(obj, { sortKeys: true, lineWidth: 1024, noCompatMode: true }))
       } else {
@@ -41,0 +41,0 @@ if (typeof obj !== 'object') {

src/commands/config/edit.js

@@ -23,4 +23,4 @@ /*
     const cmd = (process.platform === 'win32')
-      ? `${process.env.EDITOR || 'notepad'}`
-      : `${process.env.EDITOR || 'vi'}`
+      ? process.env.EDITOR || 'notepad'
+      : process.env.EDITOR || 'vi'
     childProcess.spawn(cmd, [file], {
@@ -27,0 +27,0 @@ stdio: 'inherit',

src/commands/config/set.js

@@ -57,3 +57,3 @@ /*
       } else if (flags.yaml) {
-        value = yaml.safeLoad(value)
+        value = yaml.load(value)
       }
@@ -60,0 +60,0 @@ } catch (e) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44466

increased by15.13%

Lines of code

805

increased by144.68%

Number of lines in readme file

213

increased by5.97%

Worsened metrics

Dev dependency count

22

increased by10%

Dependency changes

• + Added@adobe/aio-lib-core-config@5.0.1(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addeddotenv@16.3.1(transitive)

• + Addedjs-yaml@4.1.0(transitive)

• - Removed@adobe/aio-lib-core-config@3.1.0(transitive)

• - Removeddotenv@8.2.0(transitive)

• Updated@adobe/aio-lib-core-config@^5

• Updatedjs-yaml@^4.1.0