typos suggestion (#477)

* chore: fix acronyms and registered brands

* chore: fix typos and style

* chore: fix British style

Author: ccoVeille

README.md

@@ -45,7 +45,7 @@ A [snap install](https://snapcraft.io/scc) exists thanks to [Ricardo](https://fe
 
 #### Homebrew
 
-Or if you have [homebrew](https://brew.sh/) installed
+Or if you have [Homebrew](https://brew.sh/) installed
 
 `$ brew install scc`
 
@@ -166,8 +166,8 @@ Interesting reading about other code counting projects tokei, loc, polyglot and
 Further reading about processing files on the disk performance
 
  - https://blog.burntsushi.net/ripgrep/
- 
-Using `scc` to process 40 TB of files from Github/Bitbucket/Gitlab
+
+Using `scc` to process 40 TB of files from GitHub/Bitbucket/GitLab
 
  - https://boyter.org/posts/an-informal-survey-of-10-million-github-bitbucket-gitlab-projects/
 
@@ -187,7 +187,7 @@ Why use `scc`?
  - Able to identify many #! files ADVANCED! https://github.com/boyter/scc/issues/115
  - Can ignore large files by lines or bytes
  - Can calculate the ULOC or unique lines of code by file, language or project
- - Supports multiple output formats for integration, csv, sql, json, html and more
+ - Supports multiple output formats for integration, CSV, SQL, JSON, HTML and more
 
 Why not use `scc`?
 
@@ -402,7 +402,7 @@ The increment happens for each of the matching conditions and produces the numbe
 ### Unique Lines of Code (ULOC)
 
 ULOC stands for Unique Lines of Code and represents the unique lines across languages, files and the project itself. This idea was taken from
-https://cmcenroe.me/2018/12/14/uloc.html where the calculation is presented using standard unix tools `sort -u *.h *.c | wc -l`. This metric is 
+https://cmcenroe.me/2018/12/14/uloc.html where the calculation is presented using standard Unix tools `sort -u *.h *.c | wc -l`. This metric is
 there to assist with the estimation of complexity within the project. Quoting the source
 
 > In my opinion, the number this produces should be a better estimate of the complexity of a project. Compared to SLOC, not only are blank lines discounted, but so are close-brace lines and other repetitive code such as common includes. On the other hand, ULOC counts comments, which require just as much maintenance as the code around them does, while avoiding inflating the result with license headers which appear in every file, for example.
@@ -440,7 +440,7 @@ Processed 8407821 bytes, 8.408 megabytes (SI)
 ───────────────────────────────────────────────────────────────────────────────
 ```
 
-Futher reading about the ULOC caluclation can be found at https://boyter.org/posts/sloc-cloc-code-new-metic-uloc/
+Further reading about the ULOC calculation can be found at https://boyter.org/posts/sloc-cloc-code-new-metic-uloc/
 
 ### COCOMO
 
@@ -553,7 +553,7 @@ Note that in all cases if the remap rule does not apply normal #! rules will app
 
 ### Output Formats
 
-By default `scc` will output to the console. However you can produce output in other formats if you require.
+By default `scc` will output to the console. However, you can produce output in other formats if you require.
 
 The different options are `tabular, wide, json, csv, csv-stream, cloc-yaml, html, html-table, sql, sql-insert, openmetrics`. 
 
@@ -562,7 +562,7 @@ write your output to. For example `scc -f html -o output.html` will run `scc` ag
 the results in html to the file `output.html`.
 
 You can also write to multiple output files, or multiple types to stdout if you want using the `--format-multi` option. This is 
-most useful when working in CI/CD systems where you want HTML reports as an artefact while also displaying the counts in stdout. 
+most useful when working in CI/CD systems where you want HTML reports as an artifact while also displaying the counts in stdout. 
 
 ```
 scc --format-multi "tabular:stdout,html:output.html,csv:output.csv"
@@ -757,7 +757,7 @@ scc_bytes{language="Go",file="./bbbb.go"} 1000
 
 Generally `scc` will the fastest code counter compared to any I am aware of and have compared against. The below comparisons are taken from the fastest alternative counters. See `Other similar projects` above to see all of the other code counters compared against. It is designed to scale to as many CPU's cores as you can provide.
 
-However if you want greater performance and you have RAM to spare you can disable the garbage collector like the following on linux `GOGC=-1 scc .` which should speed things up considerably. For some repositories turning off the code complexity calculation via `-c` can reduce runtime as well.
+However if you want greater performance and you have RAM to spare you can disable the garbage collector like the following on Linux `GOGC=-1 scc .` which should speed things up considerably. For some repositories turning off the code complexity calculation via `-c` can reduce runtime as well.
 
 Benchmarks are run on fresh 32 Core CPU Optimised Digital Ocean Virtual Machine 2022/09/20 all done using [hyperfine](https://github.com/sharkdp/hyperfine) with 3 warm-up runs and 10 timed runs.
 
@@ -899,7 +899,7 @@ The `--format-multi` option is especially useful in CI/CD where you want to get
 
 If you want to hack away feel free! PR's are accepted. Some things to keep in mind. If you want to change a language definition you need to update `languages.json` and then run `go generate` which will convert it into the `processor/constants.go` file.
 
-For all other changes ensure you run all tests before submitting. You can do so using `go test ./...`. However for maximum coverage please run `test-all.sh` which will run `gofmt`, unit tests, race detector and then all of the integration tests. All of those must pass to ensure a stable release.
+For all other changes ensure you run all tests before submitting. You can do so using `go test ./...`. However, for maximum coverage please run `test-all.sh` which will run `gofmt`, unit tests, race detector and then all of the integration tests. All of those must pass to ensure a stable release.
 
 ### API Support
 
@@ -987,7 +987,7 @@ Packaging as of version v3.1.0 is done through https://goreleaser.com/
 
 Note if you plan to run `scc` in Alpine containers you will need to build with CGO_ENABLED=0.
 
-See the below dockerfile as an example on how to achieve this based on this issue https://github.com/boyter/scc/issues/208
+See the below Dockerfile as an example on how to achieve this based on this issue https://github.com/boyter/scc/issues/208
 
 ```
 FROM golang as scc-get
@@ -1043,10 +1043,10 @@ You can find the source code for badges in the repository at https://github.com/
 
 #### A example for each supported provider
 
-- github - https://sloc.xyz/github/boyter/scc/
+- Github - https://sloc.xyz/github/boyter/scc/
 - sr.ht - https://sloc.xyz/sr.ht/~nektro/magnolia-desktop/
-- bitbucket - https://sloc.xyz/bitbucket/boyter/decodingcaptchas
-- gitlab - https://sloc.xyz/gitlab/esr/loccount
+- Bitbucket - https://sloc.xyz/bitbucket/boyter/decodingcaptchas
+- Gitlab - https://sloc.xyz/gitlab/esr/loccount
 
 ### Languages
 

cmd/badges/example.py

@@ -57,7 +57,7 @@ def lambda_handler(event, context):
             title = 'Blank lines'
             s = format_count(sum([x['Blank'] for x in j]))
         elif t == 'lines':
-            pass # its the default anyway
+            pass # it's the default anyway
         elif t == 'comments':
             title = 'Comments'
             s = format_count(sum([x['Comment'] for x in j]))

examples/issue339/matlab.m

@@ -357,7 +357,7 @@
     s = char(s) ;
     total = 0 ;
 
-    % initialize stats stucture with same fields and same order as
+    % initialize stats structure with same fields and same order as
     % stats_{1}
     stats__ = stats_{1} ;
     names = fieldnames(stats__.(s))' ;

examples/language/fsl.fsl

@@ -33,7 +33,7 @@ Start -> "Is your Twitter for personal or business use?";
 "Does your boss follow you?" 'Yes'
     -> "Get off Twitter";
 "Does your boss follow you?" 'No'
-    -> "Are you just using Twitter to stalk celebrites?" -> "Get off Twitter and seek help";
+    -> "Are you just using Twitter to stalk celebrities?" -> "Get off Twitter and seek help";
 
 "Are a majority of your tweets interesting,\n funny, or thought-provoking?" 'No, they are mostly pics of my lunch or my cat'
     -> "Are you a celebrity";
@@ -90,7 +90,7 @@ Start -> "Is your Twitter for personal or business use?";
  "Wait - Are you spam or a bot?" <- 'Yes' "You understand what Twitter is, right?";
 
  "How often do you tweet?" 'Hardly ever'
-    -> "Are you just using Twitter to stalk celebrites?";
+    -> "Are you just using Twitter to stalk celebrities?";
  "How often do you tweet?" '15 times a month'
     -> "Do you only keep your twitter account\n for the rush you feel when your tweet is retweeted?";
  "How often do you tweet?" 'Almost everyday'

examples/language/graphql.graphql

@@ -21009,7 +21009,7 @@ type MergeQueueConfiguration {
   minimumEntriesToMerge: Int
 
   """
-  The amount of time in minutes to wait before ignoring the minumum number of
+  The amount of time in minutes to wait before ignoring the minimum number of
   entries in the queue requirement and merging a collection of entries
   """
   minimumEntriesToMergeWaitTime: Int
@@ -54812,12 +54812,12 @@ enum ThreadSubscriptionState {
   IGNORING_THREAD
 
   """
-  The User is not recieving notifications from this thread
+  The User is not receiving notifications from this thread
   """
   NONE
 
   """
-  The User is notified becuase they are watching the list
+  The User is notified because they are watching the list
   """
   SUBSCRIBED_TO_LIST
 

processor/bloom.go

@@ -25,7 +25,7 @@ func BloomHash(b byte) uint64 {
 	// The logic here is to slice a value between 0 and 63 from k, and set a
 	// single bit in the output hash based on that.
 	// Setting three bits this way seems to give the best results. Fewer bits
-	// makes the hash not unique enough, more leads to overcrowding the bloom
+	// make the hash not unique enough, more leads to overcrowding the bloom
 	// filter.
 	var hash uint64
 	for i := uint64(0); i < 3; i++ {

processor/detector.go

@@ -107,7 +107,7 @@ func scanForSheBang(content []byte) (string, error) {
 				candidate1 = string(content[lastSlash+1 : i+1])
 			}
 
-			// between last slash and here is the first candidate which is either env or perl/php/python etc..
+			// between last slash and here is the first candidate which is either env or Perl/PHP/Python etc..
 			if isWhitespace(content[i]) {
 				// mark from lastSlash to here as first argument
 				candidate1 = string(content[lastSlash+1 : i])
@@ -151,7 +151,7 @@ type languageGuess struct {
 // DetermineLanguage given a filename, fallback language, possible languages and content make a guess to the type.
 // If multiple possible it will guess based on keywords similar to how https://github.com/vmchale/polyglot does
 func DetermineLanguage(filename string, fallbackLanguage string, possibleLanguages []string, content []byte) string {
-	// If being called through an API its possible nothing is set here and as
+	// If being called through an API it's possible nothing is set here and as
 	// such should just return as the Language value should have already been set
 	if len(possibleLanguages) == 0 {
 		return fallbackLanguage
@@ -192,7 +192,7 @@ func DetermineLanguage(filename string, fallbackLanguage string, possibleLanguag
 		// and as such the default fallback if we don't find a suitable number of matching
 		// keywords
 		// consider YAML files for example, where cloudformation files can also be YAML
-		// YAML can have any form so its not possible to say "this is a yaml file"
+		// YAML can have any form so it's not possible to say "this is a yaml file"
 		// so we can only say "this is likely to be a cloudformation file", and as such
 		// we need to handle a fallback case, which in this case is nothing
 		if len(langFeatures.Keywords) == 0 {

processor/file.go

@@ -15,7 +15,7 @@ import (
 var extensionCache sync.Map
 
 // A custom version of extracting extensions for a file
-// which also has a case insensitive cache in order to save
+// which also has a case-insensitive cache in order to save
 // some needless processing
 func getExtension(name string) string {
 	name = strings.ToLower(name)

processor/formatters.go

@@ -314,7 +314,7 @@ func toCSVSummary(input chan *FileJob) string {
 	}
 
 	// Cater for the common case of adding plural even for those options that don't make sense
-	// as its quite common for those who English is not a first language to make a simple mistake
+	// as it's quite common for those who English is not a first language to make a simple mistake
 	switch {
 	case SortBy == "name" || SortBy == "names" || SortBy == "language" || SortBy == "languages":
 		sort.Slice(records, func(i, j int) bool {
@@ -405,7 +405,7 @@ func toCSVFiles(input chan *FileJob) string {
 	}
 
 	// Cater for the common case of adding plural even for those options that don't make sense
-	// as its quite common for those who English is not a first language to make a simple mistake
+	// as it's quite common for those who English is not a first language to make a simple mistake
 	switch {
 	case SortBy == "name" || SortBy == "names":
 		sort.Slice(records, func(i, j int) bool {
@@ -861,7 +861,7 @@ func fileSummarizeMulti(input chan *FileJob) string {
 				val = toCSV(i)
 			case "csv-stream":
 				val = toCSVStream(i)
-				// special case where we want to ignore writing to stdout ot disk as its already done
+				// special case where we want to ignore writing to stdout to disk as it's already done
 				continue
 			case "html":
 				val = toHtml(i)
@@ -964,7 +964,7 @@ func fileSummarizeLong(input chan *FileJob) string {
 	}
 
 	// Cater for the common case of adding plural even for those options that don't make sense
-	// as its quite common for those who English is not a first language to make a simple mistake
+	// as it's quite common for those who English is not a first language to make a simple mistake
 	switch {
 	case SortBy == "name" || SortBy == "names" || SortBy == "language" || SortBy == "langs":
 		sort.Slice(language, func(i, j int) bool {
@@ -1498,7 +1498,7 @@ func aggregateLanguageSummary(input chan *FileJob) []LanguageSummary {
 
 func sortLanguageSummary(language []LanguageSummary) []LanguageSummary {
 	// Cater for the common case of adding plural even for those options that don't make sense
-	// as its quite common for those who English is not a first language to make a simple mistake
+	// as it's quite common for those who English is not a first language to make a simple mistake
 	// NB in any non name cases if the values are the same we sort by name to ensure
 	// deterministic output
 	switch {

processor/processor.go

@@ -271,11 +271,11 @@ func ProcessConstants() {
 	// Configure COCOMO setting
 	_, ok := projectType[strings.ToLower(CocomoProjectType)]
 	if !ok {
-		// lets see if we can turn it into a custom one
+		// let's see if we can turn it into a custom one
 		spl := strings.Split(CocomoProjectType, ",")
 		val := []float64{}
 		if len(spl) == 5 {
-			// lets try to convert to float if we can
+			// let's try to convert to float if we can
 			for i := 1; i < 5; i++ {
 				f, err := strconv.ParseFloat(spl[i], 64)
 				if err == nil {