Typescript: TypeScript 웹사이트 및 문서에서 마음에 들지 않는 점은 무엇입니까?

"유틸리티 유형" 페이지가 최신 상태가 아님

새로운 유틸리티 유형은 종종 누락되거나 핸드북의 "유틸리티 유형" 페이지에 추가되지 않습니다(예: Parameters<T> ). 나는 종종 핸드북 대신 lib.es5.d.ts 검색에 의존해야 합니다.

태그: docs

공식 TypeScript Playground는 오픈 소스 대안만큼 좋지 않습니다.

https://typescript-play.js.org 는 공식 버전보다 더 나은 작업을 수행합니다. 여러 버전의 TypeScript를 다루고, 더 큰 텍스트를 공유할 수 있으며, 모든 컴파일러 플래그를 지원하고 엄격 모드는 기본적으로 켜져 있습니다.

태그: playground

릴리스 정보에 대한 색인 페이지 부족

https://www.typescriptlang.org/docs/handbook/release-notes URL 아래에 모든 과거 릴리스 정보를 나열하는 색인 ​​페이지가 있었으면 합니다. 그렇게 하면 TypeScript의 과거 릴리스 업데이트를 추적할 수 있습니다.

태그: docs , release notes

유형 이름에 대한 용어집이 없습니다.

const a: "foo" | "bar" 와 같은 코드를 전달했다면 이것을 Union Type이라고 부르는 것을 모를 수 있습니다.

이것은 매우 낮은 막대이지만, 실존적/조건부/매핑된/기타 유형에 대해 이야기하기 시작할 때 정의를 시도하지만 개요를 얻을 수 있도록 깊이 문서화하지 않는 페이지로 이동할 수 있다는 것이 좋습니다. 이 언어에 대한 모든 분류

태그: types , handbook

비기술적인 사람들과 공유할 페이지가 없습니다

이것은 처음에 TypeScript 사용의 가치가 무엇인지 엔지니어링 외부의 사람들(PM, 비기술적 관리자를 생각해 보세요)을 설득하는 데 필요했습니다. 결국 나는 이것을 직접 작성 했지만 공식을 선호합니다.

태그: guides

확실히 Typed 문서는 TypeScript 문서 외부에 있으며 오래되었습니다.

TypeScript 프로젝트는 이에 대한 문서를 소유해야 합니다. 확실히 형식화 된 문서는 다음 위치에 있습니다.

• https://확실히 타이핑.org
• https://github.com/DefinitelyTyped/DefinitelyTyped#how -can-i-contribute

TS 문서에는 그것이 무엇인지, 왜 사용되는지에 대한 개요가 포함될 수 있으며 공식 사이트를 더 이상 사용하지 않을 수 있습니다.

태그: definitely-typed

점진적으로 TS를 가르치지 않음

(가독성을 높이기 위해 편집됨) 문서가 의도한 명확한 "페르소나"가 있을 때 문서가 가장 효과적이라고 생각합니다. 이 문서가 만들어졌을 때 ES6은 아직 존재하지 않았습니다. 이 문서가 만들어지면 오후에 모든 TS를 배울 수 있습니다.

시대가 바뀌었다.

나는 react-typescript-cheatsheet bc를 만들었습니다. 특히 TS 문서는 이미 es6을 알고 있고 한 번에 고급 TS를 배우고 싶지 않은 사람들에게 서비스를 제공하지 않는다고 느꼈습니다. 따라서 처음으로 TS를 시도하는 숙련된 JS 개발자를 대상으로 합니다. 우리가 많이 있습니다. 현재 문서는 "여기 클래스가 무엇인지" 또는 "유형 연산자 문서와 같은 페이지에 무서운 제네릭이 많이 있습니다."입니다.

특히 다음은 진보적인 교사 역할을 할 수 있는 고려해야 할 페르소나의 전체 목록이 아닙니다.

• 빌드 단계 없이 JSDoc과 함께 TS를 사용하려는 사람들
• 최대한 제네릭을 작성하지 않고 TS를 사용하고 싶은 분
• JS/Flow에서 TS로 코드베이스를 마이그레이션하는 사람들
• TS를 처음 접하고 TS를 채택했지만 처음으로 생소하고 장황한 오류를 보고 어떻게 처리해야 할지 모르는 사람들(이것이 " 문제 해결 " 대상) 또는 옵트아웃
• TS 라이브러리 대 TS 앱을 게시하려는 사람들
• 유형 연산자 사용을 배우고 싶은 사람들
• 도움이 될 수 있는 유형 유틸리티에 대해 배우고자 하는 사람들
• 유형이 지정되지 않은 라이브러리를 입력해야 하는 사람들(.d.ts 작성을 가능한 한 엄청나게 쉽고 잘 문서화하는 것은 네트워크 효과이자 TS의 관심입니다)
• 그리고 aaaaaaall 마지막에, 자신의 제네릭 유형 논리를 작성하는 방법을 배우고자 하는 사람들
• (어쩌면) TS AST를 통과해야 하는 플러그인을 작성하려는 사람들

이것들은 모두 TS 채택 여정의 단계입니다. 우리는 그것을 매핑하고 사람들이 무엇을 해야 할지 몰라서 너무 어렵다고 생각하기 때문에 넘어지는 문서의 절벽이 없는지 확인해야 합니다.

문서가 다음과 같은 신화를 없애는 데 많은 도움이 될 수 있다고 생각합니다.

