build: ensure documentation

.github/workflows/deno.yml

@@ -19,6 +19,17 @@ jobs:
       - run: deno lint
       - run: deno fmt --check
 
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - uses: actions/checkout@v4
+
+      - run: deno cache source/mod.ts
+      - run: deno doc --lint source/mod.ts
+
   test:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -1,4 +1,5 @@
 .vscode
 /*-*.*.*.tgz
 dist
+docs
 node_modules

copy-template-into-existing-project.sh

@@ -23,7 +23,7 @@ echo "everything copied"
 # Replace template name with folder name
 # macOS: add '' after -i like this: sed -i '' "s/…
 sed -i "s/deno-node-module-template/$name/g" package.json LICENSE ./*.md ./**/*.md .github/**/*.yml
-sed -i "s/deno_node_module_template/$denoname/g" ./*.md ./**/*.md
+sed -i "s/deno_node_module_template/$denoname/g" ./*.md ./**/*.md deno.jsonc
 
 deno fmt
 

deno.jsonc

@@ -15,6 +15,7 @@
 	},
 	"exclude": [
 		"./dist/",
+		"./docs/",
 		"./node_modules/"
 	],
 	"fmt": {
@@ -35,5 +36,8 @@
 				"no-sparse-arrays"
 			]
 		}
+	},
+	"tasks": {
+		"doc": "deno doc --html --name=deno_node_module_template source/mod.ts"
 	}
 }

source/README.md

@@ -2,4 +2,5 @@
 
 See the
 [README on GitHub](https://github.com/EdJoPaTo/deno-node-module-template#readme)
-for more information on this package.
+or the
+[documentation on deno.land](https://deno.land/x/deno-node-module-template?doc).

source/mod.ts

@@ -1,3 +1,8 @@
+/**
+ * Exemplary code documentation
+ * @param input defaults to "Glitter"
+ * @returns more rainbows
+ */
 export function moduleName(input: string | undefined): string {
 	if (typeof input !== "string" && input !== undefined) {
 		throw new TypeError(`Expected a string, got ${typeof input}`);