Merge pull request #220 from code-collabo/qa-ing

QA-ing next fixes for new release

Author: Ifycode

dev/cleanup.js

@@ -0,0 +1,56 @@
+import { readdirSync, rmdirSync } from 'fs';
+import chalk from 'chalk';
+import { repo } from './developer';
+const { cwd, chdir } = process;
+
+// -------------------------------------------------------------------------------------------------
+// TODO 1 (after CLI upgrade): Configure cleanup to run using node-mongo command i.e. "node-mongo cleanup" not "npm run cleanup"
+// TODO 2 (if possible): (I don't think you will need this TODO when this is done using the "node-mongo cleanup" command - or it might need slight modification)
+            // update package.json cleanup script dynamically with the cleanup file path.
+            // This means you will have to get the cleanup file name/path dynamically too...
+// Or... (instead) should cleanup script be handled a pre-commit hook or pre-push hook or something? - We'll see...
+// -------------------------------------------------------------------------------------------------
+
+// cd into repo root
+chdir('../');
+
+// use repo root
+const rootDir = cwd();
+
+// return all files and folders in repo root i.e. original + node-mongo generated
+ const repoContent = readdirSync(rootDir, (err, filesAndFolders) => {
+    if (err) {
+      throw err;
+    }
+
+    return filesAndFolders;
+});
+
+const filterContentToGetTheOnesGeneratedByCLI = repoContent.reduce((acc, curr) => {
+  if (!repo.originalContentList.includes(curr)) {
+    acc.push(curr);
+  }
+  return acc;
+}, []);
+
+// delete folders generated by CLI
+if (filterContentToGetTheOnesGeneratedByCLI.length) {
+  try {
+    filterContentToGetTheOnesGeneratedByCLI.map(folder => {
+      console.log(chalk.green(`✔ ${folder} folder deleted successfully`));
+      return rmdirSync(folder, { recursive: true, force: true });
+    });
+    console.log('');
+  } catch (err) {
+    console.log(chalk.red(err));
+  }
+} else {
+  console.log(chalk.yellowBright('ℹ There are no folders to delete yet. Generate folder(s) using the "node-mongo" command, then run the cleanup script after you are done developing, and are ready to add and push your changes/fixes.\n'));
+}
+
+// ------------------------------------
+// TODO: Write another script at the end of this file
+// that updates this repoContent list back when done.
+// Is this TODO even needed? - We'll see. For now the
+// solution ending here works fine.
+// ------------------------------------

dev/developer.js

@@ -0,0 +1,41 @@
+import { basename, resolve, dirname } from 'path';
+// file to get and save if user still has the
+// Initial settings...
+
+const { chdir } = process;
+
+// Dynamically get current the name of this file you are in, and its parent folder
+const developerJsFileName = basename(__filename/*, extname(__filename)*/);
+const cleanupFolderPath = dirname(new URL(import.meta.url).pathname);
+
+// Change directory into the dynamically gotten parent folder, then extract folder name from path
+chdir(cleanupFolderPath);
+const cleanupFolderName = basename(resolve());
+
+// CLI repo's original content config object
+export const repo = {
+  hasOriginalContentOnly: true,
+  originalContentList: [
+    cleanupFolderName,
+    '.all-contributorsrc',
+    '.babelrc',
+    '.editorconfig',
+    '.eslintrc.json',
+    '.git',
+    '.github',
+    '.gitignore',
+    '.npmrc',
+    'LICENSE',
+    'README.md',
+    'bin',
+    'cleanup.js',
+    'node_modules',
+    'package-lock.json',
+    'package.json',
+    'spec',
+    'src',
+    'templates'
+  ],
+  developerJsFileName,
+  cleanupFolderName,
+}

package-lock.json

@@ -5,7 +5,8 @@
   "main": "src/cli.js",
   "bin": {
     "@code-collabo/node-mongo-cli": "bin/create-node-mongo-project",
-    "node-mongo": "bin/create-node-mongo-project"
+    "node-mongo": "bin/create-node-mongo-project",
+    "nmgo": "bin/create-node-mongo-project"
   },
   "scripts": {
     "prestart": "node -r esm src/customize/startMessage.js",
@@ -15,7 +16,8 @@
     "test": "npm-run-all --parallel test-message dev-test",
     "dev-test": "nodemon --exec babel-node spec/run.js",
     "CI-test": "babel-node spec/run.js",
-    "test-message": "node -r esm src/customize/testMessage"
+    "test-message": "node -r esm src/customize/testMessage",
+    "cleanup": "node -r esm dev/cleanup.js"
   },
   "repository": {
     "type": "git",

package.json

@@ -6,16 +6,25 @@ console.log(
 Usage:
 node-mongo <folder_name> <template>
 
+Usage (for shorter command alternative):
+nmgo <folder_name> <template>
+
 Command:
 node-mongo
 
+Command (shorter command alternative):
+nmgo 
+
 Arguments:
 <folder_name>   Replace this with your folder name
 <template>      Available templates: ts, esm and cjs
 
 Usage example:
 node-mongo test-folder ts
 
+Usage example (for shorter command alternative):
+nmgo test-folder ts
+
 The above example bootstraps the ts template i.e.
 the typescript template into a folder named test-folder.
 
@@ -48,9 +57,13 @@ folder name used already exists.
 export const notRecognised = () => {
 console.log(
 `
-Flag(s) not recognised. Use the help command below for more info:
+Flag(s) not recognised. Use any of the help command below for more info:
+
+Help command:
+node-mongo --help
 
-node-mongo --help`
+Help command (for shorter command alternative):
+nmgo --help`
 );
 }