• 항상 최대의 유형 안전성이 필요합니다(tsconfig뿐만 아니라 입력 기능에서 선택하는 항목에서도).
• TS는 OO 프로그래머를 위한 것입니다(예, 저는 이것을 보았습니다)
• TS는 JS에 와서 유형을 놓치는 C#/Java 개발자 전용이며 JS 개발자에게는 실질적인 가치가 없습니다.
• TS 오류를 스스로 해결하는 방법을 알아낼 수 있어야 합니다.
• 일반적으로 TS는 시작하는 데 높은 학습 곡선을 가지고 있습니다.

리소스를 사용할 수 있는 경우 React뿐만 아니라 Vue 및 Node 등의 경우 채택을 지원하기 위해 특정 대규모 개발 커뮤니티를 대상으로 할 수 있고 또 그래야 합니다. 기본 문서에서 이 작업을 수행할 수 있습니다. 예를 들어 Vue 문서는 컨텍스트의 실제 예제에 중점을 둔 Cookbook과 Guide를 구분 합니다.

이것은 내가 상상할 수 있는 후기 단계의 TS 채택(즉, TS에서 판매되기 위해 더 많은 문서/도구/보증/핸드홀딩이 필요한 사람들)에 대한 큰 장애물일 것입니다.

태그: docs

연결된 TypeScript 언어 사양이 완전히 구식입니다.

메인 페이지에서 직접 "TypeScript 언어 사양"으로 연결됩니다.

GitHub에서 사양을 읽거나 docx 또는 pdf로 다운로드하십시오.

그러나 해당 사양은 완전히 구식이며(버전 1.8에서 고정, 마지막 실제 업데이트는 2016년 1월) 유지 관리되지 않습니다. 사양에 대한 언급은 생략하는 것이 가장 좋습니다.

태그: spec specification outdated

코드 샘플을 위한 놀이터 같은 위젯

모든 편리한 도구 설명, 하이라이트 등이 포함된 놀이터와 같은 위젯의 문서에 있는 모든 코드 샘플을 제공합니다.

이상적으로는 방출된 JS/타이핑을 편집하고 보는 전체 플레이그라운드로 튀어나올 수 있는 기능이 있습니다.

이것은 자연스럽게 공식 TypeScript Playground 에 의존하게 될 것이며 만큼 좋지 않습니다 .

릴리스 정보에만 존재하는 API 문서

unknown 와 같은 일부 유형 은 릴리스 정보 에만 문서화

태그: docs

포슬래시 놀이터

/tests/cases/compiler 에는 기준선과 함께 신비한 암흑 물질처럼 작동하는 엄청난 양의 파일이 있습니다. 이 메가바이트는 문서/데모로 재사용할 수 있습니다.

• https://www.typescriptlang.org/play/tests/cases/compiler/aliasAssignments.ts 를 통해 TS 놀이터가 TS 저장소에서 모든 파일을 로드하도록 합니다.
• TS 놀이터가 '포슬래시'를 이해하게 하세요
• 해당 파일에 설명 주석 추가

그것은 누군가가 흥미로운 구문 사례에 대한 URL 링크를 허용하고 사람들이 다른 펑키한 테스트를 수정하고 제출하는 데 도움이 될 것입니다.

주어진 TS 구문을 설명하는 놀이터

정말 이해하기 어려운 복잡한 TS 구문을 우연히 발견하는 것은 어렵지 않습니다. 유니온과 펑키 인덱싱된 유형을 통해 결합된 재귀 제네릭... 그런 무서운 지네의 큰 둥지 중 하나는 예를 들어 타이핑입니다.

각도가 풍부한 구문 덩어리를 붙여넣고 사람이 소화할 수 있는 장황한 보기나 다이어그램을 관찰할 수 있다면 어떨까요? A 는 클래스이고 B 는 공용체 유형이며 C 는 D 대한 일반 매개변수임을 의심할 여지 없이 명확하게 알 수 있습니다 B 등등.

순진한 '장황한 AST 예쁜 인쇄'로 시작하여 시간과 커뮤니티의 기여로 더 깊은 패턴 인식과 더 풍부한 대화형 비주얼 및 UML과 같은 다이어그램으로 확장될 수 있습니다.

문서에 대한 검색이 없습니다

나는 종종 주요 문서를 사실의 소스로 사용하는 것보다, 예를 들어 React 문서에서와 같이 DocSearch를 사용하는 것보다 typescript를 사용하여 무언가를 수행하는 방법을 인터넷 검색에 의존해야 합니다.

태그: search , exploration

커뮤니티 프로젝트 강조

이것은 모임, 커뮤니티 대화 또는 책과 같은 것일 수 있습니다.

그러나 누군가가 배울 수 있는 TypeScript를 사용하는 더 큰 소프트웨어 프로젝트도 가능합니다.

태그: Community

특정 컴파일러 플래그를 설정하기 위한 가이드 제공

예를 들어 noImplicitReturns 를 켜면 어떤 종류의 문제가 발생하고 어떻게 처리해야 합니까? 이러한 종류의 권장 사항은 해당 플래그가 도입된 시점의 버전 릴리스 노트와 함께 제공되므로 찾는 것이 까다롭습니다.

태그: tsconfig

컴파일러 오류 인덱스 페이지 만들기

Rust 언어는 이를 수행하기 위해 시작하는 데 상당한 노력

태그: compiler

각도가 풍부한 구문 덩어리를 붙여넣고 사람이 소화할 수 있는 장황한 뷰나 다이어그램을 관찰할 수 있다면 어떨까요?

