리버티게임에서 사용하는 스크립트를 타입스크립트로도 개발할 수 있도록 전역 함수 및 변수나 소도구의 타입 정의를 배포합니다.
아직 모든 함수나 변수의 타입이 정의된 것은 아닙니다. 타입이 필요할 때마다 그때그때 정의하고 있으며, 필요한 타입이 없으시다면 이슈를 작성하시거나, 직접 정의 코드를 작성해서 PR을 요청하시기 바랍니다.
이 패키지는 npm을 활용해서 간단하게 불러올 수 있습니다. 아래와 같은 터미널 명령어를 통해 이 패키지를 설치하세요.
npm i hsl0/libertygame-types --save-dev이 패키지에는 미디어위키 타입과 jQuery 타입도 포함되어 있으므로 별도의 패키지를 설치할 필요가 없습니다.
하지만 이 패키지는 @types/에 속한 패키지가 아니므로 설치만으로 자동으로 추가되지 않습니다. 따라서 별도로 추가해 주셔야 합니다. tsconfig.json에서 include에 node_modules/libertygame-types를 추가해야 합니다.
그리고 extends에 libertygame-types/recommended.json을 추가할 것을 권장합니다. 이는 tsconfig를 미디어위키와 리버티게임의 환경에 맞추고 아래 필수 셋팅을 자동으로 해줍니다.
{
"extends": "libertygame-types/recommended.json",
"include": ["node_modules/libertygame-types"]
}recommended.json을 사용하는 대신 tsconfig를 수동으로 설정할 경우, 적어도 compilerOptions의 moduleResolution 옵션은 Node 계열로 설정해야 합니다. 만약 module이 CommonJS나 Node 계열로 설정되어있다면 생략하셔도 좋습니다.
{
"compilerOptions": {
"moduleResoultion": "node"
},
"include": ["node_modules/libertygame-types"]
}이 패키지에는 별도의 패키지가 없는 리버티게임의 전역 함수나 변수 및 소도구만 포함되어 있으며, jQuery와 미디어위키 코어를 제외한 별도 패키지가 있는 타입 정의는 포함하지 않습니다. 그 대신 별도의 타입 패키지를 직접 설치하실 수 있습니다.
다음은 리버티게임과 미디어위키에서 사용하는 스크립트에 대한 타입 패키지들의 목록입니다.
이 레포지트리를 편집하기 전에 CONTRIBUTING.md 문서를 먼저 읽어주세요.
라이선스는 아직 확정되지 않아 변경될 수 있습니다. 현재 리버티게임의 라이선스인 CC BY-NC-SA 4.0을 임시로 적용하고 있습니다.