From f1f0056a90563852360022b37c4062f06f635e9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Tue, 9 Nov 2021 22:02:24 +0200 Subject: [PATCH] Spelling fixes (#717) --- README.md | 2 +- analyzer.go | 2 +- cmd/gosec/sort_issues_test.go | 14 +++++++------- errors.go | 2 +- report/sarif/types.go | 16 ++++++++-------- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e6c969b..59323d5 100644 --- a/README.md +++ b/README.md @@ -358,7 +358,7 @@ Then generate the types with : schema-generate -i sarif-schema-2.1.0.json -o mypath/types.go ``` -Most of the MarshallJSON/UnmarshalJSON are removed except the one for PropertyBag which is handy to inline the additionnal properties. The rest can be removed. +Most of the MarshallJSON/UnmarshalJSON are removed except the one for PropertyBag which is handy to inline the additional properties. The rest can be removed. The URI,ID, UUID, GUID were renamed so it fits the Golang convention defined [here](https://github.com/golang/lint/blob/master/lint.go#L700) ### Tests diff --git a/analyzer.go b/analyzer.go index a295168..3809bdc 100644 --- a/analyzer.go +++ b/analyzer.go @@ -113,7 +113,7 @@ func NewAnalyzer(conf Config, tests bool, excludeGenerated bool, logger *log.Log } } -// SetConfig upates the analyzer configuration +// SetConfig updates the analyzer configuration func (gosec *Analyzer) SetConfig(conf Config) { gosec.config = conf } diff --git a/cmd/gosec/sort_issues_test.go b/cmd/gosec/sort_issues_test.go index 6b4bfc7..d98c71d 100644 --- a/cmd/gosec/sort_issues_test.go +++ b/cmd/gosec/sort_issues_test.go @@ -38,7 +38,7 @@ func firstIsGreater(less, greater *gosec.Issue) { } var _ = Describe("Sorting by Severity", func() { - It("sortes by severity", func() { + It("sorts by severity", func() { less := createIssue() less.Severity = gosec.Low greater := createIssue() @@ -46,8 +46,8 @@ var _ = Describe("Sorting by Severity", func() { firstIsGreater(&less, &greater) }) - Context("Serverity is same", func() { - It("sortes by What", func() { + Context("Severity is same", func() { + It("sorts by What", func() { less := createIssue() less.What = "test1" greater := createIssue() @@ -56,8 +56,8 @@ var _ = Describe("Sorting by Severity", func() { }) }) - Context("Serverity and What is same", func() { - It("sortes by File", func() { + Context("Severity and What is same", func() { + It("sorts by File", func() { less := createIssue() less.File = "test1" greater := createIssue() @@ -67,8 +67,8 @@ var _ = Describe("Sorting by Severity", func() { }) }) - Context("Serverity, What and File is same", func() { - It("sortes by line number", func() { + Context("Severity, What and File is same", func() { + It("sorts by line number", func() { less := createIssue() less.Line = "1" greater := createIssue() diff --git a/errors.go b/errors.go index a27aa58..2f66727 100644 --- a/errors.go +++ b/errors.go @@ -20,7 +20,7 @@ func NewError(line, column int, err string) *Error { } } -// sortErros sorts the golang erros by line +// sortErrors sorts the golang errors by line func sortErrors(allErrors map[string][]Error) { for _, errors := range allErrors { sort.Slice(errors, func(i, j int) bool { diff --git a/report/sarif/types.go b/report/sarif/types.go index db49bd1..a341c39 100644 --- a/report/sarif/types.go +++ b/report/sarif/types.go @@ -269,7 +269,7 @@ type ExternalProperties struct { // An array of graph objects that will be merged with a separate run. Graphs []*Graph `json:"graphs,omitempty"` - // A stable, unique identifer for this external properties object, in the form of a GUID. + // A stable, unique identifier for this external properties object, in the form of a GUID. GUID string `json:"guid,omitempty"` // Describes the invocation of the analysis tool that will be merged with a separate run. @@ -287,7 +287,7 @@ type ExternalProperties struct { // An array of result objects that will be merged with a separate run. Results []*Result `json:"results,omitempty"` - // A stable, unique identifer for the run associated with this external properties object, in the form of a GUID. + // A stable, unique identifier for the run associated with this external properties object, in the form of a GUID. RunGUID string `json:"runGuid,omitempty"` // The URI of the JSON schema corresponding to the version of the external property file format. @@ -315,7 +315,7 @@ type ExternalProperties struct { // ExternalPropertyFileReference Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run. type ExternalPropertyFileReference struct { - // A stable, unique identifer for the external property file in the form of a GUID. + // A stable, unique identifier for the external property file in the form of a GUID. GUID string `json:"guid,omitempty"` // A non-negative integer specifying the number of items contained in the external property file. @@ -801,7 +801,7 @@ type ReportingDescriptor struct { // A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result. FullDescription *MultiformatMessageString `json:"fullDescription,omitempty"` - // A unique identifer for the reporting descriptor in the form of a GUID. + // A unique identifier for the reporting descriptor in the form of a GUID. GUID string `json:"guid,omitempty"` // Provides the primary documentation for the report, useful when there is no online documentation. @@ -894,7 +894,7 @@ type Result struct { // An array of zero or more unique graph objects associated with the result. Graphs []*Graph `json:"graphs,omitempty"` - // A stable, unique identifer for the result in the form of a GUID. + // A stable, unique identifier for the result in the form of a GUID. GUID string `json:"guid,omitempty"` // An absolute URI at which the result can be viewed. @@ -1080,7 +1080,7 @@ type RunAutomationDetails struct { // A description of the identity and role played within the engineering system by this object's containing run object. Description *Message `json:"description,omitempty"` - // A stable, unique identifer for this object's containing run object in the form of a GUID. + // A stable, unique identifier for this object's containing run object in the form of a GUID. GUID string `json:"guid,omitempty"` // A hierarchical string that uniquely identifies this object's containing run object. @@ -1154,7 +1154,7 @@ type Report struct { // Suppression A suppression that is relevant to a result. type Suppression struct { - // A stable, unique identifer for the suprression in the form of a GUID. + // A stable, unique identifier for the suprression in the form of a GUID. GUID string `json:"guid,omitempty"` // A string representing the justification for the suppression. @@ -1278,7 +1278,7 @@ type ToolComponent struct { // A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments. GlobalMessageStrings map[string]*MultiformatMessageString `json:"globalMessageStrings,omitempty"` - // A unique identifer for the tool component in the form of a GUID. + // A unique identifier for the tool component in the form of a GUID. GUID string `json:"guid,omitempty"` // The absolute URI at which information about this version of the tool component can be found.