Merge pull request #18 from schoero/development

chore(release): v0.2.8

.cspell.json

@@ -1,11 +1,11 @@
 {
-  "import": [
-    "@schoero/cspell-config"
-  ],
   "ignorePaths": [
     "schemas",
     "local"
   ],
+  "import": [
+    "@schoero/configs/cspell"
+  ],
   "words": [
     "anchortext",
     "changelogen",
@@ -18,6 +18,7 @@
     "testfunctionparam",
     "testfunctiontparam",
     "testt",
+    "tinyhighlight",
     "tsdoc",
     "TSJS",
     "typeguards",

.markdownlint.jsonc

@@ -1,3 +1,3 @@
 {
-  "extends": "@schoero/markdownlint-config"
+  "extends": "@schoero/configs/markdownlint"
 }

.vscode/launch.json

@@ -1,7 +1,10 @@
 {
   "configurations": [
     {
-      "args": ["run", "${relativeFileDirname}/${fileBasenameNoExtension}"],
+      "args": [
+        "run",
+        "${relativeFileDirname}/${fileBasenameNoExtension}"
+      ],
       "autoAttachChildProcesses": true,
       "console": "integratedTerminal",
       "name": "debug current test file",
@@ -12,7 +15,10 @@
       "type": "node"
     },
     {
-      "args": ["run", "${relativeFileDirname}/${fileBasenameNoExtension}"],
+      "args": [
+        "run",
+        "${relativeFileDirname}/${fileBasenameNoExtension}"
+      ],
       "autoAttachChildProcesses": true,
       "console": "integratedTerminal",
       "name": "debug current test file with node internals",

.vscode/settings.json

@@ -16,6 +16,7 @@
   "[typescript]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
+  "eslint.experimental.useFlatConfig": true,
   "eslint.validate": ["javascript", "typescript", "json", "jsonc", "json5", "yaml"],
   "editor.formatOnSave": false,
 
@@ -26,7 +27,8 @@
   "explorer.fileNesting.enabled": true,
   "explorer.fileNesting.expand": false,
   "explorer.fileNesting.patterns": {
-    "*.ts": "$(capture).test.ts,$(capture).test.snap,$(capture).test-d.ts"
+    "*.ts": "$(capture).test.ts,$(capture).test.snap,$(capture).test-d.ts",
+    "*.js": "$(capture).test.js,$(capture).cjs,$(capture).mjs,$(capture).d.ts,$(capture).d.ts.map,$(capture).js.map"
   },
 
   // ES module import
@@ -40,7 +42,6 @@
   // Markdown
   "[markdown]": {
     "editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
-    "editor.formatOnSave": true,
     "editor.rulers": [
       40,
       80,
@@ -51,15 +52,15 @@
 
   // VSCode
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true,
-    "source.fixAll.markdownlint": true,
-    "source.organizeImports": false
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.markdownlint": "explicit",
+    "source.organizeImports": "never"
   },
   "editor.rulers": [
     119
   ],
   "search.exclude": {
     "lib": true
   },
-  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

README.md

@@ -23,7 +23,7 @@
 
 unwritten is a cli tool to automatically generate documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler to extract types and relevant information.
 
-> **Warning**
+> [!WARNING]
 >
 > This project is at a really early stage and currently under heavy development. It is not feature complete and it may not or only partially work with your project. You have been warned.
 
@@ -68,6 +68,9 @@ unwritten <path/to/entry-file.ts> [options]
 --silent                                # Disables any console output.
 -s
 
+--debug                                 # Enables verbose console output.
+-d
+
 --version                               # Returns the installed unwritten
 -v                                      # version.
 ```

changelog.config.js

@@ -0,0 +1 @@
+export { default } from "@schoero/configs/changelogen";