@contentful/app-scripts 1.5.6 → 1.7.0

package/bin/app-scripts

@@ -3,7 +3,7 @@
 const { program } = require('commander');
 const { version } = require('../package.json');
 
-const { createAppDefinition, upload, activate, cleanup, open } = require('../');
+const { createAppDefinition, upload, activate, cleanup, open, track } = require('../');
 
 async function runCommand(command, options) {
   const { ci } = program.opts();
@@ -64,6 +64,10 @@ async function runCommand(command, options) {
       await runCommand(cleanup, options);
     });
 
+  program.hook('preAction', (thisCommand) => {
+    track({ command: thisCommand.args[0], ci: thisCommand._optionValues.ci })
+  })
+
   await program.parseAsync(process.argv);
 })().catch((e) => {
   console.error(e);

package/lib/create-app-definition/build-app-definition-settings.js

@@ -22,12 +22,12 @@ NOTE: This will create an app definition in your Contentful organization.
       message: `Select where your app can be rendered:`,
       type: 'checkbox',
       choices: [
-        { name: 'App configuration screen (app-config) ', value: 'app-config' },
-        { name: 'Entry field (entry-field) ', value: 'entry-field' },
-        { name: 'Entry sidebar (entry-sidebar) ', value: 'entry-sidebar' },
-        { name: 'Entry editor (entry-editor)', value: 'entry-editor' },
-        { name: 'Page (page) ', value: 'page' },
-        { name: 'Home (home) ', value: 'home' },
+        { name: 'App configuration screen ', value: 'app-config' },
+        { name: 'Entry field', value: 'entry-field' },
+        { name: 'Entry sidebar', value: 'entry-sidebar' },
+        { name: 'Entry editor', value: 'entry-editor' },
+        { name: 'Page', value: 'page' },
+        { name: 'Home', value: 'home' },
       ],
     },
     {

package/lib/create-app-definition/create-app-definition.js

@@ -94,7 +94,7 @@ async function createAppDefinition(accessToken, appDefinitionSettings = { locati
     });
 
     console.log(`
-  ${chalk.cyan('Success!')} Created an app definition for ${chalk.bold(appName)} in ${chalk.bold(
+  ${chalk.greenBright('Success!')} Created an app definition for ${chalk.bold(appName)} in ${chalk.bold(
       selectedOrg.name
     )}.
 
@@ -102,11 +102,12 @@ async function createAppDefinition(accessToken, appDefinitionSettings = { locati
         ${chalk.underline(`https://app.contentful.com/deeplink?link=org`)}`)}
 
   ${chalk.bold('Next steps:')}
-    1. To develop, run ${chalk.cyan('`npm start`')} inside your app folder and open:
+    1. Run your app with ${chalk.cyan('`npm start`')} inside of your app folder.
+    2. Install this app definition to one of your spaces by opening:
         ${chalk.underline(
           `https://app.contentful.com/deeplink?link=apps&id=${createdAppDefinition.sys.id}`
         )}
-    2. To learn how to build your first Contentful app, visit:
+    3. Learn how to build your first Contentful app:
         ${chalk.underline(`https://ctfl.io/app-tutorial`)}
       `);
   } catch (err) {

package/lib/index.js

@@ -3,6 +3,7 @@ const upload = require('./upload');
 const activate = require('./activate');
 const cleanup = require('./clean-up');
 const open = require('./open');
+const track = require('../utils/analytics');
 
 module.exports = {
   createAppDefinition,
@@ -10,4 +11,5 @@ module.exports = {
   activate,
   cleanup,
   open,
+  track,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.5.6",
+  "version": "1.7.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -49,9 +49,10 @@
   },
   "dependencies": {
     "adm-zip": "0.5.9",
+    "analytics-node": "^6.2.0",
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
-    "commander": "9.4.1",
+    "commander": "9.5.0",
     "contentful-management": "10.26.0",
     "dotenv": "16.0.3",
     "ignore": "5.2.4",
@@ -60,5 +61,5 @@
     "open": "8.4.0",
     "ora": "5.4.1"
   },
-  "gitHead": "4845fec5b556319edc7a15bdda662a144f082190"
+  "gitHead": "dcb14be43822fc3c4afc168de83c7207adf64236"
 }

package/utils/analytics.js

@@ -0,0 +1,33 @@
+const Analytics = require('analytics-node');
+
+// Public write key scoped to data source
+const SEGMENT_WRITE_KEY = 'IzCq3j4dQlTAgLdMykRW9oBHQKUy1xMm';
+
+/**
+ *
+ * @param {object} properties tracking properties
+ * @param {string} properties.command triggered command e.g create-app-definition, upload, etc.
+ * @param {boolean} properties.ci value if --ci flag has been set
+ * @returns
+ */
+function track(properties) {
+  if (process.env.DISABLE_ANALYTICS) {
+    return;
+  }
+
+  const client = new Analytics(SEGMENT_WRITE_KEY);
+
+  try {
+    client.track({
+      event: 'app-cli-app-scripts',
+      properties,
+      anonymousId: Date.now(), // generate a random id
+      timestamp: new Date(),
+    });
+    // eslint-disable-next-line no-empty
+  } catch (e) {
+    // ignore any error, to not block the call
+  }
+}
+
+module.exports = track;