mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-29 05:35:29 +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>
130 lines
3.3 KiB
Markdown
130 lines
3.3 KiB
Markdown
## scrapefuncs
|
|
|
|
scrapefuncs is go/ast based 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)
|
|
|
|
### Usage
|
|
|
|
```console
|
|
Usage of ./scrapefuncs:
|
|
-dir string
|
|
directory to process (default "pkg/js/global")
|
|
-key string
|
|
openai api key
|
|
-keyfile string
|
|
openai api key file
|
|
-out string
|
|
output js file with declarations of all global functions
|
|
```
|
|
|
|
|
|
### Example
|
|
|
|
```console
|
|
$ ./scrapefuncs -keyfile ~/.openai.key
|
|
[+] Scraped 7 functions
|
|
|
|
Name: Rand
|
|
Signatures: "Rand(n int) []byte"
|
|
Description: Rand returns a random byte slice of length n
|
|
|
|
Name: RandInt
|
|
Signatures: "RandInt() int"
|
|
Description: RandInt returns a random int
|
|
|
|
Name: log
|
|
Signatures: "log(msg string)"
|
|
Signatures: "log(msg map[string]interface{})"
|
|
Description: log prints given input to stdout with [JS] prefix for debugging purposes
|
|
|
|
Name: getNetworkPort
|
|
Signatures: "getNetworkPort(port string, defaultPort string) string"
|
|
Description: getNetworkPort registers defaultPort and returns defaultPort if it is a colliding port with other protocols
|
|
|
|
Name: isPortOpen
|
|
Signatures: "isPortOpen(host string, port string, [timeout int]) bool"
|
|
Description: isPortOpen checks if given port is open on host. timeout is optional and defaults to 5 seconds
|
|
|
|
Name: ToBytes
|
|
Signatures: "ToBytes(...interface{}) []byte"
|
|
Description: ToBytes converts given input to byte slice
|
|
|
|
Name: ToString
|
|
Signatures: "ToString(...interface{}) string"
|
|
Description: ToString converts given input to string
|
|
|
|
|
|
[+] Generating jsdoc for all functions
|
|
|
|
/**
|
|
* Rand returns a random byte slice of length n
|
|
* Rand(n int) []byte
|
|
* @function
|
|
* @param {number} n - The length of the byte slice.
|
|
*/
|
|
function Rand(n) {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* RandInt returns a random int
|
|
* RandInt() int
|
|
* @function
|
|
*/
|
|
function RandInt() {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* log prints given input to stdout with [JS] prefix for debugging purposes
|
|
* log(msg string)
|
|
* log(msg map[string]interface{})
|
|
* @function
|
|
* @param {string|Object} msg - The message to print.
|
|
*/
|
|
function log(msg) {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* getNetworkPort registers defaultPort and returns defaultPort if it is a colliding port with other protocols
|
|
* getNetworkPort(port string, defaultPort string) string
|
|
* @function
|
|
* @param {string} port - The port to check.
|
|
* @param {string} defaultPort - The default port to return if the port is colliding.
|
|
*/
|
|
function getNetworkPort(port, defaultPort) {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* isPortOpen checks if given port is open on host. timeout is optional and defaults to 5 seconds
|
|
* isPortOpen(host string, port string, [timeout int]) bool
|
|
* @function
|
|
* @param {string} host - The host to check.
|
|
* @param {string} port - The port to check.
|
|
* @param {number} [timeout=5] - The timeout in seconds.
|
|
*/
|
|
function isPortOpen(host, port, timeout = 5) {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* ToBytes converts given input to byte slice
|
|
* ToBytes(...interface{}) []byte
|
|
* @function
|
|
* @param {...any} args - The input to convert.
|
|
*/
|
|
function ToBytes(...args) {
|
|
// implemented in go
|
|
};
|
|
|
|
/**
|
|
* ToString converts given input to string
|
|
* ToString(...interface{}) string
|
|
* @function
|
|
* @param {...any} args - The input to convert.
|
|
*/
|
|
function ToString(...args) {
|
|
// implemented in go
|
|
};
|
|
``` |