Merge pull request #320 from codacy/am/feat/support-analyze-CY2939

breaking: Change spelling of the `analyse` command to `analyze` [CY-2939]

Author: afsmeira

README.md

@@ -105,15 +105,15 @@ cd codacy-analysis-cli-* && sudo make install
 ### Script
 
 ```sh
-codacy-analysis-cli analyse \
+codacy-analysis-cli analyze \
   --tool <TOOL-SHORT-NAME> \
   --directory <SOURCE-CODE-PATH>
 ```
 
 ### Java
 
 ```
-java -jar codacy-analysis-cli-assembly-{VERSION}.jar analyse \
+java -jar codacy-analysis-cli-assembly-{VERSION}.jar analyze \
   --tool <TOOL-SHORT-NAME> \
   --directory <SOURCE-CODE-PATH> \
   # other options
@@ -122,7 +122,7 @@ java -jar codacy-analysis-cli-assembly-{VERSION}.jar analyse \
 ### Local
 
 ```sh
-sbt "codacyAnalysisCli/runMain com.codacy.analysis.cli.Main analyse --tool <TOOL-SHORT-NAME> --directory <SOURCE-CODE-PATH>"
+sbt "codacyAnalysisCli/runMain com.codacy.analysis.cli.Main analyze --tool <TOOL-SHORT-NAME> --directory <SOURCE-CODE-PATH>"
 ```
 
 ### Docker
@@ -135,7 +135,7 @@ docker run \
   --volume "$CODACY_CODE":"$CODACY_CODE" \
   --volume /tmp:/tmp \
   codacy/codacy-analysis-cli \
-    analyse --tool <TOOL-SHORT-NAME>
+    analyze --tool <TOOL-SHORT-NAME>
 ```
 
 
@@ -202,10 +202,10 @@ Found [Clone] 7 duplicated lines with 10 tokens:
 
 ### Commands and Configuration
 
-* `analyse` - Run a Codacy analysis over a directory/files
+* `analyze` - Run a Codacy analysis over a directory/files
     * `--help` - Displays all the configuration options, their meaning and possible values.
     * `--verbose` - Run the tool with verbose output
-    * `--tool` - Choose the tool to analyse the code (e.g. brakeman)
+    * `--tool` - Choose the tool to analyze the code (e.g. brakeman)
     * `--directory` - Choose the directory to be analysed
     * `--codacy-api-base-url` or env.`CODACY_API_BASE_URL` - Change the Codacy installation API URL to retrieve the configuration (e.g. Enterprise installation)
     * `--output` - Send the output results to a file
@@ -244,7 +244,7 @@ You can find the project token in:
 * `Project -> Settings -> Integrations -> Add Integration -> Project API`
 
 ```sh
-codacy-analysis-cli analyse \
+codacy-analysis-cli analyze \
   --project-token <PROJECT-TOKEN> \
   --tool <TOOL-SHORT-NAME> \
   --directory <SOURCE-CODE-PATH>
@@ -260,7 +260,7 @@ You can find the project token in:
 The username and project name can be retrieved from the URL in Codacy.
 
 ```sh
-codacy-analysis-cli analyse \
+codacy-analysis-cli analyze \
   --api-token <PROJECT-TOKEN> \
   --username <USERNAME> \
   --project <PROJECT-NAME> \
@@ -340,6 +340,11 @@ sbt codacyCoverage
         sbt 'set version in codacyAnalysisCore := "<VERSION>"' 'set pgpPassphrase := Some("<SONATYPE_GPG_PASSPHRASE>".toCharArray)' codacyAnalysisCore/publishSigned
         sbt 'set version in codacyAnalysisCore := "<VERSION>"' sonatypeRelease
 
