Allow specifying project name using config command, closes #44

Author: yamalight

docs/Basics.md

@@ -12,8 +12,8 @@
 | deploy [path]          | Deploy specified path |
 | config                 | Generate or update project config for current path |
 | list                   | List currently deployed projects |
-| rm [project]           | Remove existing deployment or project |
-| log [project]          | Get logs for existing project |
+| rm [id]                | Remove existing deployment or project |
+| log [id]               | Get logs for existing deployment or project |
 | login                  | Login into Exoframe server |
 | endpoint [url]         | Gets or sets the endpoint of Exoframe server |
 | completion             | Generates bash completion script  |
@@ -27,16 +27,20 @@ If it doesn't exist during deployment, Exoframe will generate simple config file
 Config file has the following structure:
 ```js
 {
-  // project name
+  // deployment name
   // defaults to folder name
-  "name": "project-name",
+  "name": "deployment-name",
   // restart policy [optional]
   // see docker docs for more info
   // defaults to "on-failure:2"
   "restart": "on-failure:2",
   // domain to be assigned to project [optional]
   // no domain is assigned by default
+  // can be set to "false" to disable auto-assignment of domain
   "domain": "www.project.domain.com",
+  // project name [optional]
+  // by default assembled using deployment name and username
+  "project": "project-name",
   // object of key-values for env vars [optional]
   // no env vars are assigned by default
   "env": {

package.json

@@ -18,8 +18,8 @@
     "cli-table": "^0.3.1",
     "got": "^7.1.0",
     "ignore": "^3.3.0",
-    "inquirer": "^3.2.0",
-    "js-yaml": "^3.9.0",
+    "inquirer": "^3.2.1",
+    "js-yaml": "^3.9.1",
     "jsonwebtoken": "^7.4.1",
     "lodash": "^4.17.4",
     "ora": "^1.2.0",
@@ -29,7 +29,7 @@
   "devDependencies": {
     "coveralls": "^2.13.1",
     "nock": "^9.0.14",
-    "sinon": "^2.3.8",
-    "tap": "^10.3.2"
+    "sinon": "^2.4.1",
+    "tap": "^10.7.1"
   }
 }

src/commands/config.js

@@ -19,6 +19,7 @@ exports.handler = async () => {
   let defaultConfig = {
     name: folderName,
     domain: '',
+    project: '',
     restart: 'on-failure:2',
     env: undefined,
     hostname: '',
@@ -56,6 +57,13 @@ exports.handler = async () => {
     default: defaultConfig.domain,
     filter,
   });
+  prompts.push({
+    type: 'input',
+    name: 'project',
+    message: 'Project [optional]:',
+    default: defaultConfig.project,
+    filter,
+  });
   prompts.push({
     type: 'input',
     name: 'env',
@@ -80,12 +88,15 @@ exports.handler = async () => {
     choices: ['no', 'on-failure:2', 'always'],
   });
   // get values from user
-  const {name, domain, env, hostname, restart} = await inquirer.prompt(prompts);
+  const {name, domain, project, env, hostname, restart} = await inquirer.prompt(prompts);
   // init config object
   const config = {name, restart};
   if (domain && domain.length) {
     config.domain = domain;
   }
+  if (project && project.length) {
+    config.project = project;
+  }
   if (env && env.length) {
     config.env = env
       .split(',')

test/config.js

@@ -13,6 +13,7 @@ module.exports = () => {
   const configData = {
     name: 'test',
     domain: 'test.dev',
+    project: 'test-project',
     env: 'ENV=1, OTHER=2',
     hostname: 'host',
     restart: 'no',
@@ -44,6 +45,7 @@ module.exports = () => {
       t.equal(cfg.name, configData.name, 'Correct name');
       t.equal(cfg.restart, configData.restart, 'Correct restart policy');
       t.equal(cfg.domain, configData.domain, 'Correct domain');
+      t.equal(cfg.project, configData.project, 'Correct project');
       t.equal(cfg.hostname, configData.hostname, 'Correct hostname');
       t.equal(cfg.env.ENV, '1', 'Correct ENV var');
       t.equal(cfg.env.OTHER, '2', 'Correct OTHER var');

yarn.lock

@@ -130,8 +130,8 @@ babel-messages@^6.23.0:
     babel-runtime "^6.22.0"
 
 babel-runtime@^6.22.0:
-  version "6.23.0"
-  resolved "https://registry.yarnpkg.com/babel-runtime/-/babel-runtime-6.23.0.tgz#0a9489f144de70efb3ce4300accdb329e2fc543b"
+  version "6.25.0"
+  resolved "https://registry.yarnpkg.com/babel-runtime/-/babel-runtime-6.25.0.tgz#33b98eaa5d482bb01a8d1aa6b437ad2b01aec41c"
   dependencies:
     core-js "^2.4.0"
     regenerator-runtime "^0.10.0"
@@ -823,9 +823,9 @@ inherits@2, inherits@~2.0.3:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
 
-inquirer@^3.2.0:
-  version "3.2.0"
-  resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-3.2.0.tgz#45b44c2160c729d7578c54060b3eed94487bb42b"
+inquirer@^3.2.1:
+  version "3.2.1"
+  resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-3.2.1.tgz#06ceb0f540f45ca548c17d6840959878265fa175"
   dependencies:
     ansi-escapes "^2.0.0"
     chalk "^2.0.0"
@@ -1067,9 +1067,9 @@ [email protected]:
     argparse "^1.0.7"
     esprima "^2.6.0"
 
-js-yaml@^3.2.7, js-yaml@^3.3.1, js-yaml@^3.9.0:
-  version "3.9.0"
-  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.9.0.tgz#4ffbbf25c2ac963b8299dc74da7e3740de1c18ce"
+js-yaml@^3.2.7, js-yaml@^3.3.1, js-yaml@^3.9.1:
+  version "3.9.1"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.9.1.tgz#08775cebdfdd359209f0d2acd383c8f86a6904a0"
   dependencies:
     argparse "^1.0.7"
     esprima "^4.0.0"
@@ -1269,15 +1269,15 @@ micromatch@^2.3.11:
     parse-glob "^3.0.4"
     regex-cache "^0.4.2"
 
-mime-db@~1.27.0:
-  version "1.27.0"
-  resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.27.0.tgz#820f572296bbd20ec25ed55e5b5de869e5436eb1"
+mime-db@~1.29.0:
+  version "1.29.0"
+  resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.29.0.tgz#48d26d235589651704ac5916ca06001914266878"
 
 mime-types@^2.1.12, mime-types@~2.1.7:
-  version "2.1.15"
-  resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.15.tgz#a4ebf5064094569237b8cf70046776d09fc92aed"
+  version "2.1.16"
+  resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.16.tgz#2b858a52e5ecd516db897ac2be87487830698e23"
   dependencies:
-    mime-db "~1.27.0"
+    mime-db "~1.29.0"
 
 mimic-fn@^1.0.0:
   version "1.1.0"
@@ -1366,7 +1366,7 @@ number-is-nan@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d"
 
-nyc@^11.0.2-candidate.0:
+nyc@^11.1.0:
   version "11.1.0"
   resolved "https://registry.yarnpkg.com/nyc/-/nyc-11.1.0.tgz#d6b3c5e16892a25af63138ba484676aa8a22eda7"
   dependencies:
@@ -1768,8 +1768,8 @@ [email protected], samsam@^1.1.3:
   resolved "https://registry.yarnpkg.com/samsam/-/samsam-1.2.1.tgz#edd39093a3184370cb859243b2bdf255e7d8ea67"
 
 "semver@2 || 3 || 4 || 5", semver@^5.3.0:
-  version "5.3.0"
-  resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f"
+  version "5.4.1"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-5.4.1.tgz#e059c09d8571f0540823733433505d3a2f00b18e"
 
 set-blocking@^2.0.0:
   version "2.0.0"
@@ -1789,9 +1789,9 @@ signal-exit@^3.0.0, signal-exit@^3.0.1, signal-exit@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.2.tgz#b5fdc08f1287ea1178628e415e25132b73646c6d"
 
-sinon@^2.3.8:
-  version "2.3.8"
-  resolved "https://registry.yarnpkg.com/sinon/-/sinon-2.3.8.tgz#31de06fed8fba3a671e576dd96d0a5863796f25c"
+sinon@^2.4.1:
+  version "2.4.1"
+  resolved "https://registry.yarnpkg.com/sinon/-/sinon-2.4.1.tgz#021fd64b54cb77d9d2fb0d43cdedfae7629c3a36"
   dependencies:
     diff "^3.1.0"
     formatio "1.2.0"
@@ -1966,9 +1966,9 @@ tap-parser@^5.1.0, tap-parser@^5.3.1:
   optionalDependencies:
     readable-stream "^2"
 
-tap@^10.3.2:
-  version "10.7.0"
-  resolved "https://registry.yarnpkg.com/tap/-/tap-10.7.0.tgz#ecde1ebd2b86981f741ae089f1448c9f294ac548"
+tap@^10.7.1:
+  version "10.7.1"
+  resolved "https://registry.yarnpkg.com/tap/-/tap-10.7.1.tgz#f2d20f38a4f6b77717521ef852bf446a7fb79e4e"
   dependencies:
     bind-obj-methods "^1.0.0"
     bluebird "^3.3.1"
@@ -1981,7 +1981,7 @@ tap@^10.3.2:
     glob "^7.0.0"
     isexe "^2.0.0"
     js-yaml "^3.3.1"
-    nyc "^11.0.2-candidate.0"
+    nyc "^11.1.0"
     opener "^1.4.1"
     os-homedir "^1.0.2"
     own-or "^1.0.0"
@@ -2151,8 +2151,8 @@ which-module@^2.0.0:
   resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a"
 
 which@^1.2.4, which@^1.2.9:
-  version "1.2.14"
-  resolved "https://registry.yarnpkg.com/which/-/which-1.2.14.tgz#9a87c4378f03e827cecaf1acdf56c736c01c14e5"
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/which/-/which-1.3.0.tgz#ff04bdfc010ee547d780bec38e1ac1c2777d253a"
   dependencies:
     isexe "^2.0.0"