diff --git a/README.md b/README.md index 26b3c27..a5d2574 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ There are some inbuilt helpers for often used things for various DevOps tasks. - [Setup and Teardown methods](../../wiki/Lifetime-Methods) - Output from subprocesses directly visible - [Inbuilt helpers](../../wiki/Tools) for various DevOps tasks -- [VSCode Plugin](https://marketplace.visualstudio.com/items?itemName=Roemer.gotaskr-vscode) to easily run tasks with a single click +- [VS Code Plugin](https://marketplace.visualstudio.com/items?itemName=Roemer.gotaskr-vscode) to easily run tasks with a single click - Even works in existing go repositories (see [build](build) from this repository as an example) ## Visual Studio Code Extension diff --git a/gotaskr.go b/gotaskr.go index cd206ce..7eb31fa 100644 --- a/gotaskr.go +++ b/gotaskr.go @@ -16,7 +16,7 @@ import ( "github.com/roemer/gotaskr/log" ) -// Generate a map that holds all passed arguments from the cli +// Generate a map that holds all passed arguments from the CLI var argumentsMap = argparse.ParseArgs() // Prepare a map for all the task objects diff --git a/gttools/cypress.go b/gttools/cypress.go index ce6ed97..e2f4be7 100644 --- a/gttools/cypress.go +++ b/gttools/cypress.go @@ -28,10 +28,10 @@ const ( // Also see https://docs.cypress.io/guides/guides/command-line#cypress-run type CypressRunSettings struct { ToolSettingsBase - Browser string // defines the browser to launch like chrome, chromium, edge, electron, firefox. Alternatively a path to an executable. + Browser string // defines the browser to launch like Chrome, Chromium, Edge, Electron, Firefox. Alternatively a path to an executable. CiBuildId string // the unique id to group tests together. Component bool // flag to define if component tests should run. - Config string // specify the config to use. Defined as key value pairs, comma separated. Can also be a stringified json object. + Config string // specify the config to use. Defined as key value pairs, comma separated. Can also be a stringified JSON object. ConfigFile string // the path to a config file to use. E2e bool // flag to define if end to end tests should run (default). Env map[string]string // environment variables to use. @@ -45,8 +45,8 @@ type CypressRunSettings struct { Project string // the path to a specific project to run. Quiet bool // flag to indicate the quite mode where no output is passed to stdout. Record bool // flag to indicate if the tests should be recorded or not. - Reporter string // define the reporter to use. Can be any of the mocha, cypress or a custom reporter. - ReporterOptions string // specify the reporter options to use as key value pairs, comma separated. Can also be a stringified json object. + Reporter string // define the reporter to use. Can be any of the Mocha, Cypress or a custom reporter. + ReporterOptions string // specify the reporter options to use as key value pairs, comma separated. Can also be a stringified JSON object. Specs []string // define the spec file(s) to run. Tags []string // add tags to identify a run. } @@ -55,9 +55,9 @@ type CypressRunSettings struct { // Also see https://docs.cypress.io/guides/guides/command-line#cypress-open type CypressOpenSettings struct { ToolSettingsBase - Browser string // defines the browser to launch like chrome, chromium, edge, electron, firefox. Alternatively a path to an executable. + Browser string // defines the browser to launch like chrome, Chromium, Edge, Electron, Firefox. Alternatively a path to an executable. Component bool // flag to define if component tests should run. - Config string // specify the config to use. Defined as key value pairs, comma separated. Can also be a stringified json object. + Config string // specify the config to use. Defined as key value pairs, comma separated. Can also be a stringified JSON object. ConfigFile string // the path to a config file to use. Detached bool // flag to define if Cypress should open in detached mode. E2e bool // flag to define if end to end tests should run (default). diff --git a/gttools/eslint.go b/gttools/eslint.go index 34d5b13..9b97e35 100644 --- a/gttools/eslint.go +++ b/gttools/eslint.go @@ -34,7 +34,7 @@ type EsLintMessage struct { EndColumn int64 `json:"endColumn"` } -// ParseEsLintReport parses the given eslint report (json). +// ParseEsLintReport parses the given eslint report (JSON). func (tool *EsLintTool) ParseEsLintReport(esLintReportPath string) (*EsLintReport, error) { jsonFile, err := os.Open(esLintReportPath) if err != nil { diff --git a/gttools/flyway.go b/gttools/flyway.go index 6a86bb9..258977c 100644 --- a/gttools/flyway.go +++ b/gttools/flyway.go @@ -22,13 +22,13 @@ type FlywaySettings struct { ToolPath string //// Connection - // The jdbc url to use to connect to the database. + // The JDBC URL to use to connect to the database. Url string // The user to use to connect to the database. User string // The password to use to connect to the database. Password string - // The fully qualified class name of the jdbc driver to use to connect to the database. + // The fully qualified class name of the JDBC driver to use to connect to the database. Driver string // The maximum number of retries when attempting to connect to the database. ConnectRetries *int @@ -68,9 +68,9 @@ type FlywaySettings struct { OutOfOrder *bool // Filename for the report file. ReportFilename string - // Whether default built-in callbacks (sql) should be skipped. + // Whether default built-in callbacks (SQL) should be skipped. SkipDefaultCallbacks *bool - // Whether default built-in resolvers (sql and jdbc) should be skipped. + // Whether default built-in resolvers (SQL and JDBC) should be skipped. SkipDefaultResolvers *bool // The name of Flyway's schema history table. Table string @@ -114,7 +114,7 @@ type FlywaySettings struct { Resolvers []string // The file name prefix for versioned SQL migrations. SqlMigrationPrefix string - // The file name separator for Sql migrations. + // The file name separator for SQL migrations. SqlMigrationSeparator string // List of file name suffixes for SQL migrations. SqlMigrationSuffixes []string diff --git a/gttools/gitlab.go b/gttools/gitlab.go index 95abac7..8ef1844 100644 --- a/gttools/gitlab.go +++ b/gttools/gitlab.go @@ -35,7 +35,7 @@ type GitLabCodeQualityLines struct { End int64 `json:"end"` } -// IsRunningOnGitLab returns a flag, if we are currently running on gitlab +// IsRunningOnGitLab returns a flag, if we are currently running on GitLab. func (tool *GitLabTool) IsRunningOnGitLab() bool { return goext.EnvExists("GITLAB_CI") } @@ -76,7 +76,7 @@ func (tool *GitLabTool) MergeGitLabReports(gitLabReports []*GitLabReport) *GitLa return gitLabReport } -// WriteGitLabReport writes the GitLabReport into a json file. +// WriteGitLabReport writes the GitLabReport into a JSON file. func (tool *GitLabTool) WriteGitLabReport(gitLabReport *GitLabReport, outputFilePath string) error { return goext.WriteJsonToFile(gitLabReport.Entries, outputFilePath, true) }