+## Breaking Changes
+
+- 4.0.0 - Rename `analyse` command to `analyze`. This is a breaking change if you are running the CLI by using the
+  [jar](#java) or [`sbt`](#local), but not if you are using the [provided script](#script).
+
 ## What is Codacy
 
 [Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

bin/codacy-analysis-cli.sh

@@ -60,7 +60,7 @@ analysis_file() {
       *)
         if [ ${is_filename} -eq 1 ]; then
           if [ -n "$filename" ]; then
-            echo "Please provide only one file or directory to analyse" >&2
+            echo "Please provide only one file or directory to analyze" >&2
             exit 1
           else
             is_filename=0
@@ -104,7 +104,11 @@ prep_args_with_output_absolute_path() {
             new_args="${new_args} ${OUTPUT}"
           fi
         else
-          new_args="${new_args} ${arg}"
+          if [ ${arg} == "analyse" ]; then
+            new_args="${new_args} analyze"
+          else
+            new_args="${new_args} ${arg}"
+          fi
         fi
         ;;
     esac

build.sbt

@@ -48,7 +48,7 @@ lazy val codacyAnalysisCore = project
     // Test Dependencies
     libraryDependencies ++= Dependencies.specs2,
     sonatypeInformation,
-    description := "Library to analyse projects")
+    description := "Library to analyze projects")
   .settings(assemblyCommon: _*)
   // Disable legacy Scalafmt plugin imported by codacy-sbt-plugin
   .disablePlugins(com.lucidchart.sbt.scalafmt.ScalafmtCorePlugin)

cli/src/main/scala/com/codacy/analysis/cli/Main.scala

@@ -5,7 +5,7 @@ import com.codacy.analysis.cli.command.{AnalyseCommand, CLIApp, _}
 
 object Main extends MainImpl()
 
-class MainImpl(analyseCommand: Analyse => AnalyseCommand = AnalyseCommand(_, sys.env),
+class MainImpl(analyseCommand: Analyze => AnalyseCommand = AnalyseCommand(_, sys.env),
                validateConfigurationCommand: ValidateConfiguration => ValidateConfigurationCommand =
                  ValidateConfigurationCommand(_))
     extends CLIApp {
@@ -16,7 +16,7 @@ class MainImpl(analyseCommand: Analyse => AnalyseCommand = AnalyseCommand(_, sys
 
   def runCommand(command: CommandOptions): ExitStatus.ExitCode = {
     command match {
-      case analyse: Analyse => analyseCommand(analyse).run()
+      case analyze: Analyze => analyseCommand(analyze).run()
       case validateConfiguration: ValidateConfiguration =>
         validateConfigurationCommand(validateConfiguration).run()
     }

cli/src/main/scala/com/codacy/analysis/cli/command/AnalyseCommand.scala

@@ -33,38 +33,38 @@ import scala.util.{Failure, Success, Try}
 
 object AnalyseCommand {
 
-  def apply(analyse: Analyse, env: Map[String, String]): AnalyseCommand = {
+  def apply(analyze: Analyze, env: Map[String, String]): AnalyseCommand = {
     val environment: Environment = new Environment(env)
     val codacyClientOpt: Option[CodacyClient] =
-      Credentials.get(environment, analyse.api).map(CodacyClient.apply)
+      Credentials.get(environment, analyze.api).map(CodacyClient.apply)
     val configuration: CLIConfiguration =
-      CLIConfiguration(codacyClientOpt, environment, analyse, new CodacyConfigurationFileLoader)
+      CLIConfiguration(codacyClientOpt, environment, analyze, new CodacyConfigurationFileLoader)
     val formatter: Formatter =
-      Formatter(configuration.analysis.output, environment.baseProjectDirectory(analyse.directory))
+      Formatter(configuration.analysis.output, environment.baseProjectDirectory(analyze.directory))
     val fileCollector: FileCollector[Try] = FileCollector.defaultCollector()
     val analyseExecutor: AnalyseExecutor =
-      new AnalyseExecutor(formatter, Analyser(analyse.extras.analyser), fileCollector, configuration.analysis)
+      new AnalyseExecutor(formatter, Analyser(analyze.extras.analyser), fileCollector, configuration.analysis)
     val uploaderOpt: Either[String, Option[ResultsUploader]] =
       ResultsUploader(codacyClientOpt, configuration.upload.upload, configuration.upload.commitUuid)
 
-    new AnalyseCommand(analyse, configuration, analyseExecutor, uploaderOpt)
+    new AnalyseCommand(analyze, configuration, analyseExecutor, uploaderOpt)
   }
 }
 
-class AnalyseCommand(analyse: Analyse,
+class AnalyseCommand(analyze: Analyze,
                      configuration: CLIConfiguration,
                      analyseExecutor: AnalyseExecutor,
                      uploaderOpt: Either[String, Option[ResultsUploader]]) {
 
-  Logger.setLevel(analyse.options.verboseValue)
+  Logger.setLevel(analyze.options.verboseValue)
 
   private val logger: org.log4s.Logger = getLogger
 
   def run(): ExitStatus.ExitCode = {
     removeCodacyRuntimeConfigurationFiles(configuration.analysis.projectDirectory)
 
     val analysisAndUpload = for {
-      _ <- validate(analyse, configuration)
+      _ <- validate(analyze, configuration)
       analysisResults <- analyseExecutor.run()
       _ <- upload(configuration.upload, analysisResults)
     } yield analysisResults
@@ -75,7 +75,7 @@ class AnalyseCommand(analyse: Analyse,
       .exitCode(analysisAndUpload)
   }
 
-  private def validate(analyse: Analyse, configuration: CLIConfiguration): Either[CLIError, Unit] = {
+  private def validate(analyze: Analyze, configuration: CLIConfiguration): Either[CLIError, Unit] = {
     Git
       .repository(configuration.analysis.projectDirectory)
       .fold(
@@ -85,7 +85,7 @@ class AnalyseCommand(analyse: Analyse,
         { repository =>
           for {
             _ <- validateNoUncommitedChanges(repository, configuration.upload.upload)
-            _ <- validateGitCommitUuid(repository, analyse.commitUuid)
+            _ <- validateGitCommitUuid(repository, analyze.commitUuid)
           } yield ()
         })
   }

cli/src/main/scala/com/codacy/analysis/cli/command/CLIApp.scala

@@ -120,14 +120,14 @@ final case class ExtraOptions(
   @Hidden @ValueDescription(s"The analyser to use. (${Analyser.allAnalysers.map(_.name).mkString(", ")})")
   analyser: String = Analyser.defaultAnalyser.name)
 
-final case class Analyse(
+final case class Analyze(
   @Recurse
   options: CommonOptions,
   @Recurse
   api: APIOptions,
-  @ExtraName("t") @ValueDescription(s"The tool to analyse the code. (${Tool.allToolShortNames.mkString(", ")})")
+  @ExtraName("t") @ValueDescription(s"The tool to analyze the code. (${Tool.allToolShortNames.mkString(", ")})")
   tool: Option[String],
-  @ExtraName("d") @ValueDescription("The directory to analyse.")
+  @ExtraName("d") @ValueDescription("The directory to analyze.")
   directory: Option[File],
   @ExtraName("f") @ValueDescription(s"The output format. (${Formatter.allFormatters.map(_.name).mkString(", ")})")
   format: String = Formatter.defaultFormatter.name,

cli/src/main/scala/com/codacy/analysis/cli/configuration/CLIConfiguration.scala

@@ -3,7 +3,7 @@ package com.codacy.analysis.cli.configuration
 import better.files.File
 import cats.Foldable
 import cats.implicits._
-import com.codacy.analysis.cli.command.Analyse
+import com.codacy.analysis.cli.command.Analyze
 import com.codacy.analysis.core.clients.CodacyClient
 import com.codacy.analysis.core.clients.api._
 import com.codacy.analysis.core.configuration.{
@@ -41,22 +41,22 @@ object CLIConfiguration {
   object Analysis {
 
     def apply(projectDirectory: File,
-              analyse: Analyse,
+              analyze: Analyze,
               localConfiguration: Either[String, CodacyConfigurationFile],
               remoteProjectConfiguration: Either[String, ProjectConfiguration],
               tmpDirectory: Option[File]): Analysis = {
 
       val fileExclusionRules =
         CLIConfiguration.FileExclusionRules(localConfiguration, remoteProjectConfiguration)
-      val output = CLIConfiguration.Output(analyse.format, analyse.output, analyse.ghCodeScanningCompatValue)
+      val output = CLIConfiguration.Output(analyze.format, analyze.output, analyze.ghCodeScanningCompatValue)
       val toolConfiguration =
-        CLIConfiguration.Tool(analyse, localConfiguration, remoteProjectConfiguration)
+        CLIConfiguration.Tool(analyze, localConfiguration, remoteProjectConfiguration)
       CLIConfiguration.Analysis(
         projectDirectory,
         output,
-        analyse.tool,
-        analyse.parallel,
-        analyse.forceFilePermissionsValue,
+        analyze.tool,
+        analyze.parallel,
+        analyze.forceFilePermissionsValue,
         fileExclusionRules,
         toolConfiguration,
         tmpDirectory)
@@ -124,7 +124,7 @@ object CLIConfiguration {
 
   object Tool {
 
-    def apply(analyse: Analyse,
+    def apply(analyze: Analyze,
               localConfiguration: Either[String, CodacyConfigurationFile],
               remoteProjectConfiguration: Either[String, ProjectConfiguration]): CLIConfiguration.Tool = {
 
@@ -141,8 +141,8 @@ object CLIConfiguration {
         localConfiguration.map(_.languageCustomExtensions).getOrElse(Map.empty[Language, Set[String]])
 
       CLIConfiguration.Tool(
-        analyse.toolTimeout,
-        analyse.allowNetworkValue,
+        analyze.toolTimeout,
+        analyze.allowNetworkValue,
         toolConfigurations,
         enginesConfiguration,
         languageExtensions)
@@ -191,11 +191,11 @@ object CLIConfiguration {
 
   def apply(clientOpt: Option[CodacyClient],
             environment: Environment,
-            analyse: Analyse,
+            analyze: Analyze,
             localConfigLoader: CodacyConfigurationFileLoader): CLIConfiguration = {
-    val projectDirectory: File = environment.baseProjectDirectory(analyse.directory)
+    val projectDirectory: File = environment.baseProjectDirectory(analyze.directory)
     val commitUuid: Option[Commit.Uuid] =
-      analyse.commitUuid.orElse(Git.currentCommitUuid(projectDirectory))
+      analyze.commitUuid.orElse(Git.currentCommitUuid(projectDirectory))
 
     val localConfiguration: Either[String, CodacyConfigurationFile] =
       localConfigLoader.load(projectDirectory)
@@ -205,9 +205,9 @@ object CLIConfiguration {
       _.getRemoteConfiguration
     }
     val analysisConfiguration =
-      Analysis(projectDirectory, analyse, localConfiguration, remoteProjectConfiguration, analyse.tmpDirectory)
-    val uploadConfiguration = Upload(commitUuid, analyse.uploadValue)
-    val resultConfiguration = Result(analyse.maxAllowedIssues, analyse.failIfIncompleteValue)
+      Analysis(projectDirectory, analyze, localConfiguration, remoteProjectConfiguration, analyze.tmpDirectory)
+    val uploadConfiguration = Upload(commitUuid, analyze.uploadValue)
+    val resultConfiguration = Result(analyze.maxAllowedIssues, analyze.failIfIncompleteValue)
 
     CLIConfiguration(analysisConfiguration, uploadConfiguration, resultConfiguration)
   }

cli/src/test/scala/com/codacy/analysis/cli/AnalyseExecutorSpec.scala

@@ -26,7 +26,7 @@ class AnalyseExecutorSpec extends Specification with NoLanguageFeatures with Moc
     val pyLintPatternsInternalIds = Set("PyLint_C0111", "PyLint_E1101")
     val pathToIgnore = "lib/improver/tests/"
 
-    s"""|analyse a python project with pylint, using a remote project configuration retrieved with a project token
+    s"""|analyze a python project with pylint, using a remote project configuration retrieved with a project token
         | that ignores the files that start with the path $pathToIgnore
         | and considers just patterns ${pyLintPatternsInternalIds.mkString(", ")}""".stripMargin in {
       val commitUuid = "9232dbdcae98b19412c8dd98c49da8c391612bfa"
@@ -75,7 +75,7 @@ class AnalyseExecutorSpec extends Specification with NoLanguageFeatures with Moc
     val esLintPatternsInternalIds =
       Set("ESLint_semi", "ESLint_no-undef", "ESLint_indent", "ESLint_no-empty")
 
-    s"""|analyse a javascript project with eslint, using a remote project configuration retrieved with an api token
+    s"""|analyze a javascript project with eslint, using a remote project configuration retrieved with an api token
         | that considers just patterns ${esLintPatternsInternalIds.mkString(", ")}""".stripMargin in {
       val commitUuid = "9232dbdcae98b19412c8dd98c49da8c391612bfa"
       withClonedRepo("git://github.com/qamine-test/Monogatari.git", commitUuid) { (file, directory) =>
@@ -116,7 +116,7 @@ class AnalyseExecutorSpec extends Specification with NoLanguageFeatures with Moc
 
     val cssLintPatternsInternalIds = Set("CSSLint_important")
 
-    "analyse a javascript and css project" in {
+    "analyze a javascript and css project" in {
       val commitUuid = "9232dbdcae98b19412c8dd98c49da8c391612bfa"
       withClonedRepo("git://github.com/qamine-test/Monogatari.git", commitUuid) { (file, directory) =>
         val configuration = analysisConfiguration(