몬가 yarn 버전 진짜 빨리 바뀌는 느낌? 프로젝트 하나할 때마다 계속 업그레이드되는 것 같다. 아무튼 스타트.
1. 폴더 생성 후 package.json 생성
yarn init2. yarn berry 셋팅 후 필요한 라이브러리 add
yarn set version berry
yarn add express typescript
yarn add --dev @types/express ts-node nodemoneslint, prettier 추가하기.
yarn add --dev eslint prettier eslint-plugin-prettier eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser
yarn dlx @yarnpkg/sdks vscode프로젝트 실행할 때 eslint plugin 설치하는게 제일 싫다... 그냥 싫음.. 아마도 내가 알못이라서 그렇겠지..
3. ts 컴파일을 위해 tsconfig.json 생성
yarn tsc --inittsconfig.json 내용은 뭐 각자 맞춰서 수정하면 된다.
{
"compilerOptions": {
...
"target": "es2015",
...
"baseUrl": "./src",
...
"typeRoots": ["../node_modules/@types", "./@types"],
...
"newLine": "lf",
...
},
"exclude": [
"node_modules",
"**/*.spec.ts",
"**/*.spec.tsx",
"src/@test",
],
}나같은 경우에는 type들을 한 폴더에서 관리하는걸 선호해서 typeRoots에 포함해주고 개행은 lf로 한다.
4. 대충 코드짜서 얼른 실행
타입 지정
/src/@types/dto.d.ts
declare module 'dto' {
/**
* 아카이브 응답 규칙 (response는 반드시 이 형태를 따른다)
* @description T : body 타입
* @description isListBody : 목록 데이터 여부, 목록 데이터인 경우 T는 list 데이터 하나 타입
*/
export interface ArchiveResponse<T, isListBody = true> {
header: {
success: boolean; // 로직의 성공 여부
status: number;
message: string; // i18n 메세지
messageOptions?: Record<string, string>; // i18n 메세지옵션
};
body?: isListBody extends true
? {
totalCount: number;
keywords: string[];
list: T[];
}
: T;
}
}/src/server.ts
import express, { Application, Request, Response } from 'express';
import photos from '@data/photo/list.json';
import { ArchiveResponse } from 'dto';
const app: Application = express();
const port: number = 8080;
app.get('/photos', (req: Request, res: Response) => {
const response: ArchiveResponse<any> = {
header: {
success: true,
status: 200,
message: '성공하였습니다'
},
body: {
list: photos,
totalCount: photos.length,
keywords: []
}
};
res.status(200).type('application/json').send(response);
});
app.listen(port, function () {
console.log(`App is listening on port ${port} !`);
});근데 실행하니 에러가 난다.
늘상 하던대로 absolute로 import했는데 ts-node가 경로를 못찾음.
찾아보니까 tsnode가 path를 찾을 수 있도록 tsconfig.json에 설정을 해야한다고 한다.
추가로 typeRoots에 지정한 path도 ts-node에서 적용이 안된다. 결과적으로 수정 방법은 ts-node에 files: true 설정
yarn add --dev tsconfig-pathstsconfig.json
"ts-node": {
"files": true,
"require": ["tsconfig-paths/register"]
}두가지 수정하니까 잘 설정된다.
여기까지 했을 때 package.json
{
"name": "archive-api",
"version": "1.0.0",
"main": "server.js",
"license": "MIT",
"dependencies": {
"express": "^4.18.2",
"typescript": "^5.3.3"
},
"packageManager": "yarn@4.1.0",
"devDependencies": {
"@types/eslint": "^8",
"@types/express": "^4.17.21",
"@typescript-eslint/eslint-plugin": "^7.0.1",
"@typescript-eslint/parser": "^7.0.1",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-import": "^2.29.1",
"nodemon": "^3.0.3",
"prettier": "^3.2.5",
"ts-node": "^10.9.2",
"tsconfig-paths": "^4.2.0"
},
"scripts": {
"rundemon": "yarn nodemon ./src/server.ts localhost 8080"
}
}.eslintrc
{
"plugins": ["import", "@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:import/typescript",
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": ["tsconfig.json"]
},
"ignorePatterns": ["/src/@test/*", "/.yarn/*", "/.vscode/*", ".eslintrc"]
}.prettierrc
{
"singleQuote": true,
"semi": true,
"useTabs": false,
"tabWidth": 2,
"trailingComma": "none",
"printWidth": 80,
"endOfLine": "lf"
}.tsconfig.json
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2015" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
"lib": [
"esnext",
"ES2015",
"ES5"
] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
"rootDir": "./" /* Specify the root folder within your source files. */,
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
"baseUrl": "./src" /* Specify the base directory to resolve non-relative module names. */,
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
"typeRoots": [
"../node_modules/@types",
"./@types"
] /* Specify multiple folders that act like './node_modules/@types'. */,
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
"resolveJsonModule": true /* Enable importing .json files. */,
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
"newLine": "lf" /* Set the newline character for emitting files. */,
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"exclude": ["node_modules", "**/*.spec.ts", "**/*.spec.tsx", "src/@test"],
"ts-node": {
"files": true,
"require": ["tsconfig-paths/register"]
}
}
React, Next.js, Express STUDY