"strict: true"로 TypeScript를 사용하려는 모든 개발자를 위한 것입니다.

안녕하세요, TypeScript 유형 오류가 있는 코드에 자동으로 추가@ts-expect-error하는 cli 도구를 만들었습니다.
이 기사에서는 이 도구를 사용하는 방법을 설명합니다.

https://www.npmjs.com/package/suppress-ts-errors

사용하는 방법

tsconfig.json 가 포함된 프로젝트에서 명령을 실행하기만 하면 됩니다.
느슨한 유형 검사를 사용하는 경우 tsconfig.json을 편집하여 유형 검사를 강화합니다(예: strict: true ).

$ npx suppress-ts-errors

이것만으로도 TypeScript 프로젝트에서 유형 오류가 있는 위치에 주석@ts-expect-errors이 추가되고 유형 오류 발생이 억제됩니다.



물론 tsx 코드는 tsx 에 맞춰 주석 형식으로 추가됩니다.

또한 vue 하위 명령을 사용하여 Vue의 SFC 부분에서 유형 오류를 대상으로 지정할 수 있습니다.

$ npx suppress-ts-errors vue "./src/**/*.vue"

이 옵션을 사용하면 유연한 설정도 가능합니다.


옵션
기본
설명


-t, --tsconfig-경로./tsconfig.jsontsconfig.json의 경로입니다.

-c, --설명 유형1삽입된 주석 유형 선택. 1는 @ts-expect-error이고, 2는 @ts-ignore입니다.

-e, --오류 코드true주석에 오류 코드를 추가하십시오. 예를 들어 TS2345.

필요한 이유

현재 타입 체킹이 강화되지 않은(cannot set strict: true ) 프로젝트를 진행하고 있는데, 상황을 개선하고 싶습니다.

일반적으로 "기존의 모든 타입 오류를 수정한 다음 타입 검사를 더 엄격하게"하는 것이라고 생각하지만 현재 프로젝트는 원래 JavaScript로 작성하고 TypeScript로 마이그레이션했기 때문에 기존 오류가 너무 많았고 많은 작업이 필요했을 것입니다. 그것들을 모두 해결하기 위한 공수.

그 동안 새로운 기능이 빠르게 개발되고 있었고 유형 오류가 포함된 새로운 코드를 작성하기가 쉬웠습니다. 이 문제를 해결하기 위해 먼저 새로 추가된 코드가 형식 보호되도록 형식 검사를 강화한 다음 해당 상태에서 안전하게 기존 코드 수정을 시작하려고 했습니다.
이를 위해 기존의 모든 유형 오류에 주석(@ts-expect-error 또는 @ts-ignore)을 추가하여 무효화해야 했으며 이 프로세스를 자동화하기 위해 이 CLI 도구를 개발했습니다.

사용된 기술

타입스크립트

ts-morph

vitest

모든 코드는 GitHub에서 사용할 수 있습니다.

https://github.com/kawamataryo/suppress-ts-errors

그게 다야!

그럼 끝!

읽어 주셔서 감사합니다.
필요하시면 쪽지 주세요.

https://github.com/kawamataryo/suppress-ts-errors