mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-28 15:55:30 +00:00
4f93520e47
* rebase js-layer PR from @ice3man543 * package restructuring * working * fix duplicated event & matcher status * fix lint error * fix response field * add new functions * multiple minor improvements * fix incorrect stats in js protocol * sort output metadata in cli * remove temp files * remove dead code * add unit and integration test * fix lint error * add jsdoclint using llm * fix error in test * add js lint using llm * generate docs of libs * llm lint * remove duplicated docs * update generated docs * update prompt in doclint * update docs * temp disable version check test * fix unit test and add retry * fix panic in it * update and move jsdocs * updated jsdocs * update docs * update container platform in test * dir restructure and adding docs * add api_reference and remove markdown docs * fix imports * add javascript design and contribution docs * add js protocol documentation * update integration test and docs * update doc ext mdx->md * minor update to docs * new integration test and more * move go libs and add docs * gen new net docs and more * final docs update * add new devtool * use fastdialer * fix build fail * use fastdialer + network sandbox support * add reserved keyword 'Port' * update Port to new syntax * misc update * always enable templatectx in js protocol * move docs to 'js-proto-docs' repo * remove scrapefuncs binary --------- Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
## devtools
|
|
|
|
devtools contains tools and scripts to automate booring tasks related to javascript layer/ packages.
|
|
|
|
### bindgen
|
|
|
|
[bindgen](./bindgen/README.md) is a tool that automatically generated bindings for native go packages with 'goja'
|
|
|
|
### jsdocgen
|
|
|
|
[jsdocgen](./jsdocgen/README.md) is LLM (OpenAI) based dev tool it takes generated javascript files and annotes them with jsdoc comments using predefined prompt
|
|
|
|
### scrapefuncs
|
|
|
|
[scrapefuncs](./scrapefuncs/README.md) is a tool to scrapes all helper functions exposed in javascript with help of go/ast and generates a js file with jsdoc comments using LLM (OpenAI)
|
|
|
|
|
|
### Generating API Reference (aka static site using javascript files using jsdoc)
|
|
|
|
```console
|
|
jsdoc -R [Homepage.md] -r -d api_reference -t [optional: jsdoc theme to use] generated/js
|
|
```
|
|
|
|
generated static site will be available at `api_reference/` directory and can be verified using simplehttpserver
|
|
|
|
```console
|
|
simplehttpserver
|
|
```
|
|
|
|
and then open `http://localhost:8000/` in browser
|
|
|
|
|
|
### Notes
|
|
|
|
we currently use [clean-jsdoc-theme](https://www.npmjs.com/package/clean-jsdoc-theme) demo at [sample-jsproto-docs/](https://projectdiscovery.github.io/js-proto-docs/) |