@dittowords/cli 2.1.2 → 2.4.0

package/README.md

@@ -16,7 +16,7 @@ npm install --global @dittowords/cli
 
 The installed binary is named `ditto-cli`. You can execute it directly in `node_modules/.bin/ditto-cli` or using [npx](https://www.npmjs.com/package/npx) (with or without installation) like `npx @dittowords/cli`.
 
-The first time you run the CLI, you'll be asked to provide an API key (found at [https://beta.dittowords.com/account/user](https://beta.dittowords.com/account/user) under **API Keys**):
+The first time you run the CLI, you'll be asked to provide an API key (found at [https://app.dittowords.com/account/user](https://app.dittowords.com/account/user) under **API Keys**):
 
 ```
 $ npx @dittowords/cli
@@ -41,8 +41,8 @@ Once you've successfully authenticated, you'll be asked to configure the CLI wit
 Looks like there are no Ditto projects selected for your current directory.
 
 ? Choose the project you'd like to sync text from:
-- Ditto Component Library https://beta.dittowords.com/components/all
-- NUX Onboarding Flow https://beta.dittowords.com/doc/609e9981c313f8018d0c346a
+- Ditto Component Library https://app.dittowords.com/components/all
+- NUX Onboarding Flow https://app.dittowords.com/doc/609e9981c313f8018d0c346a
 ...
 ```
 
@@ -50,6 +50,17 @@ After selecting a project, a configuration file will automatically be created at
 
 Once you've successfully authenticated and a config file has been created, you’re ready to start fetching copy! You can set up the CLI in multiple directories by running `ditto-cli` and choosing an initial project to sync from.
 
+## API Keys
+
+The CLI will not prompt for an API key if a value is provided in the environment variable `DITTO_API_KEY`.
+
+If the `DITTO_API_KEY` environment variable is not set, then the CLI will attempt to parse a token from a file at the
+path `~/.config/ditto`. If this file does not exist or does not contain a valid API key, then the CLI will prompt
+for one.
+
+We don't recommend editing the file manually; if you need to remove a saved API key and put another one in its place,
+it's better to fully delete the file and then re-run the CLI so that a new key is prompted for.
+
 ## Commands
 
 ### `pull`
@@ -92,9 +103,9 @@ If you run the CLI in a directory that does not contain a `ditto/` folder, the f
 
   ##### `projects`
 
-  A list of project names and ids to pull text from. R
+  A list of project names and ids to pull text from. 
 
-  equired if `components: true` is not specified.
+  Required if `components: true` is not specified.
 
   **Note**: the `name` property is used for display purposes when referencing a project in the CLI, but does not have to be an
   exact match with the project name in Ditto.

package/lib/config.js

@@ -57,7 +57,16 @@ function saveToken(file, host, token) {
   writeData(file, data);
 }
 
+function getTokenFromEnv() {
+  return process.env.DITTO_API_KEY;
+}
+
 function getToken(file, host) {
+  const tokenFromEnv = getTokenFromEnv();
+  if (tokenFromEnv) {
+    return tokenFromEnv;
+  }
+
   const data = readData(file);
   const hostEntry = data[justTheHost(host)];
   if (!hostEntry) return undefined;
@@ -154,6 +163,7 @@ module.exports = {
   saveToken,
   deleteToken,
   getToken,
+  getTokenFromEnv,
   save,
   parseSourceInformation,
 };

package/lib/consts.js

@@ -1,7 +1,8 @@
 const homedir = require("os").homedir();
-
 const path = require("path");
 
+const TEXT_DIR = process.env.DITTO_TEXT_DIR || "ditto"
+
 module.exports.API_HOST =
   process.env.DITTO_API_HOST || "https://api.dittowords.com";
 module.exports.CONFIG_FILE =
@@ -9,5 +10,5 @@ module.exports.CONFIG_FILE =
 module.exports.PROJECT_CONFIG_FILE = path.normalize(
   path.join("ditto", "config.yml")
 );
-module.exports.TEXT_FILE = path.normalize(path.join("ditto", "text.json"));
-module.exports.TEXT_DIR = path.normalize("ditto");
+module.exports.TEXT_DIR = TEXT_DIR
+module.exports.TEXT_FILE = path.normalize(path.join(TEXT_DIR, "text.json"));

package/lib/init/project.js

@@ -78,6 +78,7 @@ async function collectProject(token, initialize) {
 
   if (!(projects && projects.length)) {
     console.log("You're currently syncing all projects in your workspace.");
+    console.log(output.warnText("Not seeing a project that you were expecting? Verify that developer mode is enabled on that project. More info: https://www.dittowords.com/docs/ditto-developer-mode"));
     return null;
   }
 

package/lib/init/token.js

@@ -10,6 +10,10 @@ const output = require("../output");
 const config = require("../config");
 
 function needsToken(configFile, host = consts.API_HOST) {
+  if (config.getTokenFromEnv()) {
+    return false;
+  }
+
   const file = configFile || consts.CONFIG_FILE;
   if (!fs.existsSync(file)) return true;
   const configData = config.readData(file);
@@ -54,7 +58,7 @@ async function checkToken(token) {
 
 async function collectToken(message) {
   const blue = output.info;
-  const apiUrl = output.url("https://beta.dittowords.com/account/user");
+  const apiUrl = output.url("https://app.dittowords.com/account/user");
   const breadcrumbs = `${blue("User")}`;
   const tokenDescription =
     message ||

package/lib/utils/projectsToText.js

@@ -9,7 +9,7 @@ function projectsToText(projects) {
           "- " +
           output.info(name) +
           " " +
-          output.subtle("https://beta.dittowords.com/doc/" + id)),
+          output.subtle("https://app.dittowords.com/doc/" + id)),
       ""
     ) + "\n"
   );

package/lib/utils/promptForProject.js

@@ -7,7 +7,7 @@ function formatProjectChoice(project) {
     project.name +
     " " +
     output.subtle(
-      project.url || `https://beta.dittowords.com/doc/${project.id}`
+      project.url || `https://app.dittowords.com/doc/${project.id}`
     )
   );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittowords/cli",
-  "version": "2.1.2",
+  "version": "2.4.0",
   "description": "Command Line Interface for Ditto (dittowords.com).",
   "main": "bin/index.js",
   "scripts": {