1. package.json
{
"name": "koa-typescript",
"version": "0.0.1",
"description": "API Server",
"main": "dist/server.js",
"scripts": {
"----------------- [Local] -----------------": "",
"watch:local": "env-cmd -f .env.local nodemon --ignore tests/ --watch src -e ts,tsx --watch .env.local --exec ts-node src/app.ts",
"----------------- [ Dev ] -----------------": "",
"watch:dev": "env-cmd -f .env.dev nodemon --ignore tests/ --watch src -e ts,tsx --exec ts-node src/app.ts",
"----------------- [Prod ] -----------------": "",
"watch:prod": "env-cmd -f .env.prod nodemon --ignore tests/ --watch src -e ts,tsx --exec ts-node src/app.ts",
"----------------- [Other] -----------------": "",
"build": "tsc",
"lint": "tsc --noEmit && eslint \\"**/*.{js,ts}\\" --quiet --fix",
"clean:dist": "rimraf dist",
"----------------- [Serve] -----------------": "",
"serve:local": "env-cmd -f .env.local node dist/app.js",
"serve:dev": "env-cmd -f .env.dev node dist/app.js",
"serve:prod": "env-cmd -f .env.prod node dist/app.js",
"re-serve:local": "npm run clean:dist && npm run build && npm run serve:local",
"-------------------------------------------": "",
"-": ""
},
"scripts-no-use": {
"run-script-once": "ts-node tool/run-once.ts",
},
"engines": {
"node": "18.x.x"
},
"author": "Author",
"keywords": [
"typescript",
"koa"
],
"devDependencies": {
"@types/cron": "^1.7.2",
"@types/jsonwebtoken": "^9.0.5",
"@types/koa": "2.13.1",
"@types/koa__cors": "^3.0.2",
"@types/koa__router": "^8.0.4",
"@types/koa-bodyparser": "^4.3.0",
"@types/koa-helmet": "^6.0.2",
"@types/node": "^14.14.37",
"@types/pg": "^8.10.9",
"@types/shelljs": "^0.8.8",
"@types/ssh2": "^1.11.18",
"@typescript-eslint/eslint-plugin": "^6.x",
"@typescript-eslint/parser": "^6.x",
"eslint": "^7.23.0",
"nodemon": "^2.0.7",
"shelljs": "^0.8.4",
"ts-node": "^9.1.1",
"typescript": "^5.3.3"
},
"dependencies": {
"@koa/cors": "^3.1.0",
"@koa/router": "^10.0.0",
"@sinclair/typebox": "^0.32.9",
"class-validator": "^0.13.1",
"cron": "^1.8.2",
"dotenv": "^8.2.0",
"env-cmd": "^10.1.0",
"jsonwebtoken": "^9.0.2",
"koa": "^2.13.1",
"koa-bodyparser": "^4.3.0",
"koa-helmet": "^6.1.0",
"koa-jwt": "^4.0.0",
"koa-swagger-decorator": "^1.6.4",
"pg": "^8.5.1",
"reflect-metadata": "^0.1.13",
"ssh2": "^1.15.0",
"winston": "^3.3.3"
}
}
2. tsconfig.json
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "ESNext", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
"lib": ["ESNext"], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "dist", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
// "strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"baseUrl": ".", /* Base directory to resolve non-absolute module names. */
"paths": {
"*": [
"node_modules/*"
]
}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
"allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
"experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
"emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
"skipLibCheck": true,
/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
},
"include": [
"src/**/*"
],
"exclude": [
"tests"
]
}