Fastify Generator initial commit

Author: mikr13

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sean Maxwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,111 @@
+<img alt='overnightjs' src='https://github.com/seanpmaxwell/express-generator-typescript/raw/master/express-typescript.png' border='0'>
+
+[Express](https://www.npmjs.com/package/express) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.
+
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/v/express-generator-typescript.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/l/express-generator-typescript.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/dm/express-generator-typescript.svg" alt="NPM Downloads" /></a>
+
+
+## What is it?
+
+Creates a new express application similar to the _express-generator_ module. Except this new
+application is configured to use TypeScript instead of plain JavaScript. 
+
+
+
+## Why express-generator-typescript?
+
+NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of
+type safety. TypeScript solves this issue and (along with its linter file) can even make your code
+more robust than some other static languages like Java.
+
+There are some other tools out there to generate express apps with TypeScript such as 
+_express-generator-ts_, but these either haven't been updated in a while or install a lot of junk 
+in your project (such as an ORM). 
+
+Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is 
+only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you 
+need to run for development (while restarting on changes), building, testing, and running for production 
+are packaged with this library. 
+
+In addition, relative paths are also setup, so you don't have to go through the trouble of installing
+and configuring _tsconfig-paths_ and _module-alias_. Just make sure to update `paths` in _tsconfig.json_
+and `_moduleAliases` in _package.json_ if you want to add/edit the relative paths.
+
+
+## Sample-project
+
+When you run _express-generator-typescript_, it sets up a very simple application with routes for
+adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done
+with express.
+
+If you want a fully-secure application, you can pass the `--with-auth` option and you will have an
+application which requires you to logon before calling APIs on user objects. The app is 
+configured with production quality client-side security and uses signed-cookies and jsonwebtokens 
+to store user-session data. If you're new to web-development and still learning about securing websites,
+I highly encourage to use this option.
+
+
+## Installation
+
+```sh
+$ Just use 'npx'
+  Or
+$ npm install -g express-generator-typescript
+```
+
+
+## Quick Start
+
+The quickest way to get started is use npx and pass in the name of the project you want to create.
+If you don't specify a project name, the default _express-gen-ts_ will be used instead.
+
+Create the app:
+
+```bash
+$ npx express-generator-typescript "project name (default is express-gen-ts)"
+OR
+$ npx express-generator-typescript --with-auth "project name (default is express-gen-ts)"
+```
+
+Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
+
+```bash
+$ cd "project name" && npm run start:dev
+```
+
+
+## Available commands for the server.
+
+- Run the server in development mode: `npm run start:dev`.
+- Run all unit-tests: `npm test`.
+- Run a single unit-test: `npm test -- --testFile="name of test file" (i.e. --testFile=Users)`.
+- Check for linting errors: `npm run lint`.
+- Build the project for production: `npm run build`.
+- Run the production build: `npm start`.
+- Run production build with a different env file `npm start -- --env="name of env file" (default is production)`.
+
+
+## Debugging
+During development, _express-generator-typescript_ uses `nodemon` to restart the server when changes
+are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations.
+This is located under `nodemonConfig:` in `package.json` for the server and `./spec/nodemon.json` for
+unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
+
+
+## Note for windows users
+
+If you use the `--with-auth` option and are on Windows, the `bcrypt` module tends to be fussy. To
+use this module on Windows you need to make sure you have the node Windows build tools installed.
+I don't want to post instructions because they might change frequently. I would search the Microsoft
+docs on how to setup Node for Windows. To be able to debug in VSCODE on windows I also had to install
+the `node-gyp` module globally as well.
+
+Happy web-deving :)
+
+
+
+## License
+
+[MIT](LICENSE)