나는 이것이 멋지다고 생각하지만 어떤 경우에는 유형이 어떻게 분류되는지에 대한 고도로 구조화된 설명(자동 생성이 가능할 것 같은)은 특정 목표. 예를 들어 누군가가 이것이 무엇인지 설명하기를 원한다고 가정해 보겠습니다.

type X<T extends object> = {
    [K in keyof T]: T[K]
}[keyof T]

나는 당신에게 _할 수 있습니다_

X 매개 변수를 하나 개의 유형으로 유형 별명입니다 T 로 제한되어있는 object . T 인스턴스화하면 매핑된 유형이 생성됩니다. 여기서 keyof T 유형의 각 구성 요소 K 에 대해 값은 인덱싱된 액세스 유형 T[K] . X 는 keyof T 유형의 매핑된 유형에 대해 인덱싱된 액세스 유형을 생성합니다.

그러나 TypeScript에 대한 작업 지식이 있는 사람 외에는 다음과 같이 말하는 것이 훨씬 더 도움이 되지만 매우 어려울 것입니다.

X 는 T 의 멤버 값 유형의 합집합을 가져옵니다.

이와 같은 패턴의 "레시피" 모음이 있으면 편리할 수 있습니다.

고급 유형 페이지는 명확하지 않은 유형에 대한 일종의 덤핑 장소입니다( PHP 정적 분석 도구에 대한 TypeScript의 아이디어를 훔쳤으므로 해당 페이지에서 많이 찾습니다).

거기에 있는 많은 아이디어가 서로 연결되어 있지만 페이지 간의 하이퍼링크를 사용하면 충분히 가능합니다.

Type Guard/Type Predicate 섹션은 ​​특히 자체 페이지에 가치가 있는 것처럼 느껴집니다.

타이프스크립트 라이브러리 작성 지침

Typescript로 작성된 라이브러리를 출시하는 것은 그리 쉽지 않다는 것을 알게 되었습니다. 대상 소비자에 따라 고려해야 할 많은 경우가 있습니다. 나는 이것에 대해 완전히 논쟁의 여지가 있는 내 자신의 의견 을 가지고 있지만, 도서관 저자를 위한 공식 지침을 문서화하는 것은 굉장할 것입니다.

태그: libraries , guidance

모바일 내비게이션은 어려울 수 있습니다.

모바일에서 웹사이트 핸드북을 읽을 수 없어 상당히 실망스럽습니다. 또한 핸드북의 각 페이지에서 페이지 하단에 이전/다음 탐색 기능이 있으면 좋을 것입니다.

트윗에서

태그: nav

더 많은 실제 사례 사용

현재 예제 중 일부는 문자 기반(A, B, C) 또는 관련성이 없는 용어(foo, bar, baz, args, obj 등)인 명명 규칙을 사용하여 지나치게 일반적이거나 추상적입니다. 더 많은 실제 사례(모양, 동물, 제품, 사용자)와 합법적인 사용 사례(API 호출, 로깅, 오류 처리, 데이터 형식 지정)를 볼 수 있기를 바랍니다. 이는 제네릭 및 고급 유형과 같이 이미 추상화되어 있는 개념에 특히 유용합니다.

참고: 문서의 일부 영역에서 이미 이 문제 👌🏻를 처리하고 있지만 실패했습니다.

태그: examples

예제 라이브러리 및 모범 사례

다양한 종류의 함수를 입력하는 방법을 보여줍니다. lodash에는 선택, 확장, 병합 등과 같은 모든 종류의 멋진 기능이 있는 것처럼 입력 방법을 설명합니다.

점점 복잡해지는 라이브러리. TS의 특정 항목이 프로덕션에서 사용되는 방식을 보여주는 커밋에 대한 더 많은 링크를 읽을 수도 있습니다.

결국 빌드되는 것이 무엇이든 누군가가 예제를 추가하기가 매우 쉽기를 바랍니다. git repo와 같은 TS 핸드북이 될 것이라고 가정합니다.

최고의 오픈 소스 프로젝트는 일반적으로 최고의 문서와 새로운 사용자 경험을 제공합니다.

TS를 신규 사용자에게 더욱 환영하도록 합시다.

tsconfig 옵션에 대한 더 나은 설명

컴파일러 옵션 페이지의 현재 설명

• 각 옵션에 대한 매우 모호한 설명과 이것이 컴파일 및 유형 검사에 미치는 영향을 제공합니다. 몇 가지 예가 정말 유용할 수 있습니다.
• 표 형식은 약간의 설명 공간을 남깁니다.
• TypeScript 버전에 대한 정보가 없습니다.
• 알파벳 순서는 유용하지 않습니다. 일부 옵션은 target , module 및 lib 또는 모든 엄격한 유사 옵션과 같이 서로 밀접하게 관련되어 있습니다. 그것들을 따로따로 보면 잘 이해하기 어렵습니다. target 먼저 이해하지 않고는 lib 옵션을 이해할 수 없습니다.
• 대부분의 경우 사람들은 tsc 옵션이 아닌 tsconfg 파일에서 이러한 옵션을 사용하므로 현재 형식은 신규 사용자에게 혼동을 줄 수 있습니다.
• 일부 옵션에 대한 자세한 설명은 문서 전체에 흩어져 있습니다. 예: @types , typeRoots 및 types 옵션은 tsconfig.json 페이지 및 baseUrl 및 paths 모듈 해상도

