typescript-express-starter 10.2.1 → 11.0.0

package/lib/sequelize/swagger.yaml

@@ -1,123 +0,0 @@
-tags:
-- name: users
-  description: users API
-
-paths:
-# [GET] users
-  /users:
-    get:
-      tags:
-      - users
-      summary: Find All Users
-      responses:
-        200:
-          description: 'OK'
-        500:
-          description: 'Server Error'
-
-# [POST] users
-    post:
-      tags:
-      - users
-      summary: Add User
-      parameters:
-      - name: body
-        in: body
-        description: user Data
-        required: true
-        schema:
-          $ref: '#/definitions/users'
-      responses:
-        201:
-          description: 'Created'
-        400:
-          description: 'Bad Request'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [GET] users/id
-  /users/{id}:
-    get:
-      tags:
-      - users
-      summary: Find User By Id
-      parameters:
-      - name: id
-        in: path
-        description: User Id
-        required: true
-        type: integer
-      responses:
-        200:
-          description: 'OK'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [PUT] users/id
-    put:
-      tags:
-      - users
-      summary: Update User By Id
-      parameters:
-      - name: id
-        in: path
-        description: user Id
-        required: true
-        type: integer
-      - name: body
-        in: body
-        description: user Data
-        required: true
-        schema:
-          $ref: '#/definitions/users'
-      responses:
-        200:
-          description: 'OK'
-        400:
-          description: 'Bad Request'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# [DELETE] users/id
-    delete:
-      tags:
-      - users
-      summary: Delete User By Id
-      parameters:
-      - name: id
-        in: path
-        description: user Id
-        required: true
-        type: integer
-      responses:
-        200:
-          description: 'OK'
-        409:
-          description: 'Conflict'
-        500:
-          description: 'Server Error'
-
-# definitions
-definitions:
-  users:
-    type: object
-    required:
-        - email
-        - password
-    properties:
-      email:
-        type: string
-        description: user Email
-      password:
-        type: string
-        description: user Password
-
-schemes:
- - https
- - http

package/lib/sequelize/tsconfig.json

@@ -1,40 +0,0 @@
-{
-  "compileOnSave": false,
-  "compilerOptions": {
-    "target": "es2017",
-    "lib": ["es2017", "esnext.asynciterable"],
-    "typeRoots": ["node_modules/@types"],
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
-    "module": "commonjs",
-    "pretty": true,
-    "sourceMap": true,
-    "declaration": true,
-    "outDir": "dist",
-    "allowJs": true,
-    "noEmit": false,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "importHelpers": true,
-    "baseUrl": "src",
-    "paths": {
-      "@/*": ["*"],
-      "@config": ["config"],
-      "@controllers/*": ["controllers/*"],
-      "@database": ["database"],
-      "@dtos/*": ["dtos/*"],
-      "@exceptions/*": ["exceptions/*"],
-      "@interfaces/*": ["interfaces/*"],
-      "@middlewares/*": ["middlewares/*"],
-      "@models/*": ["models/*"],
-      "@routes/*": ["routes/*"],
-      "@services/*": ["services/*"],
-      "@utils/*": ["utils/*"]
-    }
-  },
-  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
-  "exclude": ["node_modules", "src/http", "src/logs"]
-}

package/lib/starter.js

