shipthis 0.0.8 → 0.0.20

package/docs/login.md

@@ -0,0 +1,28 @@
+# login
+
+## Description
+
+Authenticate - will create a new account if one does not exist.
+
+## Example
+
+[![asciicast](https://asciinema.org/a/sbE3KOpIzgh72lLVdZEXlQZFd.svg)](https://asciinema.org/a/sbE3KOpIzgh72lLVdZEXlQZFd)
+
+## Help Output
+
+```
+USAGE
+  $ shipthis login [-f] [-e <value>]
+
+FLAGS
+  -e, --email=<value>  Your email address
+  -f, --force
+
+DESCRIPTION
+  Authenticate - will create a new account if one does not exist.
+
+EXAMPLES
+  $ shipthis login
+
+  $ shipthis login --force --email me@email.nowhere
+```

package/docs/status.md

@@ -0,0 +1,18 @@
+# status
+
+## Description
+
+Displays the current overall status.
+
+## Help Output
+
+```
+USAGE
+  $ shipthis status
+
+DESCRIPTION
+  Displays the current overall status.
+
+EXAMPLES
+  $ shipthis status
+```

package/oclif.manifest.json

@@ -109,7 +109,7 @@
         },
         "appleEmail": {
           "char": "e",
-          "description": "Your Apple email address",
+          "description": "Your Apple Developer email address",
           "name": "appleEmail",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -135,7 +135,7 @@
     "apple:status": {
       "aliases": [],
       "args": {},
-      "description": "Shows the status of the Apple authentication and integration",
+      "description": "Shows the status of the Apple authentication and integration.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -147,6 +147,7 @@
       "pluginName": "shipthis",
       "pluginType": "core",
       "strict": true,
+      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "dist",
@@ -158,7 +159,7 @@
     "game:create": {
       "aliases": [],
       "args": {},
-      "description": "Create a new game",
+      "description": "Create a new game in ShipThis.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -204,7 +205,7 @@
     "game:details": {
       "aliases": [],
       "args": {},
-      "description": "Shows and sets the details of a game. If --gameId is not provided it will look in the current directory.",
+      "description": "Shows and sets the details of a game.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
@@ -333,7 +334,7 @@
     "game:list": {
       "aliases": [],
       "args": {},
-      "description": "Shows a list of all your games",
+      "description": "Shows a list of all your games.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -403,7 +404,7 @@
     "game:ship": {
       "aliases": [],
       "args": {},
-      "description": "Builds the app (for all platforms with valid credentials) and ships it to the stores",
+      "description": "Builds the app (for all platforms with valid credentials) and ships it to the stores.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -436,7 +437,7 @@
     "game:status": {
       "aliases": [],
       "args": {},
-      "description": "Shows the Game status. If --gameId is not provided it will look in the current directory.",
+      "description": "Shows the status of the current game.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
@@ -477,7 +478,7 @@
       "flags": {
         "forceStep": {
           "char": "f",
-          "description": "Force a specific step to run. You can repeat this flag to force multiple steps.",
+          "description": "Force a specific step to run.",
           "name": "forceStep",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -487,7 +488,8 @@
           "char": "p",
           "description": "The platform to run the wizard for",
           "name": "platform",
-          "required": true,
+          "required": false,
+          "default": "ios",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
@@ -515,7 +517,7 @@
     "apple:certificate:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an iOS Distribution Certificate in your Apple Developer account and saves it with the private key to your ShipThis account",
+      "description": "Creates an iOS Distribution Certificate in your Apple Developer account.\nSaves the certificate with the private key to your ShipThis account",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -631,7 +633,7 @@
     "apple:certificate:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts. These are used to sign all of your iOS apps.",
+      "description": "Displays the status of the iOS Distribution certificates in your Apple and ShipThis accounts.\nThese are used to sign all of your iOS apps.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -661,10 +663,143 @@
         "status.js"
       ]
     },
+    "game:build:download": {
+      "aliases": [],
+      "args": {
+        "build_id": {
+          "description": "The ID of the build to download",
+          "name": "build_id",
+          "required": true
+        },
+        "file": {
+          "description": "Name of the file to output",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Downloads the given build artifact to the specified file",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite the file if it already exists",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:download",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "download.js"
+      ]
+    },
+    "game:build:list": {
+      "aliases": [],
+      "args": {},
+      "description": "Lists the builds for successful jobs of a game.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageNumber": {
+          "char": "p",
+          "description": "The page number to show (starts at 0)",
+          "name": "pageNumber",
+          "default": 0,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageSize": {
+          "char": "s",
+          "description": "The number of items to show per page",
+          "name": "pageSize",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "orderBy": {
+          "char": "o",
+          "description": "The field to order by",
+          "name": "orderBy",
+          "default": "createdAt",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "createdAt",
+            "updatedAt"
+          ],
+          "type": "option"
+        },
+        "order": {
+          "char": "r",
+          "description": "The order to sort by",
+          "name": "order",
+          "default": "desc",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "asc",
+            "desc"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:list",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "list.js"
+      ]
+    },
     "apple:apiKey:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an App Store Connect API Key in your Apple Developer account and saves the private key in your ShipThis account",
+      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --force"
@@ -780,7 +915,7 @@
     "apple:apiKey:status": {
       "aliases": [],
       "args": {},
-      "description": "Displays the status of the App Store Connect API Keys in your Apple and ShipThis accounts. The API key is used to automatically publish your games to the App Store.",
+      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --noAppleAuth"
@@ -810,139 +945,6 @@
         "status.js"
       ]
     },
-    "game:build:download": {
-      "aliases": [],
-      "args": {
-        "build_id": {
-          "description": "The ID of the build to download",
-          "name": "build_id",
-          "required": true
-        },
-        "file": {
-          "description": "Name of the file to output",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Downloads the given build artifact to the specified file",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "Overwrite the file if it already exists",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:download",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "download.js"
-      ]
-    },
-    "game:build:list": {
-      "aliases": [],
-      "args": {},
-      "description": "Lists the builds for successful jobs of a game.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageNumber": {
-          "char": "p",
-          "description": "The page number to show (starts at 0)",
-          "name": "pageNumber",
-          "default": 0,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageSize": {
-          "char": "s",
-          "description": "The number of items to show per page",
-          "name": "pageSize",
-          "default": 10,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "orderBy": {
-          "char": "o",
-          "description": "The field to order by",
-          "name": "orderBy",
-          "default": "createdAt",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "createdAt",
-            "updatedAt"
-          ],
-          "type": "option"
-        },
-        "order": {
-          "char": "r",
-          "description": "The order to sort by",
-          "name": "order",
-          "default": "desc",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "asc",
-            "desc"
-          ],
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:list",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "list.js"
-      ]
-    },
     "game:ios:status": {
       "aliases": [],
       "args": {},
@@ -981,7 +983,7 @@
     "game:job:list": {
       "aliases": [],
       "args": {},
-      "description": "Lists the jobs for a game. If --gameId is not provided it will look in the current directory.",
+      "description": "Lists the jobs for a game.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --gameId 0c179fc4"
@@ -1177,7 +1179,7 @@
     "game:ios:app:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates an App and BundleId in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.",
+      "description": "Creates an App and BundleId in the Apple Developer Portal.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -1241,7 +1243,7 @@
     "game:ios:app:status": {
       "aliases": [],
       "args": {},
-      "description": "Shows the Game iOS App status. If --gameId is not provided it will look in the current directory.",
+      "description": "Shows the Game iOS App status. ",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -1276,7 +1278,7 @@
     "game:ios:app:sync": {
       "aliases": [],
       "args": {},
-      "description": "Synchronies the Apple App \"BundleId\" with the capabilities from the local project. If --gameId is not provided it will look in the current directory.",
+      "description": "Synchronies the Apple App \"BundleId\" with the capabilities from the local project.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -1324,7 +1326,7 @@
     "game:ios:profile:create": {
       "aliases": [],
       "args": {},
-      "description": "Creates a Mobile Provisioning Profile in the Apple Developer Portal. If --gameId is not provided it will look in the current directory.",
+      "description": "Creates a Mobile Provisioning Profile in the Apple Developer Portal.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -1467,7 +1469,7 @@
     "game:ios:profile:status": {
       "aliases": [],
       "args": {},
-      "description": "Shows the Game iOS Mobile Provisioning Profile Status. If --gameId is not provided it will look in the current directory.",
+      "description": "Shows the Game iOS Mobile Provisioning Profile Status.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -1506,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.8"
+  "version": "0.0.20"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.8",
+  "version": "0.0.20",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"
@@ -41,6 +41,7 @@
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
     "@types/chai": "^4",
+    "@types/ejs": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
     "@types/ini": "^4.1.1",
     "@types/jsonwebtoken": "^9.0.6",
@@ -54,6 +55,7 @@
     "@types/tough-cookie": "^4.0.5",
     "@types/yazl": "^2.4.5",
     "chai": "^4",
+    "ejs": "^3.1.10",
     "eslint": "^8",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",
@@ -73,6 +75,7 @@
   "files": [
     "/bin",
     "/dist",
+    "/docs",
     "/oclif.manifest.json"
   ],
   "homepage": "https://shipthis.cc",
@@ -83,6 +86,7 @@
   "main": "dist/index.js",
   "type": "module",
   "exports": [
+    "./dist/utils/help.js",
     "./dist/commands/apple/apiKey/export.js",
     "./dist/commands/apple/apiKey/status.js",
     "./dist/commands/apple/apiKey/create.js",
@@ -121,15 +125,25 @@
     "bin": "shipthis",
     "dirname": "shipthis",
     "commands": "./dist/commands",
+    "helpClass": "./dist/utils/help",
     "plugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-plugins"
     ],
     "topicSeparator": " ",
     "topics": {
+      "internal": {
+        "description": "Internal commands"
+      },
       "apple": {
         "description": "Commands related to Apple Developer Portal"
       },
+      "apple:apiKey": {
+        "description": "Commands related to App Store Connect API Keys"
+      },
+      "apple:certificate": {
+        "description": "Commands related to App Store Certificates"
+      },
       "game": {
         "description": "Commands related to Game Management"
       },
@@ -158,9 +172,9 @@
     "lint": "eslint . --ext .ts",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
-    "prepack": "oclif manifest && oclif readme",
+    "prepack": "npm run readme && oclif manifest",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "readme": "bin/dev.js internal readme docs/ -d 2 --notDryRun # does not overwrite existing files"
   },
   "types": "dist/index.d.ts"
 }