From 11f048870d299439d8cb753abecef9d8e59aa888 Mon Sep 17 00:00:00 2001 From: Teswa Date: Mon, 27 Mar 2023 19:23:59 +0400 Subject: [PATCH] JSDoc attempt --- .github/workflows/main.yml | 4 ++-- jsdoc.json | 43 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 2 deletions(-) create mode 100644 jsdoc.json diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2e30d0c..89bb196 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,7 +13,7 @@ jobs: uses: andstor/jsdoc-action@v1 with: source_dir: ./src - output_dir: ./out - config_file: conf.json + output_dir: ./docs + config_file: jsdoc.json template: minami front_page: README.md \ No newline at end of file diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 0000000..46092bc --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,43 @@ +{ + "source": { + "includePattern": ".+\\.ts(doc|x)?$", + "excludePattern": ".+\\.(test|spec).ts" + }, + "plugins": [ + "plugins/markdown", + "node_modules/jsdoc-babel" + ], + "babel": { + "extensions": [ + "ts", + "tsx" + ], + "ignore": [ + "**/*.(test|spec).ts" + ], + "babelrc": false, + "presets": [ + [ + "@babel/preset-env", + { + "targets": { + "node": true + } + } + ], + "@babel/preset-typescript" + ], + "plugins": [ + "@babel/proposal-class-properties", + "@babel/proposal-object-rest-spread" + ] + }, + "opts": { + "encoding": "utf8", + "destination": "docs/", + "recurse": true, + "verbose": true, + "pedantic": true, + "readme": "./README.md" + } +} \ No newline at end of file