@@ -1,262 +0,0 @@
-/*****************************************************************
- * Create TypeScript Express Starter
- * 2019.12.18 ~ 🎮
- * Made By AGUMON 🦖
- * https://github.com/ljlm0402/typescript-express-starter
- *****************************************************************/
-
-const chalk = require("chalk");
-const { exec } = require("child_process");
-const editJsonFile = require("edit-json-file");
-const { createWriteStream, readdir } = require("fs");
-const { writeFile } = require("gitignore");
-const inquirer = require("inquirer");
-const { ncp } = require("ncp");
-const ora = require("ora");
-const path = require("path");
-const { promisify } = require("util");
-
-const readDir = promisify(readdir);
-const asyncExec = promisify(exec);
-const writeGitignore = promisify(writeFile);
-
-/**
- * @method createProject
- * @description Create a project
- */
-const createProject = async (projectName) => {
-  let spinner;
-
-  try {
-    const template = await chooseTemplates();
-    // const isUpdated = await dependenciesUpdates();
-    // const isDeduped = await dependenciesDeduped();
-
-    console.log("[ 1 / 3 ] 🔍  copying project...");
-    console.log("[ 2 / 3 ] 🚚  fetching node_modules...");
-
-    await copyProjectFiles(projectName, template);
-    await updatePackageJson(projectName);
-
-    console.log("[ 3 / 3 ] 🔗  linking node_modules...");
-    console.log(
-      "\u001b[2m──────────────────────────────────────────\u001b[22m"
-    );
-
-    spinner = ora();
-    spinner.start();
-
-    await installNodeModules(projectName, spinner);
-    // isUpdated && (await updateNodeModules(projectName, spinner));
-    // isDeduped && (await dedupeNodeModules(projectName, spinner));
-    await postInstallScripts(projectName, template, spinner);
-
-    await createGitignore(projectName, spinner);
-    await initGit(projectName);
-
-    await succeedConsole(template, spinner);
-  } catch (error) {
-    await failConsole(error, spinner);
-  }
-};
-
-/**
- * @method getDirectories
- * @description Get the templates directory.
- */
-const getTemplateDir = async () => {
-  const contents = await readDir(__dirname, { withFileTypes: true });
-  const directories = contents
-    .filter((p) => p.isDirectory())
-    .map((p) => p.name);
-
-  return directories;
-};
-
-/**
- * @method chooseTemplates
- * @description Choose a template.
- */
-const chooseTemplates = async () => {
-  const directories = await getTemplateDir();
-  const { chooseTemplates } = await inquirer.prompt([
-    {
-      type: "list",
-      name: "chooseTemplates",
-      message: "Select a template",
-      choices: [...directories, new inquirer.Separator()],
-    },
-  ]);
-
-  return chooseTemplates;
-};
-
-/**
- * @method dependenciesUpdates
- * @description npm dependencies updated.
- */
-const dependenciesUpdates = async () => {
-  const { isUpdated } = await inquirer.prompt([
-    {
-      type: "confirm",
-      name: "isUpdated",
-      message: "Update the package dependencies to their latest versions ?",
-    },
-  ]);
-
-  if (isUpdated) {
-    const { isUpdatedReconfirm } = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "isUpdatedReconfirm",
-        message:
-          "The updated dependencies may contain breaking changes. Continue to update the dependencies anyway ?",
-      },
-    ]);
-
-    return isUpdatedReconfirm;
-  }
-
-  return false;
-};
-
-/**
- * @method dependenciesDeduped
- * @description npm duplicate dependencies removed.
- */
-const dependenciesDeduped = async () => {
-  const { isDeduped } = await inquirer.prompt([
-    {
-      type: "confirm",
-      name: "isDeduped",
-      message: "Deduplicate the package dependency tree (recommended) ?",
-    },
-  ]);
-
-  return isDeduped;
-};
-
-/**
- * @method copyProjectFiles
- * @description Duplicate the template.
- */
-const copyProjectFiles = async (destination, directory) => {
-  return new Promise((resolve, reject) => {
-    const source = path.join(__dirname, `./${directory}`);
-    const options = {
-      clobber: true,
-      stopOnErr: true,
-    };
-
-    ncp.limit = 16;
-    ncp(source, destination, options, function (err) {
-      if (err) reject(err);
-      resolve();
-    });
-  });
-};
-
-/**
- * @method updatePackageJson
- * @description Edit package.json.
- */
-const updatePackageJson = async (destination) => {
-  const file = editJsonFile(`${destination}/package.json`, { autosave: true });
-
-  file.set("name", path.basename(destination));
-};
-
-/**
- * @method installNodeModules
- * @description Install node modules.
- */
-const installNodeModules = async (destination, spinner) => {
-  spinner.text = "Install node_modules...\n";
-  await asyncExec("npm install --legacy-peer-deps", { cwd: destination });
-};
-
-/**
- * @method updateNodeModules
- * @description Update node modules.
- */
-const updateNodeModules = async (destination, spinner) => {
-  spinner.text = "Update node_modules...\n";
-  await asyncExec("npm update --legacy-peer-deps", { cwd: destination });
-};
-
-/**
- * @method dedupeNodeModules
- * @description Dedupe node modules.
- */
-const dedupeNodeModules = async (destination, spinner) => {
-  spinner.text = "Dedupe node_modules...\n";
-  await asyncExec("npm dedupe --legacy-peer-deps", { cwd: destination });
-};
-
-/**
- * @method postInstallScripts
- * @description After installation, configure the settings according to the template.
- */
-const postInstallScripts = async (destination, template, spinner) => {
-  switch (template) {
-    case "prisma":
-      {
-        spinner.text = "Run prisma generate...";
-        await asyncExec("npm run prisma:generate", { cwd: destination });
-      }
-      break;
-  }
-};
-
-/**
- * @method createGitignore
- * @description Create a .gitignore.
- */
-const createGitignore = async (destination, spinner) => {
-  spinner.text = "Create .gitignore...";
-
-  const file = createWriteStream(path.join(destination, ".gitignore"), {
-    flags: "a",
-  });
-
-  return writeGitignore({
-    type: "Node",
-    file: file,
-  });
-};
-
-/**
- * @method initGit
- * @description Initialize git settings.
- */
-const initGit = async (destination) => {
-  await asyncExec("git init", { cwd: destination });
-};
-
-/**
- * @method succeedConsole
- * @description When the project is successful, the console is displayed.
- */
-const succeedConsole = async (template, spinner) => {
-  spinner.succeed(chalk`{green Complete setup project}`);
-
-  const msg =
-    {
-      prisma:
-        "⛰ Prisma installed. Check your .env settings and then run `npm run prisma:migrate`",
-      knex: "⛰ Knex installed. Check your .env settings and then run `npm run migrate`",
-    }[template] || "";
-
-  msg && console.log(msg);
-};
-
-/**
- * @method failConsole
- * @description When the project is fail, the console is displayed.
- */
-const failConsole = async (error, spinner) => {
-  spinner.fail(chalk`{red Please leave this error as an issue}`);
-  console.error(error);
-};
-
-module.exports = createProject;

