Express Typescript

npm init -y

npm i express

npm install -D typescript nodemon @types/node  @types/express  ts-node

npx tsc --init

npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin husky lint-staged  @commitlint/{cli,config-conventional} eslint-plugin-import-helpers

Development Dependencies for Express with TypeScript

--save-dev: Saves dependencies only for the development environment.

eslint: Tool to analyze and find problems in JavaScript and TypeScript code.

prettier: Code formatter that ensures a consistent style throughout the project.

eslint-config-prettier: Disables ESLint rules that might interfere with Prettier.

eslint-plugin-prettier: Integrates Prettier with ESLint to show formatting errors.

@typescript-eslint/parser: Parser that allows ESLint to understand TypeScript.

@typescript-eslint/eslint-plugin: Set of specific TypeScript rules for ESLint.

husky: Tool to create Git hooks, helping automate tasks before committing.

lint-staged: Runs linters on staged files in Git.

@commitlint/cli: Command-line tool to ensure commit messages follow a conventional standard.

@commitlint/config-conventional: Configuration for commitlint to follow the conventional commit message format.

eslint-plugin-import-helpers: ESLint plugin to automatically order imports.

TS.Config

Generate a

ts.config

file with the following content:

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true
  }
}

Package Json

Generate a

package.json

file with the following content:

"test": "echo "Error: no test specified" && exit 1",
"build": "npx tsc",
"start": "node dist/index.js",
"dev": "nodemon src/index.ts"
"format": "prettier --write .",
"lint": "eslint --fix . --ext .js,.jsx,.ts,.tsx",
"prepare": "husky install"

Eslint Config

Generate a

.eslintrc.json

file with the following content:

{
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
      "project": "./tsconfig.json",
      "sourceType": "module"
    },
    "plugins": ["eslint-plugin-import-helpers"],
    "extends": [
      "eslint:recommended",
      "plugin:@typescript-eslint/recommended",
      "plugin:prettier/recommended"
    ],
    "rules": {
      "prettier/prettier": "error",
      "@typescript-eslint/explicit-module-boundary-types": "off",
      "@typescript-eslint/no-explicit-any": "off",
      "no-multiple-empty-lines":  ["error", { "max": 1, "maxEOF": 1 }],
      "import-helpers/order-imports": ["warn", {
        "newlinesBetween": "always",
        "groups": [
          ["/^next/", "module"],
          "/@styles/",
          "/@components/",
          "/@lib/",
          ["parent", "sibling", "index"]
        ],
        "alphabetize": { "order": "asc", "ignoreCase": true }
      }]
    },
    "env": {
      "node": true,
      "es6": true
    }
  }

Prettier Config

Generate a

.prettierrc

file with the following content:

{
  "semi": true,
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80,
  "tabWidth": 2
}

Commitlint Config

Generate a

commitlint.config.js

file with the following content:

module.exports = { extends: ["@commitlint/config-conventional"] };

Husky

Execute a

npx husky install

Generate a husky folder

pre-commit

 #!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged

Generate a husky folder

commit-msg

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint --edit

Package.json

Add in

package.json

file with the following content:

"format": "prettier --write .",
"lint": "eslint --fix . --ext .js,.jsx,.ts,.tsx",
"prepare": "husky install"

Lint Staged Config

Add in

.lintstagedrc

file with the following content:

{
	"**/*.{js,jsx,ts,tsx}": ["npm run format", "npm run lint"]
}

Ignore Eslint

Add in

.eslintignore

file with the following content:


dist
package-lock.json
husky
configs
env
public
server.js
jsconfig.json
package.json
public
README.md
.eslintrc
.eslintrc.json
.eslintrc.js
.prettierrc.json
.eslint*
commitlint.config.js
next-env.d.ts
postcss.config.js
prettier.config.js

Ignore Prettier

Add in

.prettierignore

file with the following content:


dist
package-lock.json
configs
env
husky
public
server.js
jsconfig.json
package.json
public
README.md
.eslintrc
.eslintrc.json
.eslintrc.js
.prettierrc.json
commitlint.config.js
next-env.d.ts
postcss.config.js
commitlint.config.js
prettier.config.js

Ignoee GIT

Add in

.gitignore

file with the following content:

# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts