refactor: refactoring the entire project and using typescript (#4)

Refactoring the entire project and using the typescript, as well as testing with jest for the api express template "#1", "2"
lucas-eduardo · Mar 29, 2020 · d406677 · d406677
1 parent fd50a20
commit d406677
Show file tree

Hide file tree

Showing 64 changed files with 2,962 additions and 2,509 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+bin/*
+template
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,26 +1,31 @@
 module.exports = {
   env: {
-    commonjs: true,
     es6: true,
     node: true,
   },
   extends: [
     'airbnb-base',
-    'prettier'
+    'prettier',
   ],
-  plugins: ['prettier'],
   globals: {
     Atomics: 'readonly',
     SharedArrayBuffer: 'readonly',
   },
+  parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaVersion: 2018,
+    sourceType: 'module',
   },
+  plugins: [
+    '@typescript-eslint',
+    'prettier',
+  ],
   rules: {
-    "prettier/prettier": "error",
+    'prettier/prettier': 'error',
     "class-methods-use-this": "off",
     "no-param-reassign": "off",
     "camelcase": "off",
-    "no-unused-vars": ["error", { "argsIgnorePattern": "next" }]
+    "import/no-unresolved": "off",
+    "no-unused-vars": "off"
   },
 };
diff --git a/.prettierrc b/.prettierrc
diff --git a/.vscode/launch.json b/.vscode/launch.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,8 +3,10 @@
     "node_modules": true,
     ".editorconfig": true,
     ".eslintrc.js": true,
-    ".prettierrc": true,
-    "yarn.lock": true
+    "yarn.lock": true,
+    ".eslintignore": true,
+    "commitlint.config.js": true,
+    "tsconfig.json": true
   },
   "breadcrumbs.enabled": true,
   "editor.fontFamily": "Fira Code, Consolas, monospace",
@@ -24,22 +26,11 @@
       "source.fixAll.eslint": true
     }
   },
-  "[javascriptreact]": {
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
-    }
-  },
   "[typescript]": {
     "editor.codeActionsOnSave": {
       "source.fixAll.eslint": true
     }
   },
-  "emmet.includeLanguages": {
-    "javascript": "javascriptreact"
-  },
-  "emmet.syntaxProfiles": {
-    "javascript": "jsx"
-  },
   "javascript.updateImportsOnFileMove.enabled": "never",
   "javascript.suggest.autoImports": false,
 }
diff --git a/bin/app/constants/instructions.constant.d.ts b/bin/app/constants/instructions.constant.d.ts
@@ -0,0 +1,6 @@
+declare const _default: {
+    project: string;
+    help: string;
+    version: string;
+};
+export default _default;
diff --git a/bin/app/constants/instructions.constant.js b/bin/app/constants/instructions.constant.js
@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    project: 'Pass the name of the project and generate the structure (-p is the abbreviation)',
+    help: 'Displays available commands (-h is the abbreviation)',
+    version: 'Displays the current version of the CLI (-v is the abbreviation)',
+};
diff --git a/bin/app/controllers/copyTemplate.controller.d.ts b/bin/app/controllers/copyTemplate.controller.d.ts
@@ -0,0 +1,5 @@
+declare class CopyTemplateController {
+    initialize(nameProject: string): Promise<boolean>;
+}
+declare const _default: CopyTemplateController;
+export default _default;
diff --git a/bin/app/controllers/copyTemplate.controller.js b/bin/app/controllers/copyTemplate.controller.js
@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs_extra_1 = require("fs-extra");
+var path_1 = require("path");
+var CopyTemplateController = (function () {
+    function CopyTemplateController() {
+    }
+    CopyTemplateController.prototype.initialize = function (nameProject) {
+        return __awaiter(this, void 0, void 0, function () {
+            var pathTemplate, destination, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        pathTemplate = path_1.resolve(__dirname, '..', '..', '..', 'template');
+                        destination = path_1.resolve(process.cwd(), nameProject);
+                        return [4, fs_extra_1.copy(pathTemplate, destination)];
+                    case 1:
+                        _a.sent();
+                        return [2, true];
+                    case 2:
+                        error_1 = _a.sent();
+                        throw new Error(error_1);
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    return CopyTemplateController;
+}());
+exports.default = new CopyTemplateController();
diff --git a/bin/app/controllers/verifyArgs.controller.d.ts b/bin/app/controllers/verifyArgs.controller.d.ts
@@ -0,0 +1,6 @@
+import { ParsedArgs } from 'minimist';
+declare class VerifyArgsController {
+    initialize(command: ParsedArgs): boolean;
+}
+declare const _default: VerifyArgsController;
+export default _default;
diff --git a/bin/app/controllers/verifyArgs.controller.js b/bin/app/controllers/verifyArgs.controller.js
@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var VerifyArgsController = (function () {
+    function VerifyArgsController() {
+    }
+    VerifyArgsController.prototype.initialize = function (command) {
+        if (command.project ||
+            command.p ||
+            command.help ||
+            command.h ||
+            command.version ||
+            command.v) {
+            return true;
+        }
+        return false;
+    };
+    return VerifyArgsController;
+}());
+exports.default = new VerifyArgsController();
diff --git a/bin/app/interfaces/commands.interfaces.d.ts b/bin/app/interfaces/commands.interfaces.d.ts
@@ -0,0 +1,8 @@
+interface ICommands {
+    project?: string;
+    p?: string;
+    help?: string;
+    h?: string;
+    version?: string;
+    v?: string;
+}
diff --git a/bin/app/interfaces/commands.interfaces.js b/bin/app/interfaces/commands.interfaces.js
@@ -0,0 +1 @@
+"use strict";
diff --git a/bin/app/interfaces/parametersList.interface.d.ts b/bin/app/interfaces/parametersList.interface.d.ts
@@ -0,0 +1,3 @@
+interface IParametersList {
+    [key: string]: string;
+}
diff --git a/bin/app/interfaces/parametersList.interface.js b/bin/app/interfaces/parametersList.interface.js
@@ -0,0 +1 @@
+"use strict";
diff --git a/bin/index.d.ts b/bin/index.d.ts
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};
diff --git a/bin/index.js b/bin/index.js
@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var minimist_1 = __importDefault(require("minimist"));
+var console_1 = require("console");
+var chalk_1 = __importDefault(require("chalk"));
+var clear_1 = __importDefault(require("clear"));
+var figlet_1 = __importDefault(require("figlet"));
+var clui_1 = require("clui");
+var figures_1 = __importDefault(require("figures"));
+var verifyArgs_controller_1 = __importDefault(require("./app/controllers/verifyArgs.controller"));
+var copyTemplate_controller_1 = __importDefault(require("./app/controllers/copyTemplate.controller"));
+var instructions_constant_1 = __importDefault(require("./app/constants/instructions.constant"));
+(function () { return __awaiter(void 0, void 0, void 0, function () {
+    var args, isCommandValid, nameProject_1, status_1, error_1, commands_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                args = minimist_1.default(process.argv.slice(2));
+                isCommandValid = verifyArgs_controller_1.default.initialize(args);
+                if (!isCommandValid) return [3, 7];
+                if (!(args.projet || args.p)) return [3, 5];
+                nameProject_1 = args.project || args.p;
+                status_1 = new clui_1.Spinner(chalk_1.default
+                    .hex('#F38E36')
+                    .bold("Your project " + nameProject_1 + " is being generated"));
+                status_1.start();
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, 3, , 4]);
+                return [4, copyTemplate_controller_1.default.initialize(nameProject_1)];
+            case 2:
+                _a.sent();
+                setTimeout(function () {
+                    status_1.stop();
+                    console_1.log(chalk_1.default.green(figures_1.default("\u2714\uFE0E The project " + nameProject_1 + " structure was successfully created")));
+                }, 1000);
+                return [3, 4];
+            case 3:
+                error_1 = _a.sent();
+                console_1.log(chalk_1.default.hex('#e02041').bold('An unexpected error occurred'));
+                process.exit();
+                return [3, 4];
+            case 4: return [3, 6];
+            case 5:
+                if (args.help || args.h) {
+                    clear_1.default();
+                    console_1.log(chalk_1.default.hex('#F38E36').bold(figlet_1.default.textSync('Tarvos Express', {
+                        font: 'Standard',
+                    })));
+                    console_1.log(chalk_1.default.green('Valid commands: \n'));
+                    commands_1 = instructions_constant_1.default;
+                    Object.keys(commands_1).forEach(function (key) {
+                        console_1.log(chalk_1.default(" " + chalk_1.default.hex('#F38E36').bold(key) + ": " + commands_1[key]));
+                    });
+                    console_1.log(chalk_1.default('\n Example: tarvos-express -p apitest \n'));
+                    process.exit();
+                }
+                _a.label = 6;
+            case 6:
+                if (args.version || args.v) {
+                    console_1.log(chalk_1.default.hex('#F38E36').bold("Version 1.0.2 \n"));
+                    console_1.log(chalk_1.default.hex('#F38E36').bold("Created by Lucas Eduardo"));
+                }
+                return [3, 8];
+            case 7:
+                console_1.log(chalk_1.default.hex('#e02041').bold('Enter a valid command'));
+                process.exit();
+                _a.label = 8;
+            case 8: return [2];
+        }
+    });
+}); })();
diff --git a/bin/package.json b/bin/package.json
@@ -0,0 +1,51 @@
+{
+    "name": "tarvos-express",
+    "version": "1.0.2",
+    "main": "./bin/index.js",
+    "repository": "[email protected]:lucas-eduardo/tarvos-express.git",
+    "author": "Lucas Eduardo <[email protected]>",
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc -p ."
+    },
+    "bin": {
+        "tarvos-express": "./bin/index.js"
+    },
+    "prettier": {
+        "singleQuote": true,
+        "tabWidth": 2,
+        "semi": true,
+        "trailingComma": "es5",
+        "bracketSpacing": true,
+        "arrowParens": "always"
+    },
+    "devDependencies": {
+        "@types/chalk": "^2.2.0",
+        "@types/clear": "^0.1.0",
+        "@types/clui": "^0.3.0",
+        "@types/figlet": "^1.2.0",
+        "@types/figures": "^3.0.1",
+        "@types/fs-extra": "^8.1.0",
+        "@types/minimist": "^1.2.0",
+        "@typescript-eslint/eslint-plugin": "^2.25.0",
+        "@typescript-eslint/parser": "^2.25.0",
+        "eslint": "^6.8.0",
+        "eslint-config-airbnb-base": "^14.1.0",
+        "eslint-config-prettier": "^6.10.1",
+        "eslint-plugin-import": "^2.20.1",
+        "eslint-plugin-prettier": "^3.1.2",
+        "prettier": "^2.0.2",
+        "ts-node": "^8.8.1",
+        "ts-node-dev": "^1.0.0-pre.44",
+        "typescript": "^3.8.3"
+    },
+    "dependencies": {
+        "chalk": "^3.0.0",
+        "clear": "^0.1.0",
+        "clui": "^0.3.6",
+        "figlet": "^1.3.0",
+        "figures": "^3.2.0",
+        "fs-extra": "^9.0.0",
+        "minimist": "^1.2.5"
+    }
+}