fix: build index from names in comment and support excluding

Arcath · Mar 23, 2023 · 5244512 · 5244512
1 parent 413cce3
commit 5244512
Show file tree

Hide file tree

Showing 42 changed files with 339 additions and 2 deletions.
diff --git a/Readme.md b/Readme.md
@@ -19,3 +19,15 @@ yarn add @arcath/utils
 ## More
 
 A full list of functions and classes can be found at https://utils.arcath.net
+
+## Developing
+
+Each function/class should have its own file with a spec file along side.
+Similar functions can be in the same file e.g. `increment` and `decrement`.
+
+The index is generated using a comment at the bottom of the file to define the
+exports. For example
+
+```js
+// {increment, decrement}
+```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
     "kcd-scripts": "^13.0.0",
     "prettier": "^2.8.6",
     "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
     "typedoc": "^0.23.28",
     "typescript": "^5.0.2"
   },