Spelling

.github/workflows/build-test.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v3
 
-      - name: Go Mod hygine
+      - name: Go Mod hygiene
         run: |
           go clean -modcache
           go mod tidy

.github/workflows/dockerhub-push.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Git Checkout
         uses: actions/checkout@v3
 
-      - name: Get Github tag
+      - name: Get GitHub tag
         id: meta
         run: |
           curl --silent "https://api.github.com/repos/projectdiscovery/nuclei/releases/latest" | jq -r .tag_name | xargs -I {} echo TAG={} >> $GITHUB_OUTPUT

DESIGN.md

@@ -145,7 +145,7 @@ type Exporter interface {
 }
 ```
 
-Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub` , `Gitlab` and `Jira`.
+Exporters include `Elasticsearch`, `markdown`, `sarif` . Trackers include `GitHub` , `GitLab` and `Jira`.
 
 Each exporter and trackers implement their own configuration in YAML format and are very modular in nature, so adding new ones is easy.
 
@@ -484,7 +484,7 @@ $ go tool pprof -http=:8081 mem.pprof
 - [v2/pkg/reporting/exporters/markdown](./v2/pkg/reporting/exporters/markdown) - Markdown Result Exporter
 - [v2/pkg/reporting/exporters/es](./v2/pkg/reporting/exporters/es) - Elasticsearch Result Exporter
 - [v2/pkg/reporting/dedupe](./v2/pkg/reporting/dedupe) - Dedupe module for Results
-- [v2/pkg/reporting/trackers/gitlab](./v2/pkg/reporting/trackers/gitlab) - Gitlab Issue Tracker Exporter
+- [v2/pkg/reporting/trackers/gitlab](./v2/pkg/reporting/trackers/gitlab) - GitLab Issue Tracker Exporter
 - [v2/pkg/reporting/trackers/jira](./v2/pkg/reporting/trackers/jira) - Jira Issue Tracker Exporter
 - [v2/pkg/reporting/trackers/github](./v2/pkg/reporting/trackers/github) - GitHub Issue Tracker Exporter
 - [v2/pkg/reporting/format](./v2/pkg/reporting/format) - Result Formatting Functions

SYNTAX-REFERENCE.md

@@ -358,7 +358,7 @@ Variables contains any variables for the current request.
 </div>
 <div class="dt">
 
-Constants contains any scalar costant for the current template
+Constants contains any scalar constant for the current template
 
 </div>
 

integration_tests/debug.sh

@@ -8,7 +8,7 @@ if [ $1 = "-h" ]; then
  printf " \$ ./debug.sh http self\n\n"
  printf "3. To run all integration tests of 'x' protocol that contains 'y' in template name and pass extra args to nuclei:\n"
  printf " \$ ./debug.sh http self -svd -debug-req\n\n"
- printf "nuclei binary is created everytime script is run but integration-test binary is not"
+ printf "nuclei binary is created every time script is run but integration-test binary is not"
  exit 0
 fi
 

integration_tests/workflow/shared-cookie.yaml

@@ -11,5 +11,5 @@ workflows:
   - template: workflow/http-2.yaml
   # store cookie in native browser context
   - template: workflow/headless-1.yaml
-  # retrive 2 standard library cookies + headless cookie
+  # retrieve 2 standard library cookies + headless cookie
   - template: workflow/http-3.yaml

nuclei-jsonschema.json

@@ -1311,7 +1311,7 @@
             }
           },
           "type": "object",
-          "title": "payloads for the webosocket request",
+          "title": "payloads for the websocket request",
           "description": "Payloads contains any payloads for the current request"
         }
       },

v2/cmd/integration-test/http.go

@@ -172,7 +172,7 @@ func (h *httpInteractshStopAtFirstMatchRequest) Execute(filePath string) error {
 	if err != nil {
 		return err
 	}
-	// polling is asyncronous, so the interactions may be retrieved after the first request
+	// polling is asynchronous, so the interactions may be retrieved after the first request
 	return expectResultsCount(results, 1)
 }
 

v2/cmd/nuclei/main.go