특정 컴파일러 플래그 제안

편집하다:
문서에 정보가 없고 릴리스 정보 및 GitHub 문제를 기반으로 전체 그림을 조합해야 하는 복합 프로젝트 구축과 관련된 것과 같은 새로운 옵션은 말할 것도 없습니다.

태그: tsconfig

문서, 블로그 및 기타 공식 리소스를 한 곳으로 수집

TypeScript에 대한 모든 공식 리소스를 한 곳(예: www.typescriptlang.org )에 수집할 수 있다면 정말 좋을 것입니다! 😊

예를 들어 v3.5 발표에 대한 블로그 게시물은 다른 위치( devblogs.microsoft.com )에 있습니다.
https://devblogs.microsoft.com/typescript/announcing-typescript-3-5/

그리고 v3.4 릴리스 노트는 다른 위치에 있습니다.
https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html

TypeScript 개발자에게는 이것이 그다지 유용하고 혼란스럽지 않다고 생각합니다. 😕

태그: blog , resources

기본 설정 및 프로젝트 설정으로 UI 양식을 작성하여 tsconfig.json 생성

문서에 대상 환경(브라우저, nodeJS), 사용자 기본 설정(사용자가 원하는 대로 엄격하거나 관대함) 및 프로젝트 디렉터리 구조에 맞는 tsconfig.json을 생성하는 데 도움이 되는 양식/마법사가 포함되어 있으면 좋을 것입니다. 현재 TS 컴파일러 옵션 에는 몇 가지 더 이상 사용되지 않는 옵션과 일부 컴파일러 플래그가 포함되어 있어 언뜻 보기에 거의 동일한 작업을 수행하는 것처럼 보입니다(예: 경로/디렉토리/루트와 관련된 일부 옵션의 차이점은 무엇입니까). 생성된 tsconfig는 Microsoft TypeScript 핵심 팀의 모범 사례를 따라야 합니다. 기타 안내 질문에는 다음이 포함될 수 있습니다.

• TypeScript를 사용한 프로젝트 개발 팀의 경험은 무엇입니까("TS 전문가"에 대한 모든 엄격한 옵션을 제안하면서 초심자에게 "JS에서 TS로의 마이그레이션 경로" 관련 컴파일러 옵션을 제안할 수 있음)
• 프로젝트는 라이브러리 또는 응용 프로그램입니다(종속성이 거의 없는 라이브러리의 경우 strictNullChecks 와 같은 일부 엄격한 기능을 사용하는 것이 더 쉬울 수 있으므로 사용자 경험에 따라 제안될 수 있음)
• JSX/TSX(React)를 사용하는 애플리케이션입니다.
• 데코레이터를 사용하는 프레임워크/라이브러리를 사용하고 있습니까?
  
  
  
  • 데코레이터 메타데이터를 내보내야 런타임에 프레임워크/라이브러리에서 사용할 수 있습니다(예: Angular, Aurelia와 같은 프레임워크 및 라이브러리 언급).
  
  

태그: tsconfig , examples , guides , wizard , exploration

@orta 놀이터의 모바일 버전을 만들거나 최소한 현재 버전을 적용하는 것이 굉장할 것이라고 생각합니다. 현재로서는 놀이터가 모바일에서 끔찍해 보입니다(스크린샷은 iPhone 7에서 작성되었습니다).

웹사이트의 "핸드북" 영역에 객체 리터럴과 이를 입력할 수 있는 다양한 방법에 대해 구체적으로 설명하는 섹션이 있었으면 합니다.

예를 들어, "모든 속성이 있는 typescript 개체 리터럴" 또는 "하나의 필수 속성과 다른 속성이 있는 typescript 개체 리터럴"과 같은 것을 Google에 지속적으로 검색해야 합니다.

그리고 나는 항상 { [key: string]: any } 유형을 찾아야 하는데, 이것은 어디에도 실제로 논의되지 않습니다.

이 내용 중 일부는 "인터페이스"에 대해 논의되지만 즉시 명확하지 않습니다.

공급업체 유형 보강

때때로 ConfirmTyped 유형 또는 기타 공급업체 모듈 정의로 작업할 때 정의를 다음 중 하나로 조정해야 한다는 것을 알았습니다.

1) 기존 정의 덮어쓰기/수정
2) 새로운 메소드/속성 추가

다양한 시나리오에서 작업을 수행하는 적절한 방법에 대한 문서를 찾을 수 없었습니다. 저도 혼자 해야 할 때 메모를 잘 못했어요 🐙. https://www.typescriptlang.org/docs/handbook/declaration-merging.html 은 자사 코드에 대한 문제를 해결하지만 타사 모듈 유형/내보내기에는 해당 조언이 적용되지 않았습니다.

분명히 PR을 즉시 열어 해당 리포지토리의 유형을 수정/업데이트하는 것이 좋지만, 워크플로를 방해하고 임시 any 변환 및 후속 TODO.

태그: vendor

컴파일러 API 문서

위키에는 컴파일러 API 사용에 대한 정보가 있지만(https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) 특정 목표를 달성하기 위해 이를 사용하는 방법의 예만 보여줍니다. 존재하는 특정 객체와 메소드를 나열하고 그들이 하는 일에 대해 배울 수 있는 더 많은 JSDoc 스타일 정보가 있으면 좋을 것입니다. 지금 저는 API를 배우려고 하고 있으며 무슨 일이 일어나고 있는지 알아내기 위해 typescript 소스를 살펴보아야 합니다.

