nuclei/README.md at fix-fuzzing-error-handling

mirror of https://github.com/projectdiscovery/nuclei.git synced 2025-12-17 23:15:26 +00:00

javascript bindings + docs generation enhancements ( generate typescript defination .d.ts files) (#4487 )

* introduce typescript files generation using ast + tmpl

* feat valid ts with scraping

* feat remove old logic + tsdocs for all modules

* fix ikev and related bugs

* typescript docs for js modules

* lint,build + ldap realm fix

* go mod tidy

* fix named imports ast parsing

* fix ast code generation errors

* complete support for ts files generation

* support go global/const in ts docs

* updated template

* feat: typescript using go code generation

* nuke jsdoc generator

* update generated ts dir structure

* fix multifile ts gen issue

* fix panic in ts code gen

* fix test

* update docs of js libs

* feat: add doc+example for every js class,function,method

* fix missing quotes in ikev example

---------

Co-authored-by: Sandeep Singh <sandeep@projectdiscovery.io>

2024-02-07 21:45:40 +05:30

1015 B

Raw Permalink Blame History

devtools

devtools contains tools and scripts to automate booring tasks related to javascript layer/ packages.

bindgen

bindgen is a tool that automatically generated bindings for native go packages with 'goja'

scrapefuncs

scrapefuncs 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)

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

simplehttpserver

and then open http://localhost:8000/ in browser

Notes

we currently use clean-jsdoc-theme demo at sample-jsproto-docs/

1015 B Raw Permalink Blame History