package/lib/typegoose/.dockerignore

@@ -1,18 +0,0 @@
-# compiled output
-.vscode
-/node_modules
-
-# code formatter
-.eslintrc
-.eslintignore
-.editorconfig
-.huskyrc
-.lintstagedrc.json
-.prettierrc
-
-# test
-jest.config.js
-
-# docker
-Dockerfile
-docker-compose.yml

package/lib/typegoose/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/lib/typegoose/.env.development.local

@@ -1,18 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DB_HOST = localhost
-DB_PORT = 27017
-DB_DATABASE = dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = dev
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = *
-CREDENTIALS = true

package/lib/typegoose/.env.production.local

@@ -1,18 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DB_HOST = localhost
-DB_PORT = 27017
-DB_DATABASE = dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = combined
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = your.domain.com
-CREDENTIALS = true

package/lib/typegoose/.env.test.local

@@ -1,18 +0,0 @@
-# PORT
-PORT = 3000
-
-# DATABASE
-DB_HOST = localhost
-DB_PORT = 27017
-DB_DATABASE = dev
-
-# TOKEN
-SECRET_KEY = secretKey
-
-# LOG
-LOG_FORMAT = dev
-LOG_DIR = ../logs
-
-# CORS
-ORIGIN = *
-CREDENTIALS = true

package/lib/typegoose/.eslintignore

