Add checker function to check if the cli is executed in valud Diffgram directory

Author: Vitalii Bulyzhyn

.gitignore

@@ -1,2 +1,3 @@
 /node_modules
-docker-compose-dev.yaml
+docker-compose-dev.yaml
+.env

bin/index.js

@@ -1,17 +1,19 @@
 #!/usr/bin/env node
 const yargs = require("yargs")
-const create_action = require('./utils/action')
-const create_dev_container = require('./utils/container')
+const createAction = require('./utils/action')
+const createDevContainer = require('./utils/container')
+const dirChecker = require('./tools/dirChecker')
 
-const usage = "\nDiffgram CLI:";
-const options = yargs
-    .usage(usage)
-    .command('action [NewActionName]', 'Creates a new Diffgram action', (yargs) => {
-        yargs.positional('NewActionName', {
-          type: 'string',
-          describe: 'Name of your new Diffgram action'
-        })
-      }, create_action)
-    .command('compose', 'Creates a docker-compose file for development environment', create_dev_container)
-    .help(true)
-    .argv;
+dirChecker()
+  
+yargs
+  .usage("\nDiffgram CLI:")
+  .command('action [NewActionName]', 'Creates a new Diffgram action', (yargs) => {
+      yargs.positional('NewActionName', {
+        type: 'string',
+        describe: 'Name of your new Diffgram action'
+      })
+    }, createAction)
+  .command('compose', 'Creates a docker-compose file for development environment', createDevContainer)
+  .help(true)
+  .argv;

bin/tools/dirChecker.js

@@ -0,0 +1,33 @@
+require('dotenv').config();
+const fs = require('fs');
+
+const dev = process.env.DEV
+
+const diffgramDirectoryItems = [
+    "install.py",
+    "default",
+    "walrus",
+    "local_dispatcher",
+    "shared",
+    "frontend"
+]
+
+function dirChecker() {
+    if (dev === 'true') {
+        console.log("Running in dev mode")
+        return
+    }
+
+    const currentPath = process.cwd();
+    filenames = fs.readdirSync(currentPath);
+
+    const validDirectory = diffgramDirectoryItems.every(item => filenames.includes(item))
+
+    if (!validDirectory) {
+        console.log("You are not in a valid Diffgram folder")
+        process.exit()
+    }
+}
+
+
+module.exports = dirChecker

bin/utils/container.js

@@ -45,8 +45,8 @@ const prompt = new Prompt({
     choices: [ ...Object.keys(templateMap) ]
   });
 
-function create_dev_container () {
-    const file_to_create = `${process.cwd()}/docker-compose-dev.yaml`
+function createDevContainer () {
+    const fileToCreate = `${process.cwd()}/docker-compose-dev.yaml`
 
     const baseComposeFileBuffer = readModuleFile("../snippets/docker-compose/base.txt");
     const baseTemplate = baseComposeFileBuffer.toString()
@@ -68,9 +68,9 @@ function create_dev_container () {
                     servicesTemplate += '\n'
                 })
             const composeReady = baseTemplate.replace(replacer, servicesTemplate)
-            fs.writeFileSync(file_to_create, composeReady);
+            fs.writeFileSync(fileToCreate, composeReady);
             console.log('Now you can run your dev container with "docker-compose -f docker-compose-dev.yaml up"')
         })
 }
 
-module.exports = create_dev_container;
+module.exports = createDevContainer;

package-lock.json

@@ -17,6 +17,7 @@
   "author": "Diffgram",
   "license": "ISC",
   "dependencies": {
+    "dotenv": "^16.0.1",
     "prompt-checkbox": "^2.2.0",
     "yargs": "^17.5.1"
   }