(위키에 언급된 것처럼 API가 아직 안정적이지 않기 때문에 이것이 완료되지 않은 경우 무시하십시오)

태그: compiler

기존 언어와 비교하여 TS에 중점을 둔 자습서

많은 사람들이 TypeScript를 두 번째(또는 그 이상) 언어로 사용합니다. TypeScript 학습을 단순화하는 한 가지 방법은 이미 알고 있는 기존 언어와 비교하는 것입니다. JS, Java, C#, PHP, C(+ CPP) 및 Ruby와 같은 인기 있는 프로그래밍 언어

지금 우리는 당신이 JS를 알고 있다고 가정합니다.

태그: tutorials

기본적으로 액세스할 수 있는지 확인

accessibilityinsights.io와 같은 린터가 통과하는지 확인

태그: infra

놀이터에 대한 짧고 공유 가능한 URL

TypeScript 플레이그라운드의 "공유" 버튼이 전체 소스 코드를 URL에 덤핑하는 것보다 짧은 URL을 생성하면 좋을 것입니다.

또는 URL에 놀이터를 채우는 github 요지 ID가 포함될 수 있습니다. 예: https://www.typescriptlang.org/play?gist=eb25a1f350e50d6ed3561a777fbfe424

태그: playground

설정이 다른 예(사용 사례/시나리오가 다름)

내 TS 코드베이스를 구성할 수 있는 방법과 다양한 코드베이스에 대해 따를 수 있는 예제를 아는 것이 까다롭다는 것을 알았으므로 https://github.com/microsoft/TypeScriptSamples/ 와 같은 예제 목록이 웹사이트에 표시되면 좋을 것입니다. tsconfig.json 을 구성하는 방법과 의도한 대로 작동하도록 TS 파일을 구성하는 방법을 보여줍니다.

태그: docs , examples

문서가 위키 대 핸드북에 포함되는 분명한 이유가 없습니다.

Wiki의 this 에 있는

주제와 제목 간 탐색 개선

핸드북 § 고급 유형 과 같은 방대한 주제는 별도의 제목 간에 탐색이 잘 되지 않으며 위로 가기 버튼도 없습니다. 플로팅 탐색 메뉴를 추가하면 정말 좋을 것입니다. 현재 한 타이틀에서 다른 타이틀로 이동하거나 원하는 타이틀을 빠르게 찾는 것이 어렵습니다.

다음은 이 Assembly Script git book에 제공된 탐색의 좋은 예입니다. https://docs.assemblyscript.org/basics/environment

태그: website , handbook , navigation

모바일 친화적인 플레이그라운드 코드 편집

내가 알기로는 구문 강조 표시와 다른 모든 IDE 기능을 사용한 모바일 친화적인 코드 편집은 고통스럽습니다.

그러나 데스크톱/노트북에서 멀리 떨어진 휴대전화에서 코드 조각을 사용하고 싶은 경우가 종종 있습니다.

나는 모바일 사용을 위한 구문 강조 편집기 대신 일반 <textarea> 필드를 신경 쓰지 않을 것입니다.

오류는 다른 페이지나 팝업 또는 기타 html 요소에 있을 수 있습니다.

태그: 놀이터, 모바일, 코드 편집기

브라우저 호환 es6 모듈용 .js 확장을 추가하는 문서

가져오기 이름에 .js 확장자를 추가하기
https://github.com/Microsoft/TypeScript/issues/16577#issuecomment -343610106

어떤 버전의 TS가 추가했는지 확실하지 않지만 './file.js'와 같은 가져오기가 이제 작동합니다(파일이 실제로 file.ts인 경우에도).

저에게 이것은 엄청난 기능이었습니다... 하지만 공식적으로는 존재하지 않습니다?!

고급 유형 페이지에는 Omit<T, K> 유형이 포함되어 있지 않습니다.

Omit<T, K> 는 최근 TypeScript 3.5에 추가 되었지만 고급 유형 페이지에는 여전히 다음과 같은 고지 사항이 있습니다.

참고: 제외 유형은 여기에 제안된 Diff 유형의 적절한 구현입니다. Diff를 정의하는 기존 코드가 깨지는 것을 피하기 위해 Exclude라는 이름을 사용했으며 이름이 유형의 의미를 더 잘 전달한다고 생각합니다. 우리는 생략을 포함하지 않았습니다간단히 Pick으로 작성하기 때문에 유형>.

Linters에 대한 프로젝트 설정 문서 제공

프로젝트 설정의 일부로 Linter로 설정하는 방법을 포함시키십시오. 아마도 프로젝트가 자체적으로 사용해야 하는 typescript-eslint일 것입니다.

태그: linter

가장 일반적으로 발생하는 오류 또는 TypeScript 제한 사항을 다루는 것은 없습니다.

TypeScript를 처음 배울 때 TypeScript에서 지원되지 않는 특정 패턴이 있습니다. 가장 간단한 것 중 하나:

const buildResult = (name?: string) => {
  const result = {};
  if (name) {
    result.name = name; // error, this property doesn't exist on {}
  }
  return result;
};

회사에 TypeScript를 도입하기 시작했는데 이와 같은 경우가 많이 발생하여 FAQ/문제 해결 스타일의 가이드로 문서화하기 시작했습니다. 빠르게 성장하고 있습니다(거친 상태에 있음).