@@ -1 +0,0 @@
-/dist

package/lib/typegoose/.eslintrc

@@ -1,18 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "extends": ["prettier", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "rules": {
-    "@typescript-eslint/explicit-member-accessibility": 0,
-    "@typescript-eslint/explicit-function-return-type": 0,
-    "@typescript-eslint/no-parameter-properties": 0,
-    "@typescript-eslint/interface-name-prefix": 0,
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-var-requires": "off"
-  }
-}

package/lib/typegoose/.huskyrc

@@ -1,5 +0,0 @@
-{
-  "hooks": {
-    "pre-commit": "lint-staged"
-  }
-}

package/lib/typegoose/.lintstagedrc.json

@@ -1,5 +0,0 @@
-{
-  "*.ts": [
-    "npm run lint"
-  ]
-}

package/lib/typegoose/.prettierrc

@@ -1,8 +0,0 @@
-{
-    "printWidth": 150,
-    "tabWidth": 2,
-    "singleQuote": true,
-    "trailingComma": "all",
-    "semi": true,
-    "arrowParens": "avoid"
-}

package/lib/typegoose/.swcrc

@@ -1,40 +0,0 @@
-{
-  "jsc": {
-    "parser": {
-      "syntax": "typescript",
-      "tsx": false,
-      "dynamicImport": true,
-      "decorators": true
-    },
-    "transform": {
-      "legacyDecorator": true,
-      "decoratorMetadata": true
-    },
-    "target": "es2017",
-    "externalHelpers": false,
-    "keepClassNames": true,
-    "loose": false,
-    "minify": {
-      "compress": false,
-      "mangle": false
-    },
-    "baseUrl": "src",
-    "paths": {
-      "@/*": ["*"],
-      "@config": ["config"],
-      "@controllers/*": ["controllers/*"],
-      "@database": ["database"],
-      "@dtos/*": ["dtos/*"],
-      "@exceptions/*": ["exceptions/*"],
-      "@interfaces/*": ["interfaces/*"],
-      "@middlewares/*": ["middlewares/*"],
-      "@models/*": ["models/*"],
-      "@routes/*": ["routes/*"],
-      "@services/*": ["services/*"],
-      "@utils/*": ["utils/*"]
-    }
-  },
-  "module": {
-    "type": "commonjs"
-  }
-}

package/lib/typegoose/.vscode/launch.json

@@ -1,35 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Dev typescript-express-starter",
-            "command": "npm run dev"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Start typescript-express-starter",
-            "command": "npm run start"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Test typescript-express-starter",
-            "command": "npm run test"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Lint typescript-express-starter",
-            "command": "npm run lint"
-        },
-        {
-            "type": "node-terminal",
-            "request": "launch",
-            "name": "Lint:Fix typescript-express-starter",
-            "command": "npm run lint:fix"
-        }
-    ]
-}

package/lib/typegoose/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
-  },
-  "editor.formatOnSave": false
-}

package/lib/typegoose/Dockerfile.dev

@@ -1,19 +0,0 @@
-# NodeJS Version 16
-FROM node:16.18-buster-slim
-
-# Copy Dir
-COPY . ./app
-
-# Work to Dir
-WORKDIR /app
-
-# Install Node Package
-RUN npm install --legacy-peer-deps
-
-# Set Env
-ENV NODE_ENV development
-
-EXPOSE 3000
-
-# Cmd script
-CMD ["npm", "run", "dev"]

package/lib/typegoose/Dockerfile.prod

@@ -1,19 +0,0 @@
-# NodeJS Version 16
-FROM node:16.18-buster-slim
-
-# Copy Dir
-COPY . ./app
-
-# Work to Dir
-WORKDIR /app
-
-# Install Node Package
-RUN npm install --legacy-peer-deps
-
-# Set Env
-ENV NODE_ENV production
-
-EXPOSE 3000
-
-# Cmd script
-CMD ["npm", "run", "start"]