Merge pull request #18 from codacy/version2

Version 2

Author: stefanvacareanu7

README.md

@@ -1,66 +1,89 @@
 # codacy-cli-v2
 
-This is a POC for what could a new CLI for us. The idea is to rely on the native tools and SARIF format instead of relying on docker.
+This is a POC for what could be a new CLI for us. The idea is to rely on the native tools and SARIF format instead of relying on Docker.
 
+## Overview
+
+The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing code using ESLint and uploading the results in SARIF format to Codacy. It provides two main commands: `analyze` and `upload`.
+
+### Commands
+
+- **`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).
+    - `--fix, -f`: Automatically fixes issues when possible.
+    - `--new-pr`: Creates a new GitHub PR with fixed issues.
+
+- **`upload` Command**: Uploads a SARIF file containing analysis results to Codacy.
+    - `--sarif-path, -s`: Path to the SARIF report.
+    - `--commit-uuid, -c`: Commit UUID.
+    - `--project-token, -t`: Project token for Codacy API.
+
+### Important Concepts
+
+- **`.codacy/.codacy.yaml`**: Configuration file to specify `node` and `eslint` versions for the CLI.
+  ```yaml
+  runtimes:
+      - [email protected]
+  tools:
+      - [email protected]
+  
+- **`codacy-cli-v2 install`**: Command to install the specified node and eslint versions before running analysis.
+- 
 ## Download
 
-### MacOS brew
+### MacOS (brew)
+
+To install `codacy-cli-v2` using Homebrew:
 
 ```bash
 brew install codacy/codacy-cli-v2/codacy-cli-v2
 ```
 
-### Linux
+## Linux
 
-For linux we rely on `codacy-cli.sh` script on the root, to download the CLI you can:
+For Linux, we rely on the codacy-cli.sh script in the root. To download the CLI, run:
 
 ```bash
 bash <(curl -Ls https://raw.githubusercontent.com/codacy/codacy-cli-v2/main/codacy-cli.sh)
 ```
+You can either put the downloaded script in a specific file or create an alias that will download the script and look for changes:
 
-You can either put the downloaded script on a specific file, or an alias that will download the script and look for changes:
 ```bash
 alias codacy-cli-v2="bash <(curl -Ls https://raw.githubusercontent.com/codacy/codacy-cli-v2/main/codacy-cli.sh)"
 ```
 
-## Important concepts
-
-### `.codacy/.codacy.yaml`
-
-Our CLI relies on the `.codacy/.codacy.yaml` to install and run the specified `node` and `eslint` versions.
+## Installation
 
-Meaning that on the root of the repository that you want to analyse, you should create a `.codacy/.codacy.yaml` such as:
+Before running the analysis, install the specified tools:
 
-```yaml
-runtimes:
-    - [email protected]
-tools:
-    - [email protected]
+```bash
+codacy-cli-v2 install
 ```
 
-### `codacy-cli-v2 install`
+### Run Analysis
 
-Before running, you need to do an install command, so it downloads the specified `node` and `eslint` versions.
-To install the tools specified on your `.codacy/.codacy.yaml` you should:
+To run ESLint and output the results to the terminal:
 
 ```bash
-  codacy-cli-v2 install
+codacy-cli-v2 analyze --tool eslint
 ```
 
-## Run
-
-For now, we only support ESLint, to run and output the results to the terminal:
+To store the results as SARIF in a file:
 
 ```bash
-codacy-cli-v2 analyze --tool eslint
+codacy-cli-v2 analyze -t eslint -o eslint.sarif
 ```
 
-Alternatively, you can store the results as SARIF to a file:
+## Upload Results
+
+To upload a SARIF file to Codacy:
 
 ```bash
-codacy-cli-v2 analyze -t eslint -o eslint.sarif
+codacy-cli-v2 upload -s path/to/your.sarif -c your-commit-uuid -t your-project-token
 ```
 
-## Example repo
+### Example Repository
+
+As an example, you can check https://github.com/troubleshoot-codacy/eslint-test-examples for a repository that has an action relying on this CLI.
 
-As an example, that as an action that relies on this CLI, you can check <https://github.com/troubleshoot-codacy/eslint-test-examples>

cli-v2.go

@@ -9,11 +9,13 @@ import (
 )
 
 func main() {
+	fmt.Println("Running original CLI functionality...")
+	// Original functionality
 	config.Init()
 
 	configErr := cfg.ReadConfigFile(config.Config.ProjectConfigFile())
 	// whenever there is no configuration file, the only command allowed to run is the 'init'
-	if configErr != nil && os.Args[1] != "init" {
+	if configErr != nil && len(os.Args) > 1 && os.Args[1] != "init" {
 		fmt.Println("No configuration file was found, execute init command first.")
 		return
 	}