# Tools for the Module Developers

## Generating JSDoc for [performantlabs.com](https://performantlabs.com/automated-testing-kit/introduction)

To generate HTML docs, do the following,

for Cypress:

1. Generate `index.d.ts`. In `cypress/support/` directory, execute
```shell
../../module_support/typedoc/generate_index_d_ts.sh atk_commands.js
```
2. In the project directory, execute:
```shell
npx typedoc --plugin ./module_support/typedoc/index.js --theme wrap_table cypress/support/index.d.ts 
```
3. Copy generated HTML from `docs/modules/Cypress.html` to [the appropriate page](https://performantlabs.com/automated-testing-kit/cypress-custom-commands).

for Playwright:

1. In the project directory, execute:
```shell
npx jsdoc -t module_support/jsdoc/templates/pl/ -c module_support/jsdoc/conf.json
```
2. Copy generated HTML from `docs/global.html` to [the appropriate page](https://performantlabs.com/automated-testing-kit/playwright-helper-functions).
