Merge pull request #431 from reubenmiller/chore-add-spell-checker

chore: add spell-checker task and fix typos

.cspell/custom-words.txt

@@ -0,0 +1,282 @@
+Abqid
+Aivazis
+assw
+atleast
+Azjnvzk
+codesign
+convertfrom
+convertto
+coreutils
+createbinary
+createhostedapplication
+Creds
+Csvg
+currentapplicationsubscription
+currentdate
+currenttenantapplicationcollection
+custompaths
+databrokerconnector
+databrokerconnectorcollection
+datahubjob
+datahubjobresult
+datahubqueryresult
+datamash
+datapoints
+datefrom
+dategt
+dategte
+datelt
+datelte
+dateto
+decrypttext
+defaultusername
+deleteapplicationbinary
+deletebinary
+deletebysource
+deletecollection
+deleterolefromgroup
+deleterolefromuser
+deleteuserfromgroup
+deviceavailability
+devicebootstrapcredential
+devicecertificate
+devicecertificatecollection
+devicechild
+devicechildcollection
+devicecollection
+devicecredentials
+devicegroup
+devicegroupchild
+devicegroupchildcollection
+devicegroupcollection
+devicelist
+deviceparent
+deviceprofilecollection
+devicerequest
+devicerequestcollection
+devicerequiredavailability
+deviceservice
+deviceservicecollection
+devicestatisticscollection
+deviceuser
+devmgmt
+Dident
+disableapplication
+dotnotation
+downloadbinary
+Dwpckv
+dyojzxbvf
+emptyresponse
+enableapplication
+enkey
+Epass
+eplfile
+eventbinary
+eventcollection
+flatb
+getbootstrapuser
+getbyname
+getchild
+getcredentials
+getforcategory
+getinventoryrole
+getrolereferencecollectionfromgroup
+getrolereferencecollectionfromuser
+getseries
+getstatus
+getsupportedmeasurements
+getsupportedseries
+gettingstarted
+gettype
+getuserbyname
+Gfhe
+ghinstance
+ghrepo
+gjsonpath
+GLFHs
+globstr
+gofmt
+goimports
+gopass
+groupfromgroup
+hasnot
+hideable
+hostport
+hubot
+iarg
+icmdlet
+IDKS
+ikpzw
+INAK
+inputobject
+inttest
+iostreams
+ipath
+iresult
+isalive
+isbound
+isdigit
+ismatch
+iterm
+itermcolors
+ivalue
+jsonargument
+jsonarray
+jsonfilter
+jsonformatter
+jsonobj
+jsonobject
+jsonschema
+jsonstream
+keyauth
+keyhost
+keyl
+latestjobs
+leneq
+lengt
+lengte
+lenlt
+lenlte
+lenneq
+libexec
+lineline
+linuxbrew
+linuxdevice
+listapplicationbinaries
+listapplications
+listassets
+listchildren
+listdevicestatistics
+listgroupmembership
+listinventoryroles
+listoperations
+listpaginated
+listreferences
+listresults
+listsubscriptions
+listsummaryalltenants
+listsummaryfortenant
+listusermembership
+livedemo
+llog
+logg
+lpoy
+managedobject
+managedobjectchild
+managedobjectchildcollection
+managedobjectcount
+managedobjectparent
+manpages
+matrixer
+maxts
+mcol
+measurementcollection
+measurementseries
+mgmt
+microservicebinary
+microservicebootstrapuser
+microservicecollection
+microserviceinstance
+microserviceloglevel
+microserviceloglevelcollection
+microservicename
+microservicestatus
+Milli
+mychart
+mycliapp
+mycommand
+mycustom
+mycustomsession
+myexampleuser
+myext
+myextension
+myfork
+myhome
+myhost
+mylib
+mylinuxbox
+mylockfile
+mylonglist
+mymeasurement
+mymicroservice
+mymodule
+myother
+myothersession
+myoutput
+myplugin
+myschema
+mysession
+mysub
+mysubcmd
+mytestapp
+mytestname
+mytype
+myusername
+myval
+nativecumulocityrequest
+nestedjson
+nestedprop
+nestedstr
+newerthan
+newname
+nextvalue
+nlinuxdevice
+Nokis
+nosniff
+nothas
+notificationchannel
+notincludes
+notoall
+notty
+nqdfo
+octo
+offen
+offloadingconfigurations
+olderthan
+oldname
+oldstable
+Opai
+operationcollection
+otheruser
+otpauth
+paginationobject
+parameterset
+pathresolver
+pathtype
+peterpi
+pflag
+powershelltype
+powerusers
+pquerna
+precomposeunicode
+procps
+psmexports
+pssnapins
+qfwd
+qpart
+refspec
+requestiterator
+SKDHZQ
+someother
+sometemplate
+sortorder
+srepos
+storeonly
+storepassword
+storetoken
+tekuri
+temphash
+temporarydirectory
+tmpls
+toplevel
+totalminutes
+totalseconds
+tparse
+truecolor
+vjson
+Vorobev
+Wjdwa
+Xghv
+XYDA
+Yehl
+zipit

