style: simplify formatting with deno, part 1: doc/ (cataclysmbnteam…

…#3108) * chore: simplify deno config used flat config from v1.33.0 see: https://deno.com/blog/v1.33#flatter-denojson-configuration * docs(README): convert invalid table to badges * docs: JSON and Markdown formatting guidelines * style: format all markdown files with deno * ci(autofix.ci): format markdown files with deno
mythosmod · Sep 5, 2023 · adeda63 · adeda63
1 parent c568122
commit adeda63
Show file tree

Hide file tree

Showing 61 changed files with 9,671 additions and 7,400 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -5,7 +5,7 @@ NOTE: Please grant permission for repository maintainers to edit your PR.  It is
 
 CODE STYLE: please follow below guide.
 JSON: https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/doc/JSON_STYLE.md
-C++: https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/doc/CODE_STYLE.md
+C++ and Markdown: https://github.com/cataclysmbnteam/Cataclysm-BN/blob/upload/doc/CODE_STYLE.md
 
 !!!!!!!!!! WARNING !!!!!!!!!!
 

diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml
@@ -16,10 +16,17 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: astyle
-        run: |
-          sudo apt-get install astyle
-          make astyle
+      - run: sudo apt-get install astyle
+
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+
+      - name: format C++ files
+        run: make astyle
+
+      - name: format markdown files
+        run: deno fmt
 
       - name: json formatting
         run: make style-all-json-parallel RELEASE=1

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,24 +1,34 @@
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers
+pledge to making participation in our project and our community a harassment-free experience for
+everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity
+and expression, level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
 1. Assume other participants are posting in good faith, even if you disagree with what they say.
 2. Make an effort to treat other participants with respect.
-    1. Do not take a harsh tone towards other participants, and especially don't make personal attacks against them.
-    2. Recognize that criticism of your statements is not a personal attack on you.
-    3. Avoid statements about the presumed typical desires, capabilities or actions of some demographic group.
+   1. Do not take a harsh tone towards other participants, and especially don't make personal
+      attacks against them.
+   2. Recognize that criticism of your statements is not a personal attack on you.
+   3. Avoid statements about the presumed typical desires, capabilities or actions of some
+      demographic group.
 3. Be especially kind to other contributors when saying they made a mistake.
-4. Don't argue unceasingly for your preferred course of action when a decision for some other course has already been made.
-5. If other participants complain about the way you express your ideas, please make an effort to cater to them.
+4. Don't argue unceasingly for your preferred course of action when a decision for some other course
+   has already been made.
+5. If other participants complain about the way you express your ideas, please make an effort to
+   cater to them.
 6. Don't raise unrelated political issues.
-7. If you feel these standards are being violated, please alert the project's "ombudsman" Jakob at lamandus@hotmail.com
+7. If you feel these standards are being violated, please alert the project's "ombudsman" Jakob at
+   lamandus@hotmail.com
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][CoC homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][CoC version] and the [GNU Kind Communications Guidelines][GKCG homepage].
-
+This Code of Conduct is adapted from the [Contributor Covenant][CoC homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][CoC version] and the
+[GNU Kind Communications Guidelines][GKCG homepage].
 
 [CoC homepage]: http://contributor-covenant.org
 [CoC version]: http://contributor-covenant.org/version/1/4/

diff --git a/ISSUES.md b/ISSUES.md
@@ -2,24 +2,28 @@
 
 ## How to create new issues properly
 
-GitHub issues are used for everything from bug reporting to suggesting long-term ideas. You can make everything run much smoother by following some simple rules.
+GitHub issues are used for everything from bug reporting to suggesting long-term ideas. You can make
+everything run much smoother by following some simple rules.
 
 ### Rule zero
 
 Always give your issue a meaningful title as this is the first thing anyone will see.
 
-Note: `[CR]` and `[WIP]` "tags" are meaningful only for PRs. All open issues by definition are request for comments and work in progress.
+Note: `[CR]` and `[WIP]` "tags" are meaningful only for PRs. All open issues by definition are
+request for comments and work in progress.
 
 ### Bug reports
 
