External/nuclei
1
0
Fork 0
mirror of https://github.com/projectdiscovery/nuclei.git synced 2025-12-28 14:15:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
nuclei/v2/pkg/js/devtools
History
Tarun Koyalwar 39d094075b
add 'fs' module to javascript protocol (#4156) 
* 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

* add fs library

* add fs module

* add init code block and 'updatePayload'

* use go native func for isPortOpen

* docgen improvements + 'fs' module docs

* update func signature and more

* prompt improvements

* fix inconsitencies in jsdocs

* remove debug statements

---------

Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
2023-09-26 16:55:25 +05:30
..
bindgen
add 'fs' module to javascript protocol (#4156)
2023-09-26 16:55:25 +05:30
jsdocgen
add 'fs' module to javascript protocol (#4156)
2023-09-26 16:55:25 +05:30
scrapefuncs
javascript protocol for scripting (includes 15+ proto libs) (#4109)
2023-09-16 16:02:17 +05:30
README.md
javascript protocol for scripting (includes 15+ proto libs) (#4109)
2023-09-16 16:02:17 +05:30

README.md

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'

jsdocgen

jsdocgen is LLM (OpenAI) based dev tool it takes generated javascript files and annotes them with jsdoc comments using predefined prompt

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/