.gitignore

@@ -59,3 +59,6 @@ tools/shell/completion/output/
 .task/checksum
 .bin/
 docker/c8y.linux
+
+# Linting
+typos*.txt

Makefile

@@ -1,6 +1,6 @@
 .PHONY: build_gh_pages
 
-build_gh_pages:		## build github pages (used by netifly)
+build_gh_pages:		## build github pages (used by netlify)
 	cd docs/go-c8y-cli \
 		&& npm install \
 		&& npm run write-translations \

Taskfile.yml

@@ -56,6 +56,11 @@ tasks:
 
         echo Installed c8y successfully
 
+  spell-checker:
+    desc: Run the spell checker
+    cmds:
+      - docker run --rm -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**" | tee typos.txt
+      - cat typos.txt | cut -d'(' -f2 | tr -d ')' | sort | uniq -c > typos.summary.txt
 
   # ---------------------------------------------------------------
   # Docs

api/spec/yaml/microservicesLoglevels.yaml

@@ -42,7 +42,7 @@ commands:
   - name: get
     description: Get log level of microservice
     descriptionLong: |
-      Get configured log level for a package (incl. subpackages), or a specific class.
+      Get configured log level for a package (incl. sub-packages), or a specific class.
       (This only works for Spring Boot microservices based on Cumulocity Java Microservice SDK)
     method: GET
     path: /service/{name}/loggers/{loggerName}
@@ -77,7 +77,7 @@ commands:
   - name: set
     description: Set log level of microservice
     descriptionLong: |
-      Set configured log level for a package (incl. subpackages), or a specific class.
+      Set configured log level for a package (incl. sub-packages), or a specific class.
       (This only works for Spring Boot microservices based on Cumulocity Java Microservice SDK)
     method: POST
     path: /service/{name}/loggers/{loggerName}
@@ -131,7 +131,7 @@ commands:
   - name: delete
     description: Delete configured log level of microservice
     descriptionLong: |
-      Delete configured log level for a package (incl. subpackages), or a specific class.
+      Delete configured log level for a package (incl. sub-packages), or a specific class.
       This resets its value to the default log level.
       (This only works for Spring Boot microservices based on Cumulocity Java Microservice SDK)
     method: POST

cmd/gen-tests/main.go

@@ -278,7 +278,7 @@ func buildAssertions(parentCmd string, endpoint *models.Command, exampleIdx int)
 				case "attachment", "file", "fileContents":
 					// TODO: Add support for checking file type
 				case "datetime":
-					// Note: Simplify checkings for relative time values
+					// Note: Simplify checking for relative time values
 					assertions.Contains = append(assertions.Contains, fmt.Sprintf("\"%s\":", parameter.GetTargetProperty()))
 				default:
 					formatJsonAssertion(assertions.JSON, parameter.Type, "body."+parameter.GetTargetProperty(), value)