cli.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fastifyGenTs = require('./fastify-generator');
+const { start, get } = require('prompt');
+
+const options = [
+    {
+        description: "Fastify Plugin Structure with Mongoose and Swagger",
+        defaultName: "fastify-plugin-mongoose-swagger",
+        templateName: "plugin-structure-mongoose",
+        dependencies: "dotenv fastify fastify-cors fastify-oas mongoose",
+        devDependencies: "@types/cors @types/jest @types/node jest nodemon ts-jest ts-node typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint"
+    }, {
+        description: "Fastify Plugin Structure with TypeORM and Swagger",
+        defaultName: "fastify-plugin-typeorm-swagger",
+        templateName: "plugin-structure-typeorm",
+        dependencies: "dotenv fastify fastify-cors fastify-oas fastify-plugin mongodb reflect-metadata typeorm",
+        devDependencies: "@types/cors @types/jest @types/node jest nodemon ts-jest ts-node typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint"
+    }, {
+        description: "Fastify with Mongoose and Express Directory Structure",
+        defaultName: "fastify-express-mongoose",
+        templateName: "express-structure-mongoose",
+        dependencies: "dotenv fastify fastify-cors mongoose",
+        devDependencies: "@types/cors @types/jest @types/node jest nodemon ts-jest ts-node typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint"
+    }, {
+        description: "Fastify with TypeORM and Express Directory Structure",
+        defaultName: "fastify-express-typeorm",
+        templateName: "express-structure-typeorm",
+        dependencies: "dotenv fastify fastify-cors fastify-plugin mongodb reflect-metadata typeorm",
+        devDependencies: "@types/cors @types/jest @types/node jest nodemon ts-jest ts-node typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint"
+    },
+];
+const schema = {
+    properties: {
+        option: {
+            description: 'Select a options for the type of project',
+            pattern: /^[1-4]{0,1}$/,
+            message: 'Specify a number in range of 4 corresponding options',
+            required: true
+        },
+        path: {
+            description: '[OPTIONAL] Specify directory where create the files, if no path is provided, current directory will be used',
+            message: '[OPTIONAL] Specify directory where create the files, if no path is provided, current directory will be used',
+            default: './',
+            required: false
+        },
+        projectName: {
+            description: '[OPTIONAL] Specify project name',
+            pattern: /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/,
+            message: '[OPTIONAL] Specify project name',
+            required: false
+        }
+    }
+};
+
+
+const getDest = (option, destFolder, projectName) => {
+    return `${path.join(process.cwd(), destFolder)}/${projectName || option.defaultName}`;
+}
+
+
+const initiate = async (option, path, projectName) => {
+    try {
+        const destination = getDest(option, path, projectName);
+        console.log(`Choose the number for corresponding option.\n${destination}`);
+        await fastifyGenTs(option, destination);
+        console.log('Project setup complete!');
+    } catch (error) {
+        console.error(error);
+    }
+};
+
+
+console.log('\x1b[33m\x1b[40m%s\x1b[0m', 'Setting up new Fastify TypeScript project...\n');
+console.log('\x1b[33m\x1b[40m%s\x1b[0m', `Available options:\n`);
+options.map((el, index) => console.log(`${index + 1}. ${el.description} -> ${el.templateName}\n`));
+
+
+start();
+
+
+get(schema, (error, argv) => {
+    if (error) {
+        console.error(`Prompt error: ${error}`);
+        throw error;
+    } else {
+        console.log(`Option Chosen:\n${options[argv.option].templateName}\nDirectory Chosen/Default:\n${argv.path}\nProject Name:\n${argv.projectName || options[argv.option].defaultName}`);
+        console.log(`Starting Project creation...`);
+        initiate(options[argv.option], argv.path, argv.projectName);
+    }
+});

fastify-generator.js

@@ -0,0 +1,59 @@
+const path = require('path');
+const { execSync } = require('child_process');
+const ncp = require('ncp').ncp;
+const { writeFile, mkdir } = require('fs/promises');
+const { existsSync } = require('fs');
+
+
+const copyProjectFiles = (config, destination) => {
+    const prjFolder = `./templates/${config.templateName}`;
+    const source = path.join(__dirname, prjFolder);
+    return new Promise((resolve, reject) => {
+        ncp.limit = 16;
+        ncp(source, destination, { filter: /^((?!node_modules|coverage|package-lock.json).)*$/ }, (err) => {
+            if (err) {
+                reject(err);
+            }
+            resolve();
+        });
+    })
+}
+
+
+const updatePackageJson = async (destination) => {
+    try {
+        const pathName = `${destination}/package.json`
+        let data = require(pathName);
+        data.name = path.basename(destination);
+        data = JSON.stringify(data, null, 2);
+        await writeFile(pathName, data);
+    } catch (err) {
+        throw err;
+    }
+}
+
+
+const downloadNodeModules = (config, destination) => {
+    const options = {cwd: destination};
+    console.log('\x1b[31m\x1b[40m%s\x1b[0m', 'Installing dependencies...\n');
+    execSync('npm i -s ' + config.dependencies, options);
+    execSync('npm i -D ' + config.devDependencies, options);
+    console.log('\x1b[32m\x1b[40m%s\x1b[0m', 'Dependencies installation done...\n');
+}
+
+
+const fastifyGenTs = async (config, destination) => {
+    try {
+        if (!existsSync(destination)) {
+            await mkdir(destination, { recursive: true });
+        }
+        await copyProjectFiles(config, destination);
+        await updatePackageJson(destination);
+        downloadNodeModules(config, destination);
+    } catch (err) {
+        console.error(err);
+    }
+}
+
+
+module.exports = fastifyGenTs;