feature: Add format flag to allow for sarif output

Author: machadoit

README.md

@@ -11,6 +11,7 @@ The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing co
 - **`analyze` Command**: Runs ESLint analysis on the codebase.
     - `--output, -o`: Output file for the results.
     - `--tool, -t`: Specifies the tool to run analysis with (e.g., ESLint).
+    - `--format`: Output format (use 'sarif' for SARIF format to terminal).
     - `--fix, -f`: Automatically fixes issues when possible.
     - `--new-pr`: Creates a new GitHub PR with fixed issues.
 
@@ -77,6 +78,12 @@ To run ESLint and output the results to the terminal:
 codacy-cli analyze --tool eslint
 ```
 
+To output results in SARIF format to the terminal:
+
+```bash
+codacy-cli analyze --tool eslint --format sarif
+```
+
 To store the results as SARIF in a file:
 
 ```bash

cmd/analyze.go

@@ -19,6 +19,7 @@ var outputFile string
 var toolToAnalyze string
 var autoFix bool
 var doNewPr bool
+var outputFormat string
 var sarifPath string
 var commitUuid string
 var projectToken string
@@ -95,6 +96,7 @@ type Pattern struct {
 func init() {
 	analyzeCmd.Flags().StringVarP(&outputFile, "output", "o", "", "output file for the results")
 	analyzeCmd.Flags().StringVarP(&toolToAnalyze, "tool", "t", "", "Which tool to run analysis with")
+	analyzeCmd.Flags().StringVar(&outputFormat, "format", "", "Output format (use 'sarif' for SARIF format to terminal)")
 	analyzeCmd.Flags().BoolVarP(&autoFix, "fix", "f", false, "Apply auto fix to your issues when available")
 	analyzeCmd.Flags().BoolVar(&doNewPr, "new-pr", false, "Create a new PR on GitHub containing the fixed issues")
 	rootCmd.AddCommand(analyzeCmd)
@@ -221,9 +223,11 @@ var analyzeCmd = &cobra.Command{
 		log.Printf("Running %s...\n", toolToAnalyze)
 		if outputFile != "" {
 			log.Println("Output will be available at", outputFile)
+		} else if outputFormat == "sarif" {
+			log.Println("Output will be in SARIF format")
 		}
 
-		tools.RunEslint(workDirectory, eslintInstallationDirectory, nodeBinary, args, autoFix, outputFile)
+		tools.RunEslint(workDirectory, eslintInstallationDirectory, nodeBinary, args, autoFix, outputFile, outputFormat)
 
 		if doNewPr {
 			utils.CreatePr(false)
@@ -238,4 +242,4 @@ func failIfThereArePendingChanges() {
 	if string(out) != "" {
 		log.Fatal("There are pending changes, cannot proceed. Commit your pending changes.")
 	}
-}
+}

tools/eslintRunner.go

@@ -9,7 +9,7 @@ import (
 // * Run from the root of the repo we want to analyse
 // * NODE_PATH="<the installed eslint path>/node_modules"
 // * The local installed ESLint should have the @microsoft/eslint-formatter-sarif installed
-func RunEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, pathsToCheck []string, autoFix bool, outputFile string) {
+func RunEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory string, nodeBinary string, pathsToCheck []string, autoFix bool, outputFile string, outputFormat string) {
 	eslintInstallationNodeModules := filepath.Join(eslintInstallationDirectory, "node_modules")
 	eslintJsPath := filepath.Join(eslintInstallationNodeModules, ".bin", "eslint")
 
@@ -20,6 +20,9 @@ func RunEslint(repositoryToAnalyseDirectory string, eslintInstallationDirectory
 	if outputFile != "" {
 		//When writing to file, we write is SARIF
 		cmd.Args = append(cmd.Args, "-f", "@microsoft/eslint-formatter-sarif", "-o", outputFile)
+	} else if outputFormat == "sarif" {
+		//When outputting to terminal in SARIF format
+		cmd.Args = append(cmd.Args, "-f", "@microsoft/eslint-formatter-sarif")
 	}
 	if len(pathsToCheck) > 0 {
 		cmd.Args = append(cmd.Args, pathsToCheck...)