-Before you submit a bug always search the current list of issues to see if it has been reported already.
+Before you submit a bug always search the current list of issues to see if it has been reported
+already.
 
 Your bug report has to include:
 
 - On what OS did you experience the problem (Windows, Linux, OS X etc.)
 - What version were you playing:
- - Tiles or Curses (text-based)
- - Version string (preferably full version e.g. "0.C-4547-g3f1c109", or Jenkins build number e.g. 3245)
+- Tiles or Curses (text-based)
+- Version string (preferably full version e.g. "0.C-4547-g3f1c109", or Jenkins build number
+  e.g. 3245)
 - Description of the problem written in a way that enables anyone to try and recreate it
 
 Your bug report may include:
@@ -32,24 +36,42 @@ Bonus points for:
 - Checking if the bug exists under latest experimental build
 - Checking if it is OS specific
 
-The OS and BN version are very important - with the pace of changes here it is possible the bug you have encountered has already been fixed. After that reproducibility is the key, so write your report with all the necessary details.
+The OS and BN version are very important - with the pace of changes here it is possible the bug you
+have encountered has already been fixed. After that reproducibility is the key, so write your report
+with all the necessary details.
 
 ### Enhancements and addition ideas
 
-We have hundreds of issues open - most of them are ideas and suggestions. If you have a general idea or anything that can't be easily described in terms of *current* code changes you'd be better off suggesting it in the appropriate section of [the forum](https://discourse.cataclysmdda.org/). You'll also get much broader exposure for your idea there. After developing a polished idea on the forum, it should be easy to make a GitHub issue for it.
+We have hundreds of issues open - most of them are ideas and suggestions. If you have a general idea
+or anything that can't be easily described in terms of _current_ code changes you'd be better off
+suggesting it in the appropriate section of [the forum](https://discourse.cataclysmdda.org/). You'll
+also get much broader exposure for your idea there. After developing a polished idea on the forum,
+it should be easy to make a GitHub issue for it.
 
-Please first search if something like what you have on mind has been already proposed. If so, feel free to join the discussion! If your idea is related but sufficiently different, open a new issue and refer to the older discussion (use GitHub's `#issue_number` reference system).
+Please first search if something like what you have on mind has been already proposed. If so, feel
+free to join the discussion! If your idea is related but sufficiently different, open a new issue
+and refer to the older discussion (use GitHub's `#issue_number` reference system).
 
 Remember to take part in the discussion of your suggestions.
 
 ### Questions
 
-You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. [COMPILING.md](doc/COMPILING/COMPILING.md) if you have problems building.
+You should direct your questions to the forum or ask on IRC. You should also read the included
+documentation and additional text files, e.g. [COMPILING.md](doc/COMPILING/COMPILING.md) if you have
+problems building.
 
 ## Bounties
 
-Placing a bounty *does not* necessarily mean that change will be incorporated into the main game. Please coordinate in the issue you intend to place a bounty on to determine if it is a change the project will accept, and keep in mind that placing a bounty will not confer special status on the issue. A good way of thinking about bounties is as encouragement for contributors to work on a particular issue, and certainly not as "paying for features".
+Placing a bounty _does not_ necessarily mean that change will be incorporated into the main game.
+Please coordinate in the issue you intend to place a bounty on to determine if it is a change the
+project will accept, and keep in mind that placing a bounty will not confer special status on the
+issue. A good way of thinking about bounties is as encouragement for contributors to work on a
+particular issue, and certainly not as "paying for features".
 
 ## Issue resolution
 
-We do not assign people to issues. If you plan to work on a bug fix or a validated idea feel free to just comment about that. Actual PRs are of much greater value than any assignments. In general the first correct PR about something will be the PR that will get merged, but remember: we are using Git - you can collaborate with someone else easily by sending them patches or PRs against their PR branch.
+We do not assign people to issues. If you plan to work on a bug fix or a validated idea feel free to
+just comment about that. Actual PRs are of much greater value than any assignments. In general the
+first correct PR about something will be the PR that will get merged, but remember: we are using
+Git - you can collaborate with someone else easily by sending them patches or PRs against their PR
+branch.
diff --git a/README.ko.md b/README.ko.md
@@ -3,8 +3,7 @@
 <header align="center">
   <a><img src="doc/img/readme-title.png" title="우측 위부터 시계방향으로 Chaosvolt (x2), ExecutorBill, scarf005의 스크린샷"></a>
 
-  [![en][icon-en]][en]
-  [![ko][icon-ko]][ko]
+[![en][icon-en]][en] [![ko][icon-ko]][ko]
 
 </header>
 
@@ -13,36 +12,48 @@
 [ko]: ./README.ko.md
 [icon-ko]: https://img.shields.io/badge/lang-ko-orange?style=flat-square
 
-
-
 카타클리즘: 밝은 밤은 포스트 아포칼립스 세계에서 벌어지는 공상과학 로그라이크입니다.
 
-"좀비 게임"이라 불리기도 하지만, 그뿐만이 아닙니다. 험난하고, 절차적으로 생성되는 세계에서 살아남아야 합니다. 이제는 죽어버린 문명의 잔해를 뒤져 음식, 장비, 운이 좋다면 연료가 가득 찬 차량을 찾아 탈출하세요.
+"좀비 게임"이라 불리기도 하지만, 그뿐만이 아닙니다. 험난하고, 절차적으로 생성되는 세계에서
+살아남아야 합니다. 이제는 죽어버린 문명의 잔해를 뒤져 음식, 장비, 운이 좋다면 연료가 가득 찬 차량을
+찾아 탈출하세요.
 
-좀비, 거대 곤충, 킬러 로봇, 더 이상하고 치명적인 것들, 그리고 당신이 가진 것을 노리는 이들까지, 강력한 괴물들과 싸우거나 도망치세요.
+좀비, 거대 곤충, 킬러 로봇, 더 이상하고 치명적인 것들, 그리고 당신이 가진 것을 노리는 이들까지,
+강력한 괴물들과 싸우거나 도망치세요.
 
 카타클리즘을 멈출 방법을 찾거나.... 가장 강력한 괴물 중 하나가 되세요.
 
-> 카타클리즘: 밝은 밤(Cataclysm: Bright Nights)은 카타클리즘: 어두운 나날(Cataclysm: Dark Days Ahead)의 포크입니다. [위키](https://github.com/cataclysmbnteam/cataclysm-BN/wiki/Changes-so-far)에서 어떤 차이가 있는지 확인하세요.
+> 카타클리즘: 밝은 밤(Cataclysm: Bright Nights)은 카타클리즘: 어두운 나날(Cataclysm: Dark Days
+> Ahead)의 포크입니다.
+> [위키](https://github.com/cataclysmbnteam/cataclysm-BN/wiki/Changes-so-far)에서 어떤 차이가 있는지
+> 확인하세요.
 
 ## 다운로드
 
-[![안정판][stable-releases-badge]][stable-releases] [![최신 릴리즈][all-releases-badge]][all-releases]
+### 실행 파일
+
+[![Stable][stable-releases-badge]][stable-releases] [![Recent][all-releases-badge]][all-releases]
 
-[stable-releases]: https://github.com/cataclysmbnteam/cataclysm-BN/releases/tag/cbn-0.3
-[stable-releases-badge]: https://img.shields.io/github/v/release/cataclysmbnteam/cataclysm-BN?style=for-the-badge&color=success&label=stable
-[all-releases]: https://github.com/cataclysmbnteam/Cataclysm-BN/releases?q=prerelease%3Atrue&expanded=true
-[all-releases-badge]: https://img.shields.io/github/v/release/cataclysmbnteam/cataclysm-BN?style=for-the-badge&color=important&label=Latest%20Release&include_prereleases&sort=date
+### 소스 코드
 
-| [소스 코드][source-zip-archive] | [저장소에서 클론하기][clone] |
-| :-----------------------------: | :--------------------------: |
+[![Source Code][source-badge]][source] [![Zip Archive][clone-badge]][clone]
 
-[source-zip-archive]: https://github.com/cataclysmbnteam/cataclysm-BN/archive/master.zip "소스 코드를 .zip 아카이브로 다운로드할 수 있습니다"
-[clone]: https://github.com/cataclysmbnteam/cataclysm-BN/ "GitHub 저장소에서 클론할 수 있습니다"
+[stable-releases]: https://github.com/cataclysmbnteam/Cataclysm-BN/releases/latest "안정판 실행 파일 내려받기"
+[stable-releases-badge]: https://img.shields.io/github/v/release/cataclysmbnteam/Cataclysm-BN?style=for-the-badge&color=success&label=안정판
+[all-releases]: https://github.com/cataclysmbnteam/Cataclysm-BN/releases?q=prerelease%3Atrue&expanded=true "실험판 실행 파일 내려받기"
+[all-releases-badge]: https://img.shields.io/github/v/release/cataclysmbnteam/Cataclysm-BN?style=for-the-badge&color=important&label=최신%20실험판&include_prereleases&sort=date
+[source]: https://github.com/cataclysmbnteam/Cataclysm-BN/archive/master.zip "소스 코드를 .zip 아카이브로 다운로드할 수 있습니다"
+[source-badge]: https://img.shields.io/badge/ZIP%20아카이브로%20내려받기-black?style=for-the-badge&logo=github
+[clone]: https://github.com/cataclysmbnteam/Cataclysm-BN/ "GitHub 저장소에서 클론할 수 있습니다"
+[clone-badge]: https://img.shields.io/badge/저장소에서%20클론하기-black?style=for-the-badge&logo=github
 
 ## 빌드하기
 
-[COMPILING.md](doc/COMPILING/COMPILING.md)를 참고하세요 - 리눅스, OS X, 윈도우즈와 BSD에서 빌드하기 위한 일반적인 정보부터 보다 자세한 레시피가 담겨있습니다. [COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md)에서 지원하는 컴파일러를 확인할 수 있습니다. 더 자세한 정보는 [doc/](https://github.com/cataclysmbnteam/cataclysm-BN/tree/upload/doc)에서도 찾아볼 수 있습니다.
+[COMPILING.md](doc/COMPILING/COMPILING.md)를 참고하세요 - 리눅스, OS X, 윈도우즈와 BSD에서 빌드하기
+위한 일반적인 정보부터 보다 자세한 레시피가 담겨있습니다.
+[COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md)에서 지원하는 컴파일러를 확인할 수 있습니다.
+더 자세한 정보는 [doc/](https://github.com/cataclysmbnteam/cataclysm-BN/tree/upload/doc)에서도
+찾아볼 수 있습니다.
 
 또한 다음 빌드 가이드도 있습니다.
 
@@ -52,17 +63,20 @@
 
 ## 기여하기
 
-> 카타클리즘: 밝은 밤은 크리에이티브 커먼즈 저작자표시-동일조건변경허락 3.0 라이선스로 개발되고 있습니다. 소스 코드와 게임 내용물은 어떠한 목적으로든 사용, 수정, 재배포가 가능합니다. 자세한 내용은 <http://creativecommons.org/licenses/by-sa/3.0/>를 참고하세요.
-> 일부 코드는 프로젝트와 함께 배포되지만, 다른 소프트웨어 라이선스에 따라 배포됩니다. 다른 소프트웨어 라이선스에 따라 배포되는 파일들은 각 파일에 라이선스 공지가 포함되어 있습니다.
+> 카타클리즘: 밝은 밤은 크리에이티브 커먼즈 저작자표시-동일조건변경허락 3.0 라이선스로 개발되고
+> 있습니다. 소스 코드와 게임 내용물은 어떠한 목적으로든 사용, 수정, 재배포가 가능합니다. 자세한
+> 내용은 <http://creativecommons.org/licenses/by-sa/3.0/>를 참고하세요. 일부 코드는 프로젝트와 함께
+> 배포되지만, 다른 소프트웨어 라이선스에 따라 배포됩니다. 다른 소프트웨어 라이선스에 따라 배포되는
+> 파일들은 각 파일에 라이선스 공지가 포함되어 있습니다.
 
 [CONTRIBUTING.ko.md](./doc/CONTRIBUTING.ko.md)에서 자세한 내용을 확인할 수 있습니다.
 
 ## 커뮤니티
 
-| [저장소][repo] | [토론][discussion] | [공식 저장소][discord] | [BN 채널@모딩 커뮤니티][modding] |
-| :------------: | :----------------: | :--------------------: | :------------------------------: |
+[![Discussions](https://img.shields.io/badge/포럼에서%20토론하기-black?style=for-the-badge&logo=github)][discussion]
+[![Discord](https://img.shields.io/discord/830879262763909202?style=for-the-badge&logo=discord&label=공식%20디스코드%20서버)][discord]
+[![Discussions](https://img.shields.io/badge/CDDA%20모딩%20커뮤니티-green?style=for-the-badge&logo=discord)][modding]
 
-[repo]: https://github.com/cataclysmbnteam/cataclysm-BN
 [discussion]: https://github.com/cataclysmbnteam/cataclysm-BN/discussions
 [discord]: https://discord.gg/XW7XhXuZ89
 [modding]: https://discord.gg/B5q4XCa "비공식 DDA모딩 커뮤니티에도 BN 채널이 있습니다."
@@ -71,19 +85,23 @@
 
 #### 튜토리얼이 있나요?
 
-메인 메뉴의 **Special** 메뉴에서 찾을 수 있습니다. (코드 변경으로 인해 튜토리얼이 작동하지 않을 수 있습니다.) 게임 내에서도 `?` 키를 눌러 도움 메뉴에 접근할 수 있습니다.
+메인 메뉴의 **Special** 메뉴에서 찾을 수 있습니다. (코드 변경으로 인해 튜토리얼이 작동하지 않을 수
+있습니다.) 게임 내에서도 `?` 키를 눌러 도움 메뉴에 접근할 수 있습니다.
 
 #### 단축키를 어떻게 바꾸나요?
 
-`?` 키를 누르고 `1` 키를 눌러 전체 단축키 목록을 확인할 수 있습니다. `+` 키를 눌러 단축키를 추가할 수 있고, `a-w` 키를 눌러 해당 행동을 선택한 후, 할당할 키를 누르면 됩니다.
+`?` 키를 누르고 `1` 키를 눌러 전체 단축키 목록을 확인할 수 있습니다. `+` 키를 눌러 단축키를 추가할
+수 있고, `a-w` 키를 눌러 해당 행동을 선택한 후, 할당할 키를 누르면 됩니다.
 
 #### 새 세계를 어떻게 시작하나요?
 
 **World** 메뉴에서 새 세계를 생성할 수 있습니다. **Create World**를 선택하세요.
 
 #### 버그를 발견했어요. 어떻게 해야 하나요?
 
-디버그 메뉴에서 [버그 리포트](https://github.com/cataclysmbnteam/cataclysm-BN/issues/new?template=bug_report.yml)를 제출할 수 있습니다.
+디버그 메뉴에서
+[버그 리포트](https://github.com/cataclysmbnteam/cataclysm-BN/issues/new?template=bug_report.yml)를
+제출할 수 있습니다.
 
 게임 내에서 `Submit a bug report on github`를 실행하여 이슈를 제출할 수 있습니다.
 
@@ -97,4 +115,5 @@
 
 #### 제안을 하고 싶어요. 어떻게 해야 하나요?
 
-[토론 페이지](https://github.com/cataclysmbnteam/cataclysm-BN/discussions/categories/ideas)에서 아이디어를 제안할 수 있습니다. 새 기능, 포팅 요청, 모드 아이디어, 무엇이든지요!
+[토론 페이지](https://github.com/cataclysmbnteam/cataclysm-BN/discussions/categories/ideas)에서
+아이디어를 제안할 수 있습니다. 새 기능, 포팅 요청, 모드 아이디어, 무엇이든지요!