@@ -422,11 +422,11 @@ func printTemplateVersion() {
 	if fileutil.FolderExists(cfg.CustomS3TemplatesDirectory) {
 		gologger.Info().Msgf("Custom S3 templates location: %s\n", cfg.CustomS3TemplatesDirectory)
 	}
-	if fileutil.FolderExists(cfg.CustomGithubTemplatesDirectory) {
-		gologger.Info().Msgf("Custom Github templates location: %s ", cfg.CustomGithubTemplatesDirectory)
+	if fileutil.FolderExists(cfg.CustomGitHubTemplatesDirectory) {
+		gologger.Info().Msgf("Custom GitHub templates location: %s ", cfg.CustomGitHubTemplatesDirectory)
 	}
 	if fileutil.FolderExists(cfg.CustomGitLabTemplatesDirectory) {
-		gologger.Info().Msgf("Custom Gitlab templates location: %s ", cfg.CustomGitLabTemplatesDirectory)
+		gologger.Info().Msgf("Custom GitLab templates location: %s ", cfg.CustomGitLabTemplatesDirectory)
 	}
 	if fileutil.FolderExists(cfg.CustomAzureTemplatesDirectory) {
 		gologger.Info().Msgf("Custom Azure templates location: %s ", cfg.CustomAzureTemplatesDirectory)

v2/cmd/tmc/main.go

@@ -90,7 +90,7 @@ type options struct {
 func main() {
 	opts := options{}
 	flagSet := goflags.NewFlagSet()
-	flagSet.SetDescription(`TemplateMan CLI is baisc utility built on the TemplateMan API to standardize nuclei templates.`)
+	flagSet.SetDescription(`TemplateMan CLI is basic utility built on the TemplateMan API to standardize nuclei templates.`)
 
 	flagSet.CreateGroup("Input", "input",
 		flagSet.StringVarP(&opts.input, "input", "i", "", "Templates to annotate"),

v2/gh_retry.sh

@@ -17,7 +17,7 @@ LIMIT=30
 BEFORE="30 mins ago"
 WORKFLOW="Build Test"
 
-# You can add multiple patterns seperated by |
+# You can add multiple patterns separated by |
 GREP_ERROR_PATTERN='Test "http/interactsh.yaml" failed'
 
 #Set fonts for Help.
@@ -81,7 +81,7 @@ function retry_failed_jobs() {
     select ( .conclusion=="failure" ) |
     select ( .updatedAt > $date) ' --arg date "$date" --arg branch "$BRANCH" --arg workflow "$WORKFLOW" | jq .databaseId)
 
-    # convert line seperated by space to array
+    # convert line separated by space to array
     eval "arr=($workflowIds)"
 
     if [[ -z $arr ]]

v2/internal/installer/template.go

@@ -186,7 +186,7 @@ func (t *TemplateManager) summarizeChanges(old, new map[string]string) *template
 // getAbsoluteFilePath returns an absolute path where a file should be written based on given uri(i.e., files in zip)
 // if a returned path is empty, it means that file should not be written and skipped
 func (t *TemplateManager) getAbsoluteFilePath(templateDir, uri string, f fs.FileInfo) string {
-	// overwrite .nuclei-ignore everytime nuclei-templates are downloaded
+	// overwrite .nuclei-ignore every time nuclei-templates are downloaded
 	if f.Name() == config.NucleiIgnoreFileName {
 		return config.DefaultConfig.GetIgnoreFilePath()
 	}
@@ -206,7 +206,7 @@ func (t *TemplateManager) getAbsoluteFilePath(templateDir, uri string, f fs.File
 		gologger.Warning().Msgf("failed to get directory name from uri: %s", uri)
 		return filepath.Join(templateDir, uri)
 	}
-	// seperator is also included in rootDir
+	// separator is also included in rootDir
 	rootDirectory := uri[:index+1]
 	relPath := strings.TrimPrefix(uri, rootDirectory)
 

v2/internal/installer/template_test.go

@@ -53,7 +53,7 @@ func TestTemplateInstallation(t *testing.T) {
 
 	// we should have at least 1000 templates
 	require.Greater(t, counter, 1000)
-	// everytime we install templates, it should override the ignore file with latest one
+	// every time we install templates, it should override the ignore file with latest one
 	require.FileExists(t, config.DefaultConfig.GetIgnoreFilePath())
 	t.Logf("Installed %d templates", counter)
 }

v2/internal/installer/util.go

@@ -36,7 +36,7 @@ func GetNewTemplatesInVersions(versions ...string) []string {
 			continue
 		}
 
-		arr, err := getNewAdditionsFileFromGithub(v)
+		arr, err := getNewAdditionsFileFromGitHub(v)
 		if err != nil {
 			gologger.Error().Msgf("failed to fetch new additions for %v got: %v", v, err)
 			continue
@@ -46,7 +46,7 @@ func GetNewTemplatesInVersions(versions ...string) []string {
 	return allTemplates
 }
 
-func getNewAdditionsFileFromGithub(version string) ([]string, error) {
+func getNewAdditionsFileFromGitHub(version string) ([]string, error) {
 	resp, err := retryableHttpClient.Get(fmt.Sprintf("https://raw.githubusercontent.com/projectdiscovery/nuclei-templates/%s/.new-additions", version))
 	if err != nil {
 		return nil, err

v2/internal/runner/cloud.go

@@ -375,8 +375,8 @@ func (r *Runner) addCloudDataSource(source string) error {
 			return err
 		}
 	case "github":
-		for _, repo := range r.options.GithubTemplateRepo {
-			if _, err := r.processDataSourceItem(repo, r.options.GithubToken, "github"); err != nil {
+		for _, repo := range r.options.GitHubTemplateRepo {
+			if _, err := r.processDataSourceItem(repo, r.options.GitHubToken, "github"); err != nil {
 				return err
 			}
 		}

v2/internal/runner/options.go

@@ -80,9 +80,9 @@ func ParseOptions(options *types.Options) {
 		gologger.Fatal().Msgf("Could not initialize protocols: %s\n", err)
 	}
 
-	// Set Github token in env variable. runner.getGHClientWithToken() reads token from env
-	if options.GithubToken != "" && os.Getenv("GITHUB_TOKEN") != options.GithubToken {
-		os.Setenv("GITHUB_TOKEN", options.GithubToken)
+	// Set GitHub token in env variable. runner.getGHClientWithToken() reads token from env
+	if options.GitHubToken != "" && os.Getenv("GITHUB_TOKEN") != options.GitHubToken {
+		os.Setenv("GITHUB_TOKEN", options.GitHubToken)
 	}
 
 	if options.UncoverQuery != nil {
@@ -203,7 +203,7 @@ func validateCloudOptions(options *types.Options) error {
 		case "s3":
 			missing = validateMissingS3Options(options)
 		case "github":
-			missing = validateMissingGithubOptions(options)
+			missing = validateMissingGitHubOptions(options)
 		case "gitlab":
 			missing = validateMissingGitLabOptions(options)
 		case "azure":
@@ -253,12 +253,12 @@ func validateMissingAzureOptions(options *types.Options) []string {
 	return missing
 }
 
-func validateMissingGithubOptions(options *types.Options) []string {
+func validateMissingGitHubOptions(options *types.Options) []string {
 	var missing []string
-	if options.GithubToken == "" {
+	if options.GitHubToken == "" {
 		missing = append(missing, "GITHUB_TOKEN")
 	}
-	if len(options.GithubTemplateRepo) == 0 {
+	if len(options.GitHubTemplateRepo) == 0 {
 		missing = append(missing, "GITHUB_TEMPLATE_REPO")
 	}
 	return missing
@@ -360,10 +360,10 @@ func readEnvInputVars(options *types.Options) {
 	}
 	options.CloudAPIKey = os.Getenv("NUCLEI_CLOUD_API")
 
-	options.GithubToken = os.Getenv("GITHUB_TOKEN")
+	options.GitHubToken = os.Getenv("GITHUB_TOKEN")
 	repolist := os.Getenv("GITHUB_TEMPLATE_REPO")
 	if repolist != "" {
-		options.GithubTemplateRepo = append(options.GithubTemplateRepo, stringsutil.SplitAny(repolist, ",")...)
+		options.GitHubTemplateRepo = append(options.GitHubTemplateRepo, stringsutil.SplitAny(repolist, ",")...)
 	}
 
 	// GitLab options for downloading templates from a repository

v2/internal/runner/proxy.go

@@ -14,7 +14,7 @@ import (
 	proxyutils "github.com/projectdiscovery/utils/proxy"
 )
 
-// loadProxyServers load list of proxy servers from file or comma seperated
+// loadProxyServers load list of proxy servers from file or comma separated
 func loadProxyServers(options *types.Options) error {
 	if len(options.Proxy) == 0 {
 		return nil

v2/internal/runner/templates.go

@@ -57,7 +57,7 @@ func (r *Runner) listAvailableStoreTemplates(store *loader.Store) {
 					path = aurora.Cyan(tpl.Path).String()
 					tplBody, err = r.highlightTemplate(&tplBody)
 					if err != nil {
-						gologger.Error().Msgf("Could not hihglight the template %s: %s", tpl.Path, err)
+						gologger.Error().Msgf("Could not highlight the template %s: %s", tpl.Path, err)
 						continue
 					}
 
@@ -74,7 +74,7 @@ func (r *Runner) listAvailableStoreTemplates(store *loader.Store) {
 
 func (r *Runner) highlightTemplate(body *[]byte) ([]byte, error) {
 	var buf bytes.Buffer
-	// YAML lexer, true color terminar formatter and monokai style
+	// YAML lexer, true color terminal formatter and monokai style
 	err := quick.Highlight(&buf, string(*body), "yaml", "terminal16m", "monokai")
 	if err != nil {
 		return nil, err

v2/pkg/catalog/aws/catalog.go

@@ -129,7 +129,7 @@ func (c Catalog) ResolvePath(templateName, second string) (string, error) {
 
 	// if c second path is given, it's c folder and we join the two and check against keys
 	if second != "" {
-		// Note: Do not replace `path` with `filepath` since filepath is aware of Os path seperator
+		// Note: Do not replace `path` with `filepath` since filepath is aware of Os path separator
 		// and we only see `/` in s3 paths changing it to filepath cause build fail and other errors
 		target := path.Join(path.Dir(second), templateName)
 		for _, key := range keys {

v2/pkg/catalog/aws/catalog_test.go

@@ -141,7 +141,7 @@ func TestCatalog_OpenFile(t *testing.T) {
 			false,
 		},
 		{
-			"non-existent key",
+			"nonexistent key",
 			"something/that-doesnt-exist.yaml",
 			true,
 		},

v2/pkg/catalog/config/constants.go

@@ -20,7 +20,7 @@ const (
 	Version = `v2.9.10`
 	// Directory Names of custom templates
 	CustomS3TemplatesDirName     = "s3"
-	CustomGithubTemplatesDirName = "github"
+	CustomGitHubTemplatesDirName = "github"
 	CustomAzureTemplatesDirName  = "azure"
 	CustomGitLabTemplatesDirName = "gitlab"
 )

v2/pkg/catalog/config/nucleiconfig.go

@@ -23,16 +23,16 @@ type Config struct {
 	TemplatesDirectory string `json:"nuclei-templates-directory,omitempty"`
 
 	// customtemplates exists in templates directory with the name of custom-templates provider
-	// below custom paths are absolute paths to respecitive custom-templates directories
+	// below custom paths are absolute paths to respective custom-templates directories
 	CustomS3TemplatesDirectory     string `json:"custom-s3-templates-directory"`
-	CustomGithubTemplatesDirectory string `json:"custom-github-templates-directory"`
+	CustomGitHubTemplatesDirectory string `json:"custom-github-templates-directory"`
 	CustomGitLabTemplatesDirectory string `json:"custom-gitlab-templates-directory"`
 	CustomAzureTemplatesDirectory  string `json:"custom-azure-templates-directory"`
 
 	TemplateVersion  string `json:"nuclei-templates-version,omitempty"`
 	NucleiIgnoreHash string `json:"nuclei-ignore-hash,omitempty"`
 
-	// Latestxxx are not meant to be used directly and is used as
+	// LatestXXX are not meant to be used directly and is used as
 	// local cache of nuclei version check endpoint
 	// these fields are only update during nuclei version check
 	// TODO: move these fields to a separate unexported struct as they are not meant to be used directly
@@ -83,7 +83,7 @@ func (c *Config) NeedsTemplateUpdate() bool {
 	return !c.disableUpdates && (c.TemplateVersion == "" || IsOutdatedVersion(c.TemplateVersion, c.LatestNucleiTemplatesVersion) || !fileutil.FolderExists(c.TemplatesDirectory))
 }
 
-// NeedsIngoreFileUpdate returns true if Ignore file hash is different (aka ignore file is outdated)
+// NeedsIgnoreFileUpdate returns true if Ignore file hash is different (aka ignore file is outdated)
 func (c *Config) NeedsIgnoreFileUpdate() bool {
 	return c.NucleiIgnoreHash == "" || c.NucleiIgnoreHash != c.LatestNucleiIgnoreHash
 }
@@ -111,7 +111,7 @@ func (c *Config) GetConfigDir() string {
 
 // GetAllCustomTemplateDirs returns all custom template directories
 func (c *Config) GetAllCustomTemplateDirs() []string {
-	return []string{c.CustomS3TemplatesDirectory, c.CustomGithubTemplatesDirectory, c.CustomGitLabTemplatesDirectory, c.CustomAzureTemplatesDirectory}
+	return []string{c.CustomS3TemplatesDirectory, c.CustomGitHubTemplatesDirectory, c.CustomGitLabTemplatesDirectory, c.CustomAzureTemplatesDirectory}
 }
 
 // GetReportingConfigFilePath returns the nuclei reporting config file path
@@ -188,7 +188,7 @@ func (c *Config) SetTemplatesDir(dirPath string) {
 	}
 	c.TemplatesDirectory = dirPath
 	// Update the custom templates directory
-	c.CustomGithubTemplatesDirectory = filepath.Join(dirPath, CustomGithubTemplatesDirName)
+	c.CustomGitHubTemplatesDirectory = filepath.Join(dirPath, CustomGitHubTemplatesDirName)
 	c.CustomS3TemplatesDirectory = filepath.Join(dirPath, CustomS3TemplatesDirName)
 	c.CustomGitLabTemplatesDirectory = filepath.Join(dirPath, CustomGitLabTemplatesDirName)
 	c.CustomAzureTemplatesDirectory = filepath.Join(dirPath, CustomAzureTemplatesDirName)

v2/pkg/catalog/disk/find.go

@@ -48,7 +48,7 @@ func (c *DiskCatalog) GetTemplatesPath(definitions []string) ([]string, map[stri
 			}
 		}
 	}
-	// purge all falsepositivies
+	// purge all false positives
 	filteredTemplates := []string{}
 	for _, v := range allTemplates {
 		// TODO: this is a temporary fix to avoid treating these files as templates
@@ -129,7 +129,7 @@ func (c *DiskCatalog) convertPathToAbsolute(t string) (string, error) {
 
 // findGlobPathMatches returns the matched files from a glob path
 func (c *DiskCatalog) findGlobPathMatches(absPath string, processed map[string]struct{}) ([]string, error) {
-	// to support globbing on old paths we use bruteforce to find matches with exit on first match
+	// to support globbing on old paths we use brute force to find matches with exit on first match
 	// trim templateDir if any
 	relPath := strings.TrimPrefix(absPath, c.templatesDirectory)
 	// trim leading slash if any

v2/pkg/catalog/disk/path.go

@@ -89,7 +89,7 @@ func BackwardsCompatiblePaths(templateDir string, oldPath string) string {
 		// trim the template directory from the path
 		return newPathCallback(tmp)
 	case strings.Contains(oldPath, urlutil.SchemeSeparator):
-		// scheme seperator is used to identify the path as url
+		// scheme separator is used to identify the path as url
 		// TBD: add support for url directories ??
 		return oldPath
 	case strings.Contains(oldPath, "*"):

v2/pkg/catalog/loader/loader.go

@@ -59,7 +59,7 @@ type Store struct {
 	preprocessor templates.Preprocessor
 
 	// NotFoundCallback is called for each not found template
-	// This overrides error handling for not found templatesss
+	// This overrides error handling for not found templates
 	NotFoundCallback func(template string) bool
 }
 
@@ -187,7 +187,7 @@ func (store *Store) ValidateTemplates() error {
 	if areTemplatesValid(store, filteredTemplatePaths) && areWorkflowsValid(store, filteredWorkflowPaths) {
 		return nil
 	}
-	return errors.New("errors occured during template validation")
+	return errors.New("errors occurred during template validation")
 }
 
 func areWorkflowsValid(store *Store, filteredWorkflowPaths map[string]struct{}) bool {

v2/pkg/core/execute_options.go

@@ -29,7 +29,7 @@ func (e *Engine) ExecuteWithResults(templatesList []*templates.Template, target
 	return e.ExecuteScanWithOpts(templatesList, target, false)
 }
 
-// ExecuteScanWithOpts executes scan with given scanStatergy
+// ExecuteScanWithOpts executes scan with given scanStrategy
 func (e *Engine) ExecuteScanWithOpts(templatesList []*templates.Template, target InputProvider, noCluster bool) *atomic.Bool {
 	results := &atomic.Bool{}
 	selfcontainedWg := &sync.WaitGroup{}

v2/pkg/core/inputs/hybrid/hmap.go

@@ -277,7 +277,7 @@ func (i *Input) setItem(metaInput *contextargs.MetaInput) {
 	}
 }
 
-// setHostMapStream sets iteam in stream mode
+// setHostMapStream sets item in stream mode
 func (i *Input) setHostMapStream(data string) {
 	if _, err := i.hostMapStream.Merge([][]byte{[]byte(data)}); err != nil {
 		gologger.Warning().Msgf("%s\n", err)