From 9146215300c9216727bfb3cac5de5585e2b5a43d Mon Sep 17 00:00:00 2001 From: yunhoe Date: Wed, 19 Aug 2020 05:28:22 +0900 Subject: [PATCH 1/4] =?UTF-8?q?DTS=20=EB=B2=88=EC=97=AD=20=EC=9D=BC?= =?UTF-8?q?=EB=B6=80=20=EC=99=84=EB=A3=8C=20in=20#121?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../creating-dts-files-from-js.md | 67 ++++++++++--------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/pages/declaration-files/creating-dts-files-from-js.md b/pages/declaration-files/creating-dts-files-from-js.md index cc155885..d9c42096 100644 --- a/pages/declaration-files/creating-dts-files-from-js.md +++ b/pages/declaration-files/creating-dts-files-from-js.md @@ -5,68 +5,69 @@ permalink: /docs/handbook/declaration-files/dts-from-js.html oneline: "How to add d.ts generation to JavaScript projects" --- -[With TypeScript 3.7](/docs/handbook/release-notes/typescript-3-7.html#--declaration-and---allowjs), -TypeScript added support for generating .d.ts files from JavaScript using JSDoc syntax. +[TypeScript 3.7에서](/docs/handbook/release-notes/typescript-3-7.html#--declaration-and---allowjs), +TypeScript는 JSDoc 구문을 사용한 JavaScript에서 .d.ts 파일을 생성할 수 있게 되었습니다. -This set up means you can own the editor experience of TypeScript-powered editors without porting your project to TypeScript, or having to maintain .d.ts files in your codebase. -TypeScript supports most JSDoc tags, you can find [the reference here](/docs/handbook/type-checking-javascript-files.html#supported-jsdoc). +즉 프로젝트를 TypeScript에 이식하거나(porting) 코드베이스에 .d.ts 파일을 유지하지 않고도 TypeScript 기반 편집기의 환경을 유지할 수 있습니다. +TypeScript는 대부분의 JSDoc 태그를 지원하며, [참조](/docs/handbook/type-checking-javascript-files.html#supported-jsdoc)에서 찾을 수 있습니다. -## Setting up your Project to emit .d.ts files +## .d.ts 파일 생성을 위한 프로젝트 설정 (Setting up your Project to emit .d.ts files) -To add creation of .d.ts files in your project, you will need to do up-to four steps: +.d.ts 파일을 프로젝트에서 생성하려면, 다음과 같은 4단계를 거쳐야합니다: -* Add TypeScript to your dev dependencies -* Add a `tsconfig.json` to configure TypeScript -* Run the TypeScript compiler to generate the corresponding d.ts files for JS files -* (optional) Edit your package.json to reference the types +* 개발 의존성에 TypeScript 추가 +* TypeScript를 확인하기 위한 `tsconfig.json` 추가 +* JS 파일에 해당하는 d.ts 파일을 생성하기 위해 TypeScript 컴파일 실행 +* (추가적으로) 타입을 참조하기 위한 package.json 수정 -### Adding TypeScript +### TypeScript 추가 (Adding TypeScript) -You can learn how to do this in our [installation page](/download). +[설치 페이지](/download)에서 방법을 확인할 수 있습니다. ### TSConfig -The TSConfig is a json5 file which configures both your compiler flags, and declare where to find files. -In this case, you will want a file like the following: +TSConfig는 컴파일러 플래그를 구성하고 파일을 찾을 위치를 선언하는 json5 파일입니다. +위와 같은 경우, 다음과 같은 파일이 필요합니다: ```json5 { - // Change this to match your project + // 프로젝트에 알맞게 수정하세요. include: ["src/**/*"], compilerOptions: { - // Tells TypeScript to read JS files, as - // normally they are ignored as source files + // 일반적으로 소스 파일로 무시되기 때문에, + // TypeScript가 JS 파일을 읽도록 지시합니다. allowJs: true, - // Generate d.ts files + // d.ts 파일을 생성시킵니다. declaration: true, - // This compiler run should - // only output d.ts files + // 컴파일러 실행이 오직 + // d.ts 파일만 출력하게 합니다. emitDeclarationOnly: true, - // Types should go into this directory. - // Removing this would place the .d.ts files - // next to the .js files + // 타입은 "dist" 폴더에 존재해야 합니다. + // 해당 설정을 제거하면, + // .d.ts 파일이 .js파일 옆에 생성됩니다. outDir: "dist", }, } ``` -You can learn more about the options in the [tsconfig reference](/reference). -An alternative to using a TSConfig file is the CLI, this is the same behavior as a CLI command. +[tsconfig 참조](/reference)에서 더 많은 옵션을 찾을 수 있습니다. +TSConfig 파일을 사용하는 대신 CLI를 사용할 수 있습니다. ```sh npx typescript src/**/*.js --declaration --allowJs --emitDeclarationOnly --outDir types ``` -## Run the compiler +## 컴파일러 실행 (Run the compiler) -You can learn how to do this in our [installation page](/download). +[설치 페이지](/download)에서 방법을 확인할 수 있습니다. You want to make sure these files are included in your package if you have the files in your project's `.gitignore`. +프로젝트의 `.gitignore`에 파일이 있을 때, 이러한 파일들이 패키지에 포함되어 있는지 확인합니다. -## Editing the package.json +## package.json 수정 (Editing the package.json) -TypeScript replicates the node resolution for modules in a `package.json`, with an additional step for finding .d.ts files. -Roughly, the resolution will first check the optional `"types"` field, then the `"main"` field, and finally will try `index.d.ts` in the root. +TypeScript는 .d.ts 파일을 찾기 위한 추가 단계와 함께 `package.json`의 모듈에 대한 노드 관계(node resolution)를 복제합니다. +대략적으로 먼저 선택적인 `"types"` 필드를 확인 후, 다음은 `"main"`, 마지막으로 루트에서 `index.d.ts`를 확인합니다. | Package.json | Location of default .d.ts | | :------------------------ | :----------------------------- | @@ -74,7 +75,7 @@ Roughly, the resolution will first check the optional `"types"` field, then the | "types": "main.d.ts" | main.d.ts | | "types": "./dist/main.js" | ./main/main.d.ts | -If absent, then "main" is used +type 필드가 없다면, "main"으로 넘어갑니다. | Package.json | Location of default .d.ts | | :----------------------- | :------------------------ | @@ -82,6 +83,6 @@ If absent, then "main" is used | "main":"index.js" | index.d.ts | | "main":"./dist/index.js" | ./dist/index.d.ts | -## Tips +## 팁 (Tips) -If you'd like to write tests for your .d.ts files, try [tsd](https://github.com/SamVerschueren/tsd). \ No newline at end of file +.d.ts의 테스트를 만들고 싶다면, [tsd](https://github.com/SamVerschueren/tsd)를 추천드립니다. \ No newline at end of file From d9266bafb6fcec6ee6322d3c4708f052fcd5c05d Mon Sep 17 00:00:00 2001 From: yunhoe Date: Wed, 19 Aug 2020 17:27:07 +0900 Subject: [PATCH 2/4] =?UTF-8?q?=EB=A6=AC=EB=B7=B0=20=EB=82=B4=EC=9A=A9?= =?UTF-8?q?=EC=97=90=20=EB=A7=9E=EC=B6=94=EC=96=B4=EC=84=9C=20=EC=88=98?= =?UTF-8?q?=EC=A0=95=20=EB=B0=8F=20=EC=B6=94=EA=B0=80=20=EB=B2=88=EC=97=AD?= =?UTF-8?q?=20in=20#121?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../creating-dts-files-from-js.md | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/pages/declaration-files/creating-dts-files-from-js.md b/pages/declaration-files/creating-dts-files-from-js.md index d9c42096..804386ea 100644 --- a/pages/declaration-files/creating-dts-files-from-js.md +++ b/pages/declaration-files/creating-dts-files-from-js.md @@ -5,11 +5,11 @@ permalink: /docs/handbook/declaration-files/dts-from-js.html oneline: "How to add d.ts generation to JavaScript projects" --- -[TypeScript 3.7에서](/docs/handbook/release-notes/typescript-3-7.html#--declaration-and---allowjs), +[TypeScript 3.7에서](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#--declaration-and---allowjs), TypeScript는 JSDoc 구문을 사용한 JavaScript에서 .d.ts 파일을 생성할 수 있게 되었습니다. 즉 프로젝트를 TypeScript에 이식하거나(porting) 코드베이스에 .d.ts 파일을 유지하지 않고도 TypeScript 기반 편집기의 환경을 유지할 수 있습니다. -TypeScript는 대부분의 JSDoc 태그를 지원하며, [참조](/docs/handbook/type-checking-javascript-files.html#supported-jsdoc)에서 찾을 수 있습니다. +TypeScript는 대부분의 JSDoc 태그를 지원하며, [참조](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc)에서 찾을 수 있습니다. ## .d.ts 파일 생성을 위한 프로젝트 설정 (Setting up your Project to emit .d.ts files) @@ -18,11 +18,11 @@ TypeScript는 대부분의 JSDoc 태그를 지원하며, [참조](/docs/handbook * 개발 의존성에 TypeScript 추가 * TypeScript를 확인하기 위한 `tsconfig.json` 추가 * JS 파일에 해당하는 d.ts 파일을 생성하기 위해 TypeScript 컴파일 실행 -* (추가적으로) 타입을 참조하기 위한 package.json 수정 +* (선택적으로) 타입을 참조하기 위한 package.json 수정 ### TypeScript 추가 (Adding TypeScript) -[설치 페이지](/download)에서 방법을 확인할 수 있습니다. +[설치 페이지](https://www.typescriptlang.org/download)에서 방법을 확인할 수 있습니다. ### TSConfig @@ -43,7 +43,7 @@ TSConfig는 컴파일러 플래그를 구성하고 파일을 찾을 위치를 // 컴파일러 실행이 오직 // d.ts 파일만 출력하게 합니다. emitDeclarationOnly: true, - // 타입은 "dist" 폴더에 존재해야 합니다. + // 타입은 이 디렉터리 안에 존재해야 합니다. // 해당 설정을 제거하면, // .d.ts 파일이 .js파일 옆에 생성됩니다. outDir: "dist", @@ -60,8 +60,7 @@ npx typescript src/**/*.js --declaration --allowJs --emitDeclarationOnly --outDi ## 컴파일러 실행 (Run the compiler) -[설치 페이지](/download)에서 방법을 확인할 수 있습니다. -You want to make sure these files are included in your package if you have the files in your project's `.gitignore`. +[설치 페이지](https://www.typescriptlang.org/download)에서 방법을 확인할 수 있습니다. 프로젝트의 `.gitignore`에 파일이 있을 때, 이러한 파일들이 패키지에 포함되어 있는지 확인합니다. ## package.json 수정 (Editing the package.json) @@ -69,20 +68,20 @@ You want to make sure these files are included in your package if you have the f TypeScript는 .d.ts 파일을 찾기 위한 추가 단계와 함께 `package.json`의 모듈에 대한 노드 관계(node resolution)를 복제합니다. 대략적으로 먼저 선택적인 `"types"` 필드를 확인 후, 다음은 `"main"`, 마지막으로 루트에서 `index.d.ts`를 확인합니다. -| Package.json | Location of default .d.ts | +| Package.json | 기본 .d.ts의 위치 | | :------------------------ | :----------------------------- | -| No "types" field | checks "main", then index.d.ts | +| "types" 필드 없음 | "main" 확인 후, index.d.ts 확인 | | "types": "main.d.ts" | main.d.ts | | "types": "./dist/main.js" | ./main/main.d.ts | type 필드가 없다면, "main"으로 넘어갑니다. -| Package.json | Location of default .d.ts | +| Package.json | 기본 .d.ts의 위치 | | :----------------------- | :------------------------ | -| No "main" field | index.d.ts | +| "main" 필드 없음 | index.d.ts | | "main":"index.js" | index.d.ts | | "main":"./dist/index.js" | ./dist/index.d.ts | ## 팁 (Tips) -.d.ts의 테스트를 만들고 싶다면, [tsd](https://github.com/SamVerschueren/tsd)를 추천드립니다. \ No newline at end of file +.d.ts의 테스트를 작성하고 싶다면, [tsd](https://github.com/SamVerschueren/tsd)를 사용해보세요. \ No newline at end of file From 9c799ab21eac1b234fc90ce17c2368d778f19111 Mon Sep 17 00:00:00 2001 From: yunhoe Date: Wed, 19 Aug 2020 22:46:53 +0900 Subject: [PATCH 3/4] =?UTF-8?q?=EB=A6=AC=EB=B7=B0=EC=97=90=20=EB=A7=9E?= =?UTF-8?q?=EC=B6=94=EC=96=B4=EC=84=9C=20=EB=B2=88=EC=97=AD=20=EC=88=98?= =?UTF-8?q?=EC=A0=95=20in=20#121?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/declaration-files/creating-dts-files-from-js.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/declaration-files/creating-dts-files-from-js.md b/pages/declaration-files/creating-dts-files-from-js.md index 804386ea..74d7ec9d 100644 --- a/pages/declaration-files/creating-dts-files-from-js.md +++ b/pages/declaration-files/creating-dts-files-from-js.md @@ -16,7 +16,7 @@ TypeScript는 대부분의 JSDoc 태그를 지원하며, [참조](https://www.ty .d.ts 파일을 프로젝트에서 생성하려면, 다음과 같은 4단계를 거쳐야합니다: * 개발 의존성에 TypeScript 추가 -* TypeScript를 확인하기 위한 `tsconfig.json` 추가 +* TypeScript 설정을 위해 `tsconfig.json` 추가 * JS 파일에 해당하는 d.ts 파일을 생성하기 위해 TypeScript 컴파일 실행 * (선택적으로) 타입을 참조하기 위한 package.json 수정 From 81c62d38fe81a260df07a9d6ad2f571927698a4d Mon Sep 17 00:00:00 2001 From: yunhoe Date: Fri, 21 Aug 2020 21:32:50 +0900 Subject: [PATCH 4/4] =?UTF-8?q?=EB=9D=84=EC=96=B4=EC=93=B0=EA=B8=B0=20?= =?UTF-8?q?=EA=B4=80=EB=A0=A8=20=EB=B2=88=EC=97=AD=20=EC=88=98=EC=A0=95=20?= =?UTF-8?q?in=20#121?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/declaration-files/creating-dts-files-from-js.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/declaration-files/creating-dts-files-from-js.md b/pages/declaration-files/creating-dts-files-from-js.md index 74d7ec9d..2fcf3ec3 100644 --- a/pages/declaration-files/creating-dts-files-from-js.md +++ b/pages/declaration-files/creating-dts-files-from-js.md @@ -45,7 +45,7 @@ TSConfig는 컴파일러 플래그를 구성하고 파일을 찾을 위치를 emitDeclarationOnly: true, // 타입은 이 디렉터리 안에 존재해야 합니다. // 해당 설정을 제거하면, - // .d.ts 파일이 .js파일 옆에 생성됩니다. + // .d.ts 파일이 .js 파일 옆에 생성됩니다. outDir: "dist", }, }