한 번에 하나의 속성을 대상으로 빌드
원할 때 오류가 발생하지 않는 이유: 초과 속성 확인
공용체를 포함하여 선택적 속성에 액세스하는 방법
Object.keys 및 Object.entries가 원하는 작업을 수행하지 않는 이유
필터 필터를 만들어 오류 없이 작업을 줄입니다.
유형 세분화가 손실됨

이 정보 중 하나라도 문서에 있으면 찾을 수 없습니다. 나는 수년간의 시행착오를 통해서만 이것을 이해하고 Github에서 가장 많이 연결된 문제를 읽었습니다.

태그: errors , troubleshooting , limitations

사용자 정의 유형 정의를 추가하는 방법에 대한 명확한 문서 제공

유형을 포함하지 않고 @types/* 패키지를 사용할 수 없는 라이브러리가 많이 있습니다. 내 프로젝트 내에서 이러한 선언 파일에 대한 내 자신의 선언 파일을 작성할 수 있기를 원하지만 이를 작성하고 typescript가 인식하도록 하는 '올바른' 방법에 대한 문서는 없는 것 같습니다. npm에서 모듈을 가져오고 있다고 가정해 보겠습니다. declare module x 를 사용해야 합니까? 또는 declare module "x" ? 또는 네임스페이스를 사용하시겠습니까? 아니면 그냥 유형을 내보내시겠습니까? 이 파일을 넣어야 하는 특정 위치가 있습니까? 어떤 구성 옵션을 설정해야 합니까? typeRoots ? types ? paths ? include ? 또는 무엇을? - 지금까지 내가 찾은 것은 혼란스러운 오류 메시지, 잘못 설명된 구성 옵션, 오래된 SO 질문뿐입니다.

태그: docs

오프라인 문서 부족

git 또는 npm 와 같은 최신 기본 개발 도구에는 오프라인 문서/참조에 액세스할 수 있는 자체 명령 하위 집합이 있습니다. 예:

$ git help ls-remote
$ npm help search 

그런 기능이 있으면 좋을 것 같아요(TS는 조금 다르지만).
사이트/github 등을 참조할 필요 없이 help 와 같은 명령을 통해 로컬에서 문서를 탐색할 수 있습니다.

$ tsc help tsc # basic CLI arguments desc
$ tsc help config # opens up html page of the tsconfig.json docs
$ tsc help v3.5 # opens up html page changelog
$ tsc help enum # finds pages containing `enum` type and hints their names/opens them up

태그: offline , search , cli , local

예제에는 더 나은 구별 색상이 필요합니다!

다음과 같아야 합니다.

const whomstve = (name: string) => name + 'is life'

현재 상태:

const whomstve = (name: string) => name + 'is life'

약간의 파란색이 있지만 그뿐입니다.

안녕하세요 여러분, 저는 지난 한 달 동안 일반적인 사이트 구조와 전체 문서에 대해 생각하면서 이 문제를 주시해 왔습니다. 이제 이 문제가 해결되었고 문서가 어떻게 생겼으면 하는지에 대해 조금 더 이해하게 되었습니다.

가독성을 위해 약간의 뒤섞임과 함께 반응을 기반으로 이러한 모든 사항을 살펴보겠습니다.

API 문서는 릴리스 정보에만 존재할 수 있습니다.

이것은 부분적으로 지금 릴리스 노트에만 있는 것이 확실하지 않기 때문에 까다로울 것입니다.

언어 및 구문과 관련하여 전체 언어를 새롭게 살펴볼 새 핸드북으로 이 문제가 수정되고 개선되기를 기대합니다. 나머지 문서에서는 새 사이트맵 중 일부가 대부분의 경우를 다루어야 한다고 생각하지만 여전히 WIP입니다.

웹사이트에서 검색하지 않음

예, 동의합니다. 이것은 새 사이트에서 확실히 중요합니다.

웹사이트는 폐쇄 소스입니다

결정된! https://github.com/microsoft/TypeScript-website

새 작업은 마스터 브랜치에서 벗어나지만 지금은 이전 사이트 위에서 액세스할 수 있고 PR을 받고 있습니다. TypeScript 리포지토리에서 여기로 문제를 옮기고 있으므로 모든 문제를 더 쉽게 추적할 수 있습니다.

유틸리티 페이지가 최신 상태가 아님

결정된! 부분적으로 나는 많은 PR을 병합했고 커뮤니티에서 최신 핸드북을 얻었습니다. 뿐만 아니라 탐색에 표시되는지 확인합니다(웹 검색에만 해당).

향상된 TS 구성 옵션 설명

나는 주말에 이것을 탐구하기 시작했다(컴파일러와 웹사이트가 이 문서에 대해 동일한 초기 데이터 소스를 공유하도록 하는 방법과 웹사이트가 더 많은 컨텍스트를 제공하기 위해 그 위에 무엇을 구축할 수 있는지)

지금까지 방향의 몇 가지 예:

• 2017년의 나만의 노트
• 저는 tsconfig-ui 가 TSConfig 탐색기를 만들기 위한 기초가 될 수 있는 Ethan Arrowood @matterhorndev 와 채팅했습니다.

놀이터는 대안만큼 좋지 않습니다.

결정된! 나는 이것이 내가 놀이터가 되기를 바라는 일반적인 방향의 긍정적인 디딤돌이라고 생각합니다. 저는 Playground가 진정으로 최고의 동종으로 만들기 위해 어떤 모양과 느낌을 가져야 하는지에 대한 보다 장기적인 관점을 제공하는 몇 가지 예제 모형을 가지고 있습니다.

( figma 탐색 클릭 )

플레이그라운드용 짧은 공유 URL

고정, 아래 참조

유형 이름에 대한 용어집 없음

나는 컴파일러를 배우면서 내 자신의 글을 쓰기 시작

[놀이터 ex1, 놀이터 ex2]

점진적으로 TS를 가르치지 않음

이것은 #29288( New handbook 스크롤)의 일부를 인용하기 위해 새 핸드북에서 해결하기 위한 것입니다.

TypeScript의 대상이 광범위하기 때문에 모든 사용자를 위한 일반 문서를 작성하는 것은 어렵습니다. 그리고 현재 핸드북의 강점(및 약점) 중 하나는 모든 사용자에게 한 번에 서비스를 제공하려고 한다는 것입니다. TypeScript를 배울 때 서로 다른 기대치를 가진 여러 개발자 그룹이 있으며 서로 다른 개념의 노출 수준을 조정해야 합니다. 이를 감안할 때 우리의 목표는 핸드북을 세 부분으로 구성하는 것입니다.

1. 맞춤형 소개(핵심 핸드북 설정)
   
   
   
   1. 핵심 핸드북(모든 사람이 읽습니다)
   
   
   2. 참조 페이지(일종의 심층 분석/부록)
   
   

효과적으로 그것은 몇 가지 다른 출발점을 가지고 주변 생태계에 익숙해지면 언어를 가르치려고 시도합니다.

댓글에 있는 모든 내용이 설명되어 있습니까? 아니, 시작에 불과하다. 현재 가지고 있는 사이트맵은 매우 광범위하며 다음과 같은 유형의 문제에 관심이 있습니다.

현재 사이트 맵 요리 책과 가이드에 약간의 여지를 남겼습니다. 요리 책은 더 많은 커뮤니티 지원을 장려할 수 있는 것입니다.

가이드 제공

나는 현재 TypeScript 웹사이트에 있는 현재 코드 샘플을 정렬하고 업데이트하기 시작했습니다. 공식 문서로 리디렉션하는 것과 비교하여 어떤 샘플이 더 나은지 여전히 파악 중입니다(예: 프로젝트가 이제 기본적으로 TypeScript를 지원하고 자체 문서가 있는 경우).

위와 마찬가지로 사이트의 요리 책과 실제 가이드 섹션은 이것을 다루기에 충분해야한다고 생각합니다.

언어 사양이 오래되었습니다.

예, 기본 저장소에서 완전히 제거할 수 있는지 모르겠습니다. 하지만 새 사이트에서는 언급되지 않습니다.

코드 샘플에 대해 더 나은 IDE와 유사한 경험 제공

이것은 현재 새 핸드북 사이트 에 있지만 새 사이트에도 이식해야 합니다. 또한 강조 표시 및 인라인 오류 메시지를 제공하는데, 이는 제가 매우 기쁘게 생각합니다.

컴파일러 오류 색인 페이지

이 문제가 발생하는지 확실하지 않습니다. 부분적으로 TypeScript에는 많은 오류 코드가 있으며 꽤 정기적으로 변경되고 있습니다. 완전히 작동하는 사이트와 문서가 있으면 다시 돌아올 가치가 있지만 지금은 백 버너에 있습니다.

더 많은 실제 사례 보기

지금까지의 새 핸드북은 이 부분을 잘 수행하고 있습니다. 나머지 문서를 사용하여 내가 보는 모든 것을 그런 식으로 변경하려고 합니다.

사이트의 모바일 지원이 약함

새 사이트에 Microsoft 디자인 시스템(유체)을 사용하려고 합니다. 즉, 모바일 지원(접근성 포함)이 "대부분 무료로" 제공되어야 합니다.

놀이터만큼 복잡하고 조금 더 까다롭기 때문에 휴대폰 크기의 모바일에는 탐색/탐색 사고 방식이 적합하다고 생각합니다. 그래서 저는 읽기 전용 경험에 조금 더 가까운 모형을 가지고 있습니다.

tsc 도움말 개선 사항 살펴보기

나는 이에 대해 개방적이지만 typescript CLI는 실제로 하나의 명령, 컴파일입니다(이것이 하위 명령에 대한 도움이 필요하지 않은 이유입니다(--init이 약간 깨짐)).

DTS 개선에 대한 조언 제공

예, 확실히 타이핑된 웹사이트를 타이프스크립트 웹사이트로 병합하고 해당 문서를 통합할 계획입니다. 그들 중 _모두_가 사이트에 살 것인지 여부는 여전히 논쟁의 여지가 있습니다. 높은 수준의 개요가 사이트에 있을 수 있는 동안 명확하게 형식화된 저장소에 기여하는 실제 구현 세부 정보를 유지하는 데는 몇 가지 좋은 이유가 있습니다.

문서/블로그/릴리스 노트 통합

까다로운 문제로 블로그/릴리스 노트에 대한 답변이 없습니다. 우리는 다른 모든 사람들과 함께 Microsoft 제품 블로깅 시스템을 사용하고 있으며 이 모든 것을 웹사이트 자체로 옮기는 것이 좋은 생각인지 잘 모르겠습니다. 우리는 그것이 시간에 더 가깝다는 것을 알 수 있습니다.

더 쉬운 측면에서, 나는 확실히 위키에서 이런 종류의 정보를 제거하고 웹사이트 내부에만 남겨두고 싶습니다(사이트 검색에 의해 색인이 생성될 수 있는 곳) - 저는 특별히 기여하기 위해 TypeScript 위키를 남겨두고 싶습니다. TypeScript 및 TypeScript 컴파일러 API 작업(예: import * as ts from “typescript” 또는 언어 서버 플러그인 빌드 시)

가장 흔히 발생하는 오류를 다룹니다.

이것은 위와 관련이 있습니다. 이러한 종류의 문제에 대한 정말 광범위한 FAQ 페이지가 있습니다. 이 페이지는 Wiki에서만 발견했습니다(TS를 사용한 지 3년).

이를 기준으로 삼아 귀하의 응답과 함께 기본 웹사이트로 끌어오기 시작할 수 있습니다.

구문 강조 표시 추가

네 동의합니다. 감사합니다!

전반적으로, 우리는 이들 중 많은 부분을 적극적으로 탐색하거나 작업하고 있다고 생각합니다. 문서 작업을 계속하면서 더 많은 피드백을 받을 수 있습니다!

멋진 작업 감사합니다 @orta !

Playground 편집기에서 별도의 환경을 만드는 대신 VSCode tsconfig 환경을 차용/개선/협업하는 것은 어떻습니까?

놀이터를 더 좋게 만들고 VSCode의 기존 경험은 이미 절반 수준입니다.

무슨 말씀이신지 잘 모르겠습니다. VS Code의 자동 완성 JSON 스키마 기능이 마음에 드시나요? JSON 편집기 부분에 포함할 계획이었지만 레이블이 있는 GUI로 모든 옵션에 대한 개요는 모든 옵션을 보고 선택하고 선택할 수 있는 유용한 방법입니다.

@orta 새 핸드북이 공식 핸드북이 되면 현재 핸드북의 섹션을 가리키는 URL이 깨지나요? 아니면 새 핸드북이 다른 URL에 있습니까? 지난 몇 년 동안 SO 답변에 핸드북 링크를 많이 넣었기 때문에 궁금합니다. (일반 문서 마이그레이션 계획에 대해 이야기할 더 나은 문제나 위치가 있습니까?)

@orta @jcalz 같은 질문을 하고 있었는데 2.5K가 넘는 SO 답변이 있는데 링크가 있는 모든 답변을 찾고 모두 업데이트하는 것은 실현 가능하지 않습니다. 이상적으로는 조각이 있는 링크가 계속 작동하고 새 위치로 리디렉션됩니다. 필요한 경우 매핑을 도와드릴 의향이 있습니다.

예, 저는 URI 를

핸드북에 대한 새 URL 루트를 사용하고(예: docs/handbook/x.html 아니지만 아마도 /handbook/x.html ) 이전 페이지를 다음 지도를 통해 가장 가까운 페이지로 리디렉션할 것입니다. 몇가지 종류.

이 저장소의 모든 github 레이블이 의미하는 바를 알고 싶습니다. 그들 중 일부는 자명하지만 다른 것들은 그렇지 않습니다.

예를 들어, "제안 필요"는 나에게 명확하지 않습니다. 모든 레이블에 이미 일부 레이블과 같이 더 긴 설명이 있으면 도움이 됩니다.

_specific_ 컴파일러 옵션에 대한 문서에 연결할 수 없습니다.

우리 팀은 TypeScript에 대해 상대적으로 새롭기 때문에 우리의 tsconfig.json 는 자주 변경되며 종종 사람들에게 특정 컴파일러 옵션에 대한 문서, 즉 다음과 같은 형식으로 안내하고 싶습니다.

https://www.typescriptlang.org/docs/handbook/compiler-options.html#strict-null-checks
(or)
https://www.typescriptlang.org/docs/handbook/compiler-options.html#strictNullChecks

이와 같은 링크는 작동하지 않지만 작동하고 싶습니다.

현재 해당 페이지에서 볼 수 있는 유일한 HTML ID는 #compiler-options입니다. 이는 기본적으로 맨 위에 있기 때문에 그다지 유용하지 않습니다. 그러나 각 옵션에 대한 ID가 있으면 사람들이 페이지의 원하는 부분.

태그: compiler

@Tyler-Murphy 지금 수정했습니다.

@ssalka - 예, 새로운 tsconfig 문서에 포함될 좋은 호출

--

이 문제를 닫고 앞으로 핸드북과 새 사이트에 더 들어가면 같은 전제로 새 문제를 다시 열겠습니다 👍

타이프스크립트 플레이그라운드:
미칠 것 같지만 프로젝트를 저장하고 공유할 수 있는 간단한 '공유' 옵션을 찾을 수 없습니다(예: github 문제에 추가).
'내보내기' 아래에 모든 링크가 표시되지만 '공유'는 표시되지 않습니다.

타이프스크립트 플레이그라운드:
미칠 것 같지만 프로젝트를 저장하고 공유할 수 있는 간단한 '공유' 옵션을 찾을 수 없습니다(예: github 문제에 추가).
'내보내기' 아래에 모든 링크가 표시되지만 '공유'는 표시되지 않습니다.

예: 플레이그라운드 링크

새로운 사이트는 정말 좋아 보입니다! 그러나 나는 이 요청 (컴파일러 옵션에 대한 앵커 링크)이 😕에서 이루어지지 않았다는 것을 알아차렸습니다.

정말 쉽게 수용할 수 있는 요청이 될 것 같고 신규 이민자들에게 많은 도움이 될 것 같습니다. 향후 업데이트에서 볼 수 있기를 바랍니다!