Merge pull request #34 from BytecodeOpenSource/cli

Luciano Nooijen · web-flow · commit 95eb487fee7a · 2018-12-07T13:17:59.000+01:00
Added basic CLI
diff --git a/.travis.yml b/.travis.yml
@@ -30,7 +30,7 @@ script:
   - yarn run test
   - yarn run coverage
   - codecov
-  - yarn run build
+  # - yarn run build -- Not needed yet
 
 cache:
   yarn: true
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ const nodeBlog = require('nodejs-blog');
 const { authors, auth, users, categories, articles } = require('nodejs-blog');
 ```
 
-to start using the package, create a new instance of the NodeBlog class
+to start using the package, create a new blog object:
 
 ```js
 const client = 'YOUR_DB_CLIENT'; // for more info, see https://knexjs.org/
@@ -99,11 +99,11 @@ articles.delete(blog, id)
 
 We recommend creating a single file that will create the NodeBlog instance, and `export` this instance, and `import` in all other files where you want to use NodeJS Blog.
 
-For security reasons we recommend using environment variables for loading the configuration. This is also in compliance with the [12 factor app Config guidelines](https://12factor.net/config)
+For security reasons we recommend using environment variables for loading the configuration. This is also in compliance with the [12 factor app Config guidelines](https://12factor.net/config).
 
 Note: NodeJS blog was made to be used with PostgreSQL, but it should(/could) also be compatible with other databases, as it uses [KnexJS](https://knexjs.org) under the hood.
 
-*A demo application is currently in development*
+*A demo application and a standalone CLI are currently in development*
 
 ## Running the API as a standalone service (still in development, might not work 100%)
 
@@ -124,6 +124,7 @@ For development, the following commands are available:
 | Command | Functionality |
 | - | - |
 | `yarn run dev` | Runs a `nodemon` server for the `server/server.js` file, and exposing the standalone service to your `localhost` |
+| `yarn run cli` | Runs the CLI tool created for simple CRUD operations without accessing the database directly |
 | `yarn run lint` | Runs ESLint, for PRs this should always pass |
 | `yarn run test` | Runs Jest once, for PRs this should always pass. Your database must be available as it is used to run tests on (beware: all existing data will be wiped, we recommend using a separate test-database, this can be set in the `.env` file) |
 | `yarn run test:watch` | Same as `yarn run test`, but it Jest watches for changes |
@@ -132,26 +133,6 @@ For development, the following commands are available:
 | `yarn run reinstall` | Deletes the `node_modules/` folder and reinstalls everything, if you get some stange dependency errors, run this command |
 | `yarn run clean` | Deletes folders `build/`, `dist/` and `coverage/` |
 
-### Folder structure
-
-```md
-.
-├── controllers         Controllers for the module based API
-├── database            All database related files
-│   ├── migrations
-│   └── seeds
-├── helpers             Helper files, for example: logger, database instance
-├── server
-│   ├── controllers
-│   ├── middleware
-│   │   └── modules
-│   └── routes
-├── src                 Source directory for the API exposed by the module
-└── tests               All tests written
-    ├── config
-    └── database
-```
-
 ### Node Environments
 
 The following NodeJS Environments are integrated:
diff --git a/cli/add-post.ts b/cli/add-post.ts
@@ -0,0 +1,43 @@
+/* tslint:disable: no-console */
+
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import articles = require('../controllers/articles');
+
+const { addArticle, getArticle } = articles;
+
+const prompt = inquirer.createPromptModule();
+
+const addPostQuestions = [
+    { type: 'input', name: 'title', message: 'What is the post title' },
+    { type: 'input', name: 'subtitle', message: 'And the post subtitle' },
+    { type: 'input', name: 'slug', message: 'And the post slug' },
+    { type: 'input', name: 'author', message: 'What is the author id' },
+    { type: 'input', name: 'category', message: 'What is the category id' },
+    { type: 'input', name: 'summary', message: 'Please give a short summary' },
+    { type: 'input', name: 'image_url', message: 'What is the image url' },
+    { type: 'input', name: 'html_content', message: 'Minified HTML string' },
+    { type: 'input', name: 'related_articles',
+        message: 'Related articles, comma seperated, no spaces, ("1,2,3")' },
+];
+
+const createPostDataObject = input => {
+    const relatedArticleString = input.related_articles;
+    const relatedArticlesArray = relatedArticleString.split(',');
+    const postData = { ...input, related_articles: relatedArticlesArray };
+    return postData;
+};
+
+const addPost = async knex => {
+    const postDataInputRaw = await prompt(addPostQuestions);
+    const postDataInput = createPostDataObject(postDataInputRaw);
+    try {
+        const addedArticle = await addArticle(knex, postDataInput);
+        console.log(`${chalk.green('Success')}: article added!`);
+    } catch (err) {
+        console.log(`${chalk.red('Error')}: the CLI failed you :(`);
+        console.log(err);
+    }
+};
+
+export default addPost;
diff --git a/cli/index.ts b/cli/index.ts
@@ -0,0 +1,72 @@
+/* tslint:disable: no-console import-name */
+
+/**
+ * TODO: Test this and split up
+ * We know the rules. Don't write production code if there are no failing tests
+ * for the code you're about to write. Any code you write that has no unit tests
+ * should be seen as legacy code. Yes, we get it. This CLI tool should indeed be
+ * tested, but due to time concerns we chose to set this up quick and easy.
+ * Besides, we would like to split this up into a separate module soon.
+ */
+
+import chalk from 'chalk';
+import figlet from 'figlet';
+import inquirer from 'inquirer';
+import knexGenerator from 'knex';
+
+import generateKnexfile = require('../database/generate-knexfile');
+import addPost from './add-post';
+
+const prompt = inquirer.createPromptModule();
+const choices = ['Add post'];
+const question = {
+    choices,
+    name: 'action',
+    type: 'list',
+    message: 'Please select the action you wish to perform',
+};
+
+const intro = () => {
+    console.clear();
+    console.log(
+        chalk.yellow(
+            figlet.textSync('NodeJS Blog', { horizontalLayout: 'full' })));
+};
+
+const promptHandler = async knex => {
+    const answer = await prompt([question]) as any; // Hack to avoid error...
+    if (answer.action === 'Add post') {
+        addPost(knex);
+    }
+};
+
+const createKnexInstance = config => {
+    const knexfile = generateKnexfile(config);
+    const knex = knexGenerator(knexfile);
+    return knex;
+};
+
+const cli = async (
+    client = process.env.DB_CLIENT_TEST,
+    host = process.env.DB_HOST_TEST,
+    user = process.env.DB_USER_TEST,
+    database = process.env.DB_NAME_TEST,
+    password = process.env.DB_PASS_TEST,
+    debug = process.env.KNEX_DEBUG === 'true',
+) => {
+    intro();
+
+    try {
+        // TODO: Load the config using a promt
+        const config = { client, host, user, database, password, debug };
+        const knex = createKnexInstance(config);
+        await promptHandler(knex);
+    } catch (err) {
+        console.log(`${chalk.red('Error')}: the CLI failed you :(`);
+        console.log(err);
+    }
+};
+
+// Run CLI
+require('dotenv').config(); // Load .env file
+cli();
diff --git a/package.json b/package.json
@@ -34,8 +34,9 @@
   },
   "scripts": {
     "dev": "nodemon",
+    "cli": "ts-node cli/index.ts",
     "start": "ts-node server/server.ts",
-    "build": "tsc",
+    "build": "yarn run clean && tsc",
     "lint": "yarn run lint:js && yarn run lint:ts",
     "lint:js": "eslint --ext .js,.jsx .",
     "lint:ts": "tslint --project .",
@@ -65,10 +66,13 @@
   "devDependencies": {
     "@types/eslint": "^4.16.4",
     "@types/express": "^4.16.0",
+    "@types/figlet": "^1.2.0",
+    "@types/inquirer": "^0.0.43",
     "@types/jest": "^23.3.9",
     "@types/knex": "^0.15.1",
     "@types/node": "^10.12.9",
     "babel-eslint": "^10.0.1",
+    "clui": "^0.3.6",
     "eslint": "^4.19.1",
     "eslint-config-airbnb": "^16.1.0",
     "eslint-plugin-import": "^2.12.0",
@@ -78,7 +82,10 @@
     "eslint-plugin-prettier": "^3.0.0",
     "eslint-plugin-react": "^7.8.2",
     "eslint-plugin-security": "^1.4.0",
+    "figlet": "^1.2.1",
+    "inquirer": "^6.2.1",
     "jest": "^23.6.0",
+    "minimist": "^1.2.0",
     "nodemon": "^1.18.6",
     "prettier": "^1.15.2",
     "prettier-eslint": "^8.8.2",
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
     /* Basic Options */
-    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+    "target": "es2015",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
     "lib": ["es2015"],
-    "module": "amd",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
     "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     "sourceMap": true,                     /* Generates corresponding '.map' file. */
diff --git a/yarn.lock b/yarn.lock
