@onsever/create-express-ts-app 1.0.0

package/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{ts,js}]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.eslintignore

@@ -0,0 +1,146 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+build
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/node

package/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+  "parserOptions": {
+    "ecmaVersion": 2020, // Allows for the parsing of modern ECMAScript features
+    "sourceType": "module" // Allows for the use of imports
+  },
+  "rules": {
+    "semi": [2, "always"],
+    "space-before-function-paren": [0, { "anonymous": "always", "named": "always" }],
+    "camelcase": 0,
+    "no-return-assign": 0,
+    "quotes": ["error", "single"],
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-namespace": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off"
+  }
+}

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "printWidth": 140
+}

package/README.md

@@ -0,0 +1,36 @@
+# Create Express Application with TypeScript
+
+This is a starter template for [Express](https://expressjs.com/) web framework for [Node.js](https://nodejs.org/en/) using [TypeScript](https://www.typescriptlang.org/).
+
+## Features
+
+- TypeScript support with absolute imports and path aliases
+- Live reload with [nodemon](https://nodemon.io/)
+- Testing support with [Jest](https://jestjs.io/)
+- Formatting support with [Prettier](https://prettier.io/)
+- Linting support with [ESLint](https://eslint.org/)
+- Logging support with [Pino](https://getpino.io/)
+
+## Getting Started
+
+Please make sure you have [pnpm](https://pnpm.io/) installed.
+
+## Usage
+
+To use this template, run the following command:
+
+```bash
+npx @onsever/create-express-ts-app <project-name>
+```
+
+## Commands
+
+- `pnpm build` - Build the project
+- `pnpm start` - Start the server in production mode
+- `pnpm dev` - Start the server in development mode with live reload
+- `pnpm lint:check` - Check for linting errors
+- `pnpm lint:fix` - Fix linting errors
+- `pnpm prettier:check` - Check for formatting errors
+- `pnpm prettier:fix` - Fix formatting errors
+- `pnpm test` - Run tests
+- `pnpm test:watch` - Run tests in watch mode

package/bin/cli.js

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const runCommand = (command) => {
+  try {
+    execSync(`${command}`, { stdio: 'inherit' });
+  } catch (e) {
+    console.error(`Failed to execute ${command}`, e);
+    return false;
+  }
+
+  return true;
+};
+
+const projectName = process.argv[2];
+
+if (!projectName) {
+  console.error('Please specify a project name.');
+  process.exit(1);
+}
+
+console.log(`Creating a new Express application with name ${projectName}...`);
+
+const gitCheckoutCommand = `git clone --depth 1 https://github.com/onsever/create-express-ts-app ${projectName}`;
+const installDepsCommand = `cd ${projectName} && pnpm install`;
+
+const checkedOut = runCommand(gitCheckoutCommand);
+if (!checkedOut) process.exit(1);
+
+console.log(`Installing dependencies for ${projectName}...`);
+
+const installedDeps = runCommand(installDepsCommand);
+if (!installedDeps) process.exit(1);
+
+const packageJsonPath = `${projectName}/package.json`;
+try {
+  const packageJsonData = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+  packageJsonData.name = projectName;
+  packageJsonData.version = '1.0.0';
+  packageJsonData.description = 'This project was bootstrapped with Create Express TS Starter';
+  delete packageJsonData.bin;
+  delete packageJsonData.repository;
+  delete packageJsonData.author;
+  delete packageJsonData.license;
+  delete packageJsonData.keywords;
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJsonData, null, 2));
+} catch (err) {
+  console.error(`Failed to modify package.json: ${err.message}`);
+  process.exit(1);
+}
+console.log(`Removing the local Git repository...`);
+
+const removeGitRepoCommand = `rm -rf ${projectName}/.git`;
+const gitRepoRemoved = runCommand(removeGitRepoCommand);
+if (!gitRepoRemoved) process.exit(1);
+
+console.log(`Initializing a new Git repository for ${projectName}...`);
+
+const createGitRepoCommand = `cd ${projectName} && git init`;
+const gitRepoCreated = runCommand(createGitRepoCommand);
+if (!gitRepoCreated) process.exit(1);
+
+console.log(`Clearing the folders...`);
+
+removeGitKeepsSync(path.join(__dirname, './src'));
+
+console.log(`Congratulations! ${projectName} is ready to go!`);
+console.log(`cd ${projectName} && pnpm dev`);
+
+function removeGitKeepsSync(directory) {
+  try {
+    const files = fs.readdirSync(directory);
+
+    files.forEach((file) => {
+      const filePath = path.join(directory, file);
+
+      const stat = fs.statSync(filePath);
+
+      if (stat.isDirectory()) {
+        const gitKeepPath = path.join(filePath, '.gitkeep');
+        if (fs.existsSync(gitKeepPath)) {
+          fs.unlinkSync(gitKeepPath);
+        }
+        removeGitKeepsSync(filePath);
+      }
+    });
+  } catch (err) {
+    console.error(`Error: ${err.message}`);
+  }
+}

package/jest.config.ts

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/vl/2cwdjbls4r71z3y_nm_2jtq80000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every tests
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the tests
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8'
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all tests suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all tests suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all tests environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for tests results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every tests
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual tests
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every tests
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default tests runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each tests
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each tests
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a tests is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The tests environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to tests results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect tests files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|tests).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all tests paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect tests files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom tests runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual tests should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@onsever/create-express-ts-app",
+  "version": "1.0.0",
+  "description": "This is a starter template for Express.js with TypeScript that includes Jest, Prettier, ESLint, and more.",
+  "bin": "./bin/cli.js",
+  "main": "main.js",
+  "scripts": {
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "start": "nodemon ./build/main.js",
+    "dev": "nodemon -r tsconfig-paths/register src/main.ts | pino-pretty",
+    "lint:check": "eslint ''src/**/*.ts",
+    "lint:fix": "eslint 'src/**/*.ts' --fix",
+    "prettier:check": "prettier --check 'src/**/*.{ts,json}'",
+    "prettier:fix": "prettier --write 'src/**/*.{ts,json}'",
+    "test": "jest --config jest.config.ts",
+    "test:watch": "jest --watchAll --config jest.config.ts --collectCoverage=false"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/onsever/create-express-ts-app"
+  },
+  "keywords": [
+    "nodejs",
+    "express",
+    "typescript"
+  ],
+  "author": "Onurcan Sever",
+  "license": "MIT",
+  "devDependencies": {
+    "@jest/types": "^29.6.3",
+    "@types/compression": "^1.7.3",
+    "@types/cookie-session": "^2.0.45",
+    "@types/cors": "^2.8.14",
+    "@types/express": "^4.17.17",
+    "@types/hpp": "^0.2.2",
+    "@types/jest": "^29.5.4",
+    "@types/morgan": "^1.9.5",
+    "@types/node": "^20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.4",
+    "nodemon": "^3.0.1",
+    "pino": "^8.15.1",
+    "pino-pretty": "^10.2.0",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "tsc-alias": "^1.8.7",
+    "tsc-watch": "^6.0.4",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.2.2",
+    "typescript-transform-paths": "^3.4.6"
+  },
+  "dependencies": {
+    "compression": "^1.7.4",
+    "cookie-session": "^2.0.0",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "express-async-errors": "^3.1.1",
+    "helmet": "^7.0.0",
+    "hpp": "^0.2.3",
+    "http-status-codes": "^2.2.0",
+    "morgan": "^1.10.0"
+  }
+}

package/src/main.ts

@@ -0,0 +1,17 @@
+import server from '@root/server';
+import pino from 'pino';
+
+const logger = pino({
+  level: 'info'
+});
+
+const PORT: number = Number(process.env.PORT) || 3000;
+const HOSTNAME: string = process.env.HOSTNAME || 'localhost';
+
+server
+  .listen(PORT, HOSTNAME, () => {
+    logger.info(`Example app listening on port ${PORT}!`);
+  })
+  .on('error', (err: Error) => {
+    logger.error(err);
+  });

package/src/server.ts

@@ -0,0 +1,47 @@
+import express, { json, urlencoded } from 'express';
+import { createServer } from 'http';
+import hpp from 'hpp';
+import helmet from 'helmet';
+import cors from 'cors';
+import compression from 'compression';
+import cookieSession from 'cookie-session';
+import morgan from 'morgan';
+import dotenv from 'dotenv';
+
+dotenv.config({});
+
+const app = express();
+
+app.use(morgan('dev'));
+app.use(
+  cookieSession({
+    name: 'session',
+    keys: ['key1', 'key2'],
+    maxAge: 24 * 60 * 60 * 1000, // 24 hours
+    secure: false
+  })
+);
+app.use(hpp());
+app.use(helmet());
+app.use(
+  cors({
+    origin: '*',
+    methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
+    allowedHeaders: ['Content-Type', 'Authorization']
+  })
+);
+app.use(compression());
+app.use(
+  json({
+    limit: '50mb'
+  })
+);
+app.use(urlencoded({ extended: true, limit: '50mb' }));
+
+app.get('/', (req, res) => {
+  res.send('Hello World!');
+});
+
+const server = createServer(app);
+
+export default server;

package/tests/example.test.ts

@@ -0,0 +1,7 @@
+test('adds 1 + 2 to equal 3', () => {
+  expect(1 + 2).toBe(3);
+});
+
+test('adds 2 + 2 to equal 4', () => {
+  expect(2 + 2).toBe(3);
+});

package/tsconfig.json

@@ -0,0 +1,42 @@
+{
+  "compilerOptions": {
+    "target": "ES2016",
+    "module": "commonjs",
+    "lib": ["DOM", "ES2016"],
+    "baseUrl": ".",
+    "outDir": "./build",
+    "rootDir": "src",
+    "strict": true,
+    "noImplicitAny": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowSyntheticDefaultImports": true,
+    "pretty": true,
+    "resolveJsonModule": true,
+    "plugins": [
+      {
+        "transform": "typescript-transform-paths"
+      },
+      {
+        "transform": "typescript-transform-paths",
+        "afterDeclarations": true
+      }
+    ],
+    "paths": {
+      "@configs/*": ["./src/config/*"],
+      "@controllers/*": ["./src/controllers/*"],
+      "@middlewares/*": ["./src/middlewares/*"],
+      "@models/*": ["./src/models/*"],
+      "@routes/*": ["./src/routes/*"],
+      "@services/*": ["./src/services/*"],
+      "@utils/*": ["./src/utils/*"],
+      "@root/*": ["./src/*"]
+    }
+  }
+}