Merge pull request #331 from hugo-syn/dev-debug

Make debug public
rhysd · Aug 4, 2023 · 8418fd0 · 8418fd0
2 parents 2b85681 + 875202a
commit 8418fd0
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/rule.go b/rule.go
@@ -53,7 +53,7 @@ func (r *RuleBase) Errorf(pos *Pos, format string, args ...interface{}) {
 	r.errs = append(r.errs, err)
 }
 
-func (r *RuleBase) debug(format string, args ...interface{}) {
+func (r *RuleBase) Debug(format string, args ...interface{}) {
 	if r.dbg == nil {
 		return
 	}

diff --git a/rule_action.go b/rule_action.go
@@ -85,11 +85,11 @@ func (rule *RuleAction) checkRepoAction(spec string, exec *ExecAction) {
 
 	meta, ok := PopularActions[spec]
 	if !ok {
-		rule.debug("This action is not found in popular actions data set: %s", spec)
+		rule.Debug("This action is not found in popular actions data set: %s", spec)
 		return
 	}
 	if meta.SkipInputs {
-		rule.debug("This action skips to check inputs: %s", spec)
+		rule.Debug("This action skips to check inputs: %s", spec)
 		return
 	}
 

diff --git a/rule_expression.go b/rule_expression.go
@@ -778,7 +778,7 @@ func (rule *RuleExpression) checkSemanticsOfExprNode(expr ExprNode, line, col in
 	if workflowKey != "" {
 		ctx, sp := WorkflowKeyAvailability(workflowKey)
 		if len(ctx) == 0 {
-			rule.debug("No context avaiability was found for workflow key %q", workflowKey)
+			rule.Debug("No context avaiability was found for workflow key %q", workflowKey)
 		}
 		c.SetContextAvailability(ctx)
 		c.SetSpecialFunctionAvailability(sp)

diff --git a/rule_pyflakes.go b/rule_pyflakes.go
@@ -111,11 +111,11 @@ func (rule *RulePyflakes) isPythonShell(r *ExecRun) bool {
 
 func (rule *RulePyflakes) runPyflakes(src string, pos *Pos) {
 	src = sanitizeExpressionsInScript(src) // Defined at rule_shellcheck.go
-	rule.debug("%s: Running %s for Python script:\n%s", pos, rule.cmd.exe, src)
+	rule.Debug("%s: Running %s for Python script:\n%s", pos, rule.cmd.exe, src)
 
 	rule.cmd.run([]string{}, src, func(stdout []byte, err error) error {
 		if err != nil {
-			rule.debug("Command %s failed: %v", rule.cmd.exe, err)
+			rule.Debug("Command %s failed: %v", rule.cmd.exe, err)
 			return fmt.Errorf("`%s` did not run successfully while checking script at %s: %w", rule.cmd.exe, pos, err)
 		}
 		if len(stdout) == 0 {

diff --git a/rule_shellcheck.go b/rule_shellcheck.go
@@ -158,7 +158,7 @@ func sanitizeExpressionsInScript(src string) string {
 
 func (rule *RuleShellcheck) runShellcheck(src, sh string, pos *Pos) {
 	src = sanitizeExpressionsInScript(src)
-	rule.debug("%s: Run shellcheck for %s script:\n%s", pos, sh, src)
+	rule.Debug("%s: Run shellcheck for %s script:\n%s", pos, sh, src)
 
 	// Reasons to exclude the rules:
 	//
@@ -173,7 +173,7 @@ func (rule *RuleShellcheck) runShellcheck(src, sh string, pos *Pos) {
 	// - SC2157: Argument to -z is always false due to literal strings. When the argument of -z is replaced from ${{ }},
 	//           this can happen. For example, `if [ -z ${{ env.FOO }} ]` -> `if [ -z ______________ ]` (#113).
 	args := []string{"--norc", "-f", "json", "-x", "--shell", sh, "-e", "SC1091,SC2194,SC2050,SC2154,SC2157", "-"}
-	rule.debug("%s: Running %s command with %s", pos, rule.cmd.exe, args)
+	rule.Debug("%s: Running %s command with %s", pos, rule.cmd.exe, args)
 
 	// Use same options to run shell process described at document
 	// https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
@@ -185,7 +185,7 @@ func (rule *RuleShellcheck) runShellcheck(src, sh string, pos *Pos) {
 
 	rule.cmd.run(args, script, func(stdout []byte, err error) error {
 		if err != nil {
-			rule.debug("Command %s %s failed: %v", rule.cmd.exe, args, err)
+			rule.Debug("Command %s %s failed: %v", rule.cmd.exe, args, err)
 			return fmt.Errorf("`%s %s` did not run successfully while checking script at %s: %w", rule.cmd.exe, strings.Join(args, " "), pos, err)
 		}
 

diff --git a/rule_workflow_call.go b/rule_workflow_call.go
@@ -84,7 +84,7 @@ func (rule *RuleWorkflowCall) checkWorkflowCallUsesLocal(call *WorkflowCall) {
 		return
 	}
 	if m == nil {
-		rule.debug("Skip workflow call %q since no metadata was found", u.Value)
+		rule.Debug("Skip workflow call %q since no metadata was found", u.Value)
 		return
 	}
 
@@ -142,7 +142,7 @@ func (rule *RuleWorkflowCall) checkWorkflowCallUsesLocal(call *WorkflowCall) {
 		}
 	}
 
-	rule.debug("Validated reusable workflow %q", u.Value)
+	rule.Debug("Validated reusable workflow %q", u.Value)
 }
 
 // Parse ./{path/{filename}