feat: wiki/translate-glossary.md auto generation using husky and lint-staged (#971 #926)

[lumirlumir]

안녕하세요😊 husky 및 lint-staged를 이용한 wiki/translate-glossary.md 문서 생성 자동화를 진행하였습니다. (#971 #926)

주요 수정 내역은 아래와 같습니다.

1. .gitignore

   • 처음에는 github actions를 이용한 문서 생성 자동화를 진행하고자, wiki/textlint/translate-glossary.md 파일을 .gitignore에 등록하였습니다. (원래 의도는 자동 생성되는 파일을 .gitignore에 등록하여 임의로 commit 하지 못하게 하기 위함이었습니다.)
   • 하지만, github actions를 이용하기 보다는 husky와 lint-staged를 이용하는 편이 비용효율면에서 좋을 거 같아, 문서 생성 자동화 방법을 바꿔 해당 부분을 삭제하였습니다.

2. package.json

   • scripts의 textlint-docs에 && git add wiki/translate-glossary.md를 추가하여, 문서 자동 생성이 성공한 경우 해당 파일이 자동으로 stage에 올라가도록 설정하였습니다.
   • textlint/data/rules/translateGlossary.js 또는 textlint/generators/genTranslateGlossaryDocs.js 파일이 변경되어 stage에 올라간 경우에만, pre-commit hook을 통해 yarn textlint-docs 명령어를 실행하게 하였습니다.

3. textlint/generators/genTranslateGlossaryDocs.js

   • 문서 저장경로를 wiki/textlint에서 wiki로 변경하였습니다. 이는 기존의 wiki의 내용들을 wiki의 서브 디렉토리에 넣기보다는 디렉토리에 직접 넣는 것이 좀 더 의미상 명확할 것 같기 때문입니다.
   • blockQuote를 만드는 메소드를 추가하였습니다.
   • 문서의 임의 수정을 방지하기 위해 '해당 문서는 `textlint/data/rules/translateGlossary.js` 파일을 기반으로 자동 생성되므로, 임의 수정을 금지합니다.' 라는 문구를 추가하였습니다.

4. wiki/translate-glossary.md

   • 자동 생성된 문서입니다.

Progress

• 번역 초안 작성 (Draft translation)
• 공통 스타일 가이드 확인 (Check the common style guide)
• 모범사례 확인 (Check best practices)
• 용어 확인 (Check the term)
• 맞춤법 검사 (Spelling check)
• 리뷰 반영 (Resolve reviews)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
ko-legacy-reactjs-org	⬜️ Ignored (Inspect)	Visit Preview		Jul 18, 2024 3:46am

[github-actions]

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

[hg-pyun]

리뷰가 늦었습니다🙇‍♂️, 깔끔하게 작업해주셔서 별다른 코멘트는 없습니다 👍 action을 써도 괜찮지 않았을까 싶었는데 지금 방법도 좋은 것 같네요!