SRS/tools
2022-04-21 20:29:52 +09:00
..
template doc generate by template 2022-04-21 20:29:52 +09:00
getIssue.ts feat: cli tool 2022-04-21 17:50:24 +09:00
githubType.ts refact: add github api type 2022-04-19 19:53:00 +09:00
printDocument.ts doc generate by template 2022-04-21 20:29:52 +09:00
README.md document is built now 2022-04-21 19:23:36 +09:00

Tools

getIssue

Github token을 받아서 최신 100개의 Issues 들의 내용을 긁어옵니다. 그리고 그 내용을 json으로 출력합니다.

deno run --allow-net --allow-env --allow-write getIssue.ts --token 'YOUR GIHTUB TOKEN'

으로 실행하면 됩니다.

토큰을 발급받기 위해선 다음 링크를 참조하면 됩니다.

인자로 token과 path를 받습니다. token 인자가 지정되어 있지 않으면 GITHUB_TOKEN 환경변수에서 가져옵니다. path가 지정되어있지 않으면 stdout에 출력합니다.

printDocument

json으로 표현된 Github의 Issues를 받아서 template에 따라 문서로 만듭니다.

deno run --allow-read --allow-write printDocument.ts --overall --path ./issues.json --outpath ssr.md

으로 실행하면 됩니다.

다음과 같은 인자를 가집니다:

  • outDir: 지정된 경로에 출력. 설정되지 않으면 stdout에 출력함.
  • issue_path: json 파일 위치. 지정되지 않으면 stdin에서 읽으려고 시도.
  • w, watch: 파일에 변경이 있을 때 자동으로 업데이트.