diff --git a/package.json b/package.json index 45205c49..63affb2d 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "list-tasks": "yarn workspace evolution-legacy run list-tasks", "generate-migration": "knex migrate:make", "reset-submodules": "rimraf transition/ && git submodule init && git submodule update", - "generateSurvey:example": "yarn worspace evolution-generator run generateSurvey --config_path src/examples/generatorExampleConfigs.yaml" + "generateSurvey:example": "yarn worspace evolution-generator run generateSurvey --config_path src/examples/generatorExampleConfigs.yaml", + "jsdoc": "yarn workspace evolution-common run jsdoc" }, "dependencies": {}, "devDependencies": { diff --git a/packages/evolution-common/jsdoc.json b/packages/evolution-common/jsdoc.json new file mode 100644 index 00000000..60214e16 --- /dev/null +++ b/packages/evolution-common/jsdoc.json @@ -0,0 +1,22 @@ +{ + "plugins": ["plugins/markdown"], + "recurseDepth": 10, + "opts": { + "destination": "../../docs/api", + "recurse": true + }, + "source": { + "include": ["./lib", "../../README.md"], + "includePattern": ".+\\.js(doc|x)?$", + "excludePattern": ".+\\.test\\.js(doc|x)?$" + }, + "sourceType": "module", + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc"] + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false + } +} \ No newline at end of file diff --git a/packages/evolution-common/package.json b/packages/evolution-common/package.json index e2793f21..bc3a1d88 100644 --- a/packages/evolution-common/package.json +++ b/packages/evolution-common/package.json @@ -17,7 +17,8 @@ "test:sequential": "echo 'no tests to run for this workspace'", "test:ui": "echo 'no tests to run for this workspace'", "lint": "eslint .", - "format": "prettier-eslint ./src/**/*.{ts,tsx} --write" + "format": "prettier-eslint ./src/**/*.{ts,tsx} --write", + "jsdoc": "jsdoc -c jsdoc.json" }, "dependencies": { "@fortawesome/fontawesome-svg-core": "^1.2.32",