chore: license new scripts under AGPL-3.0-only (#3169)

* chore: move scripts into `scripts/` * feat: output default formatted markdown still needs to be formatted once more as CLI texts aren't checked * fixup! chore: move scripts into `scripts/` * chore: add license for `scripts/` subdirectory
cataclysmbnteam · Sep 22, 2023 · 30d0a3e · 30d0a3e
1 parent 6f24bb3
commit 30d0a3e
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 9 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -2,6 +2,8 @@ Cataclysm is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unpo
 
 Documentation site (doc/*, excluding doc/src/content/docs/*) is licensed under the AGPL 3.0-only license, see doc/LICENSE for text of license.
 
+Scripts (scripts/*) are licensed under the AGPL 3.0-only license, see doc/LICENSE for text of license.
+
 GNU Unifont (data/font/unifont.ttf) is licensed under GNU General Public License v2+ with the GNU font embedding exception. Visit http://unifoundry.com/LICENSE.txt for details.
 
 Terminus Font (data/font/terminus.ttf) is licensed under the SIL Open Font License (see LICENSE-OFL-Terminus-Font.txt).

diff --git a/deno.jsonc b/deno.jsonc
@@ -1,16 +1,14 @@
 {
   "tasks": {
-    "tools": "deno run --watch -A",
-
     "doc": "deno task doc:cli & deno task doc:lua && deno fmt",
-    "doc:cli": "deno run -A ./tools/gen_cli_docs.ts",
+    "doc:cli": "deno run --allow-run=./cataclysm-tiles --allow-write=doc/src/content/docs ./scripts/gen_cli_docs.ts",
     "doc:lua": "./cataclysm-tiles --lua-doc && cp config/lua_doc.md doc/src/content/docs/en/mod/lua/reference/lua.md"
   },
-  "test": { "include": ["./tools"] },
-  "lint": { "include": ["./tools"] },
+  "test": { "include": ["scripts"] },
+  "lint": { "include": ["scripts"] },
   "fmt": {
-    "exclude": ["./doc/dist", "./doc/.astro"],
-    "include": ["./tools", "./doc", "*.md"],
+    "exclude": ["doc/dist", "doc/.astro"],
+    "include": ["scripts", "doc", "*.md"],
     "semiColons": false,
     "lineWidth": 100
   }

diff --git a/tools/front_matter.ts → scripts/front_matter.ts b/tools/front_matter.ts → scripts/front_matter.ts
diff --git a/tools/front_matter_test.ts → scripts/front_matter_test.ts b/tools/front_matter_test.ts → scripts/front_matter_test.ts
diff --git a/tools/gen_cli_docs.ts → scripts/gen_cli_docs.ts b/tools/gen_cli_docs.ts → scripts/gen_cli_docs.ts
@@ -30,7 +30,6 @@ ${desc}.`
 
 export const sectionToMarkdown = ({ title, flags }: Section): string => /*md*/ `
 ## ${title}
-
 ${flags.map(flagToMarkdown).join("\n")}`
 
 const toMarkdown = (text: string): string => {
@@ -56,7 +55,6 @@ The game executable can not only run your favorite roguelike,
 but also provides a number of command line options to help modders and developers.
 
 ---
-
 ${sections}
 `
 }