@types배포하기

타입스크립트

이제 라이브러리를 배포해서 잘 사용하나 싶었는데 type에서 문제가 되더라구요
type은 배포하기가 조금 까다로운데 pr을 보내야만 배포가 가능하여 무섭지만 보내봤습니다.

https://github.com/DefinitelyTyped/DefinitelyTyped

위의 깃허브 저장소로 가서 fork를 하나 만듭니다.
공식 문서의 적힌대로 하나씩 해나갈겁니다.

1. 나의 라이브러리 타입 프로젝트 생성

npm info <패키지명> 을 입력하여 타입이 있는지 확인을 해봅니다.
없으면
npx dts-gen --dt --name <패키지명> --template module
을 입력하여 types 폴더안에 만듭니다.
( dts-gen 명령어를 사용 할 수 있는 라이브러리를 설치해 두어야함)

2. 선언 및 정의

• tsconfig.json 수정
  기본적으로 작성된 파일이 있는데 수정되어야 할 설정이 있으면 수정하시면 됩니다.

• index.d.ts 파일에서 함수 및 변수 타입을 정의 해줍니다.
  다른 폴더를 참고해서 만들시면 됩니다.

주의

파일 상단에 위의 사진처럼 텍스트가 나오는데 지우지 마세요!
글쓴이는 definitions by를 복붙하다보니 지웠는데 npm test할때 에러가 났습니다. 이거 때문에 test가 안될줄 상상도 못했습니다...
그리고 npm test를 하기 위해서는 라이브러리가 배포되어 있어야 합니다

• 테스트 파일 xxx-tests.ts or .tsx파일을 작성합니다.
  테스트 파일을 다 작성하면 꼭 npm run test <패키지명> 을 하여 작성한 테스트 파일이 잘 작동하는지 확인합니다. 전체 검사는 npm run test-all 을 하면 됩니다.

• PR 요청하기
  pull request를 요청하게 되면 설문조사 같은 탬플릿이 나오는데 잘 읽어보고 체크해주시면 됩니다.
  요청을 날리시게 되면 봇이 자동으로 이상이 있는지 없는지 체크후 요청이 성공합니다. 실패 시 다시 수정후 git에 commit을 하게되면 다시 체크후 성공/실패 여부를 알여주게 됩니다.
  그 후 DefinitelyTyped을 담당하는 여러 개발자중 한분이 pr을 확인 후 병합 해준다고 하여 기다리시면 됩니다 :)