Fix linter issues (#2420)

* chore: fixed typos

Signed-off-by: Matej Vašek <[email protected]>

* chore: removed trailing whitespaces

Signed-off-by: Matej Vašek <[email protected]>

* chore: added EoLs at EoFs

Signed-off-by: Matej Vašek <[email protected]>

---------

Signed-off-by: Matej Vašek <[email protected]>

Author: matejvasek

.chglog/CHANGELOG.tpl.md

@@ -55,4 +55,4 @@
 [{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
 {{ end -}}
 {{ end -}}
-{{ end -}}
+{{ end -}}

.chglog/config.yml

@@ -37,4 +37,4 @@ options:
       - Header
   notes:
     keywords:
-      - BREAKING CHANGE
+      - BREAKING CHANGE

.golangci.yaml

@@ -4,7 +4,7 @@
 # For defaults, see:
 # https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
 #
-# 
+#
 #
 run:
   timeout: 5m
@@ -28,4 +28,4 @@ issues:
       #     Name  Type = "value"
       #     Name2      = "value2"
       #   )
-      text: "SA9004:"  
+      text: "SA9004:"

CHANGELOG.md

@@ -590,7 +590,7 @@ All notable changes to this project will be documented in this file. See [standa
 ### Docs
 - fix function typos
 - setting up remote access to kind clusters
-- wireguard configuraiton for OS X
+- wireguard configuration for OS X
 - Kind cluster provisioning and TLS
 - separate repository and system docs
 - getting started with kubernetes, reorganization.

cmd/environment.go

@@ -37,8 +37,7 @@ DESCRIPTION
 	the version of func, the version of the function spec, the default builder,
 	available runtimes, and available templates.
 `,
-		SuggestFor: []string{"env", "environemtn", "enviroment", "enviornment", "enviroment"},
-		PreRunE:    bindEnv("verbose", "format", "path"),
+		PreRunE: bindEnv("verbose", "format", "path"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runEnvironment(cmd, newClient, version)
 		},

cmd/templates.go

@@ -56,11 +56,6 @@ EXAMPLES
 	o Return Go templates in a specific repository
 		$ {{rootCmdUse}} templates go --repository=https://github.com/boson-project/templates
 `,
-		SuggestFor: []string{"template", "templtaes", "templatse", "remplates",
-			"gemplates", "yemplates", "tenplates", "tekplates", "tejplates",
-			"temolates", "temllates", "temppates", "tempmates", "tempkates",
-			"templstes", "templztes", "templqtes", "templares", "templages", //nolint:misspell
-			"templayes", "templatee", "templatea", "templated", "templatew"},
 		PreRunE: bindEnv("json", "repository", "verbose"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runTemplates(cmd, args, newClient)

cmd/version.go

@@ -31,7 +31,7 @@ DESCRIPTION
 	  $ {{rootCmdUse}} version -v
 
 `,
-		SuggestFor: []string{"vers", "verison"}, //nolint:misspell
+		SuggestFor: []string{"vers", "version"}, //nolint:misspell
 		PreRunE:    bindEnv("verbose"),
 		Run: func(cmd *cobra.Command, _ []string) {
 			runVersion(cmd, version)

docs/CONTRIBUTING.md

@@ -93,7 +93,7 @@ Allocate a new local cluster by running `hack/allocate.sh`.
 
 ### Registry
 
-The allocation script sets up a local container registry and connects it to the cluster.  This registry must be set as trusted and its address entered in the local hosts file.  This is a one-time configuration and on Linux can be accomplished by running `hack/registry.sh`. 
+The allocation script sets up a local container registry and connects it to the cluster.  This registry must be set as trusted and its address entered in the local hosts file.  This is a one-time configuration and on Linux can be accomplished by running `hack/registry.sh`.
 
 On other systems, add `127.0.0.1 kind-registry` to your local hosts file and `"insecure-registries" = ["kind-registry:50000"]` to your docker daemon config (`docker/daemon.json`).
 

docs/function-templates/golang.md

@@ -43,7 +43,7 @@ After the function has been built, it can be run locally.
 ❯ func run
 ```
 
-Functions can be invoked with a simple HTTP request. 
+Functions can be invoked with a simple HTTP request.
 You can test to see if the function is working by using your browser to visit
 http://localhost:8080. You can also access liveness and readiness
 endpoints at http://localhost:8080/health/liveness and
@@ -69,7 +69,7 @@ You can get the URL for your deployed function with the `info` command.
 
 
 Go functions can be tested locally on your computer. In the project there is
-a `handle_test.go` file which contains simple test which can be extended as needed. 
+a `handle_test.go` file which contains simple test which can be extended as needed.
 Yo can run this test locally as you would do with any Go project.
 
 ```
@@ -79,8 +79,8 @@ Yo can run this test locally as you would do with any Go project.
 ## Function reference
 
 Boson Go functions have very few restrictions. You can add any required dependencies
-in `go.mod` and you may include additional local Go files. The only real requirement are 
-that your project is defined in a `function` module and exports the function `Handle()` 
+in `go.mod` and you may include additional local Go files. The only real requirement are
+that your project is defined in a `function` module and exports the function `Handle()`
 (supported contracts of this function will be discussed more deeply later).
 In this section, we will look in a little more detail at how Boson functions are invoked,
 and what APIs are available to you as a developer.
@@ -139,10 +139,10 @@ Handle(context.Context, cloudevents.Event) *cloudevents.Event
 Handle(context.Context, cloudevents.Event) (*cloudevents.Event, error)
 ```
 
-For example, a `CloudEvent` is received which contains a JSON string such as this in its data property, 
+For example, a `CloudEvent` is received which contains a JSON string such as this in its data property,
 
 ```json
-{ 
+{
   "customerId": "0123456",
   "productId": "6543210"
 }
@@ -158,7 +158,7 @@ type Purchase struct {
 }
 
 func Handle(ctx context.Context, event cloudevents.Event) err error {
-	  
+
   purchase := &Purchase{}
   if err = cloudevents.DataAs(purchase); err != nil {
 	fmt.Fprintf(os.Stderr, "failed to parse incoming CloudEvent %s\n", err)

docs/function-templates/nodejs.md

@@ -44,7 +44,7 @@ After the function has been built, it can be run locally.
 ❯ func run
 ```
 
-Functions can be invoked with a simple HTTP request. 
+Functions can be invoked with a simple HTTP request.
 You can test to see if the function is working by using your browser to visit
 http://localhost:8080. You can also access liveness and readiness
 endpoints at http://localhost:8080/health/liveness and
@@ -108,7 +108,7 @@ parameter. For example, a `CloudEvent` is received which contains a
 JSON string such as this in its data property,
 
 ```json
-{ 
+{
   "customerId": "0123456",
   "productId": "6543210"
 }
@@ -154,7 +154,7 @@ extracted and sent with the response to the caller.
 function processCustomer(customer) {
   // process customer and return custom headers
   // the response will be '204 No content'
-  return { headers: { customerid: customer.id } }; 
+  return { headers: { customerid: customer.id } };
 }
 ```
 
@@ -168,7 +168,7 @@ function processCustomer(customer) {
   // process customer
   if (customer.restricted) {
     return { statusCode: 451 }
-  } 
+  }
 }
 ```
 
@@ -182,7 +182,7 @@ function processCustomer(customer) {
     const err = new Error(‘Unavailable for legal reasons’);
     err.statusCode = 451;
     throw err;
-  } 
+  }
 }
 ```
 
@@ -214,7 +214,7 @@ Access the function via `curl` to invoke it.
 curl http://example.com
 ```
 
-The function will log 
+The function will log
 
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}
@@ -223,7 +223,7 @@ The function will log
 Developers can control the log level by setting the `logLevel` value in
 `func.yaml` The possible options for this adhere to the options available
 for [`pino`](https://getpino.io/#/docs/api?id=level-string),
-and may be one of 
+and may be one of
 `'fatal'`, `'error'`, `'warn'`, `'info'`, `'debug'`, `'trace'` or `'silent'`.
 
 To temporarily override this value, set the environment variable `FUNC_LOG_LEVEL`
@@ -249,7 +249,7 @@ Access the function via `curl` to invoke it.
 ```sh
 curl http://example.com?name=tiger
 ```
-The function will log 
+The function will log
 
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}
@@ -274,7 +274,7 @@ Access the function via `curl` to invoke it.
 curl -X POST -d '{"hello": "world"}'  -H'Content-type: application/json' http://example.com
 ```
 
-The function will log 
+The function will log
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}
 ```
@@ -293,7 +293,7 @@ Access the function via `curl` to invoke it.
 ```console
 curl -H'x-custom-header: some-value’' http://example.com
 ```
-The function will log 
+The function will log
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}
 ```

docs/function-templates/python.md

@@ -42,7 +42,7 @@ After the function has been built, it can be run locally.
 ❯ func run
 ```
 
-Functions can be invoked with a simple HTTP request. 
+Functions can be invoked with a simple HTTP request.
 You can test to see if the function is working by using your browser to visit
 http://localhost:8080. You can also access liveness and readiness
 endpoints at http://localhost:8080/health/liveness and
@@ -104,7 +104,7 @@ For example:
 
 ```python
 def main(context: Context):
-    """ 
+    """
     The context parameter contains the Flask request object and any
     CloudEvent received with the request.
     """
@@ -115,7 +115,7 @@ def main(context: Context):
 
 ### Return Values
 Functions may return any value supported by Flask, as the invocation framework
-proxies these values directly to the Flask server. See the Flask 
+proxies these values directly to the Flask server. See the Flask
 [documentation](https://flask.palletsprojects.com/en/1.1.x/quickstart/#about-responses)
 for more information.
 

docs/function-templates/quarkus.md

@@ -10,7 +10,7 @@ Project path: /home/developer/projects/fn
 Function name: fn
 Runtime: quarkus
 
-❯ tree         
+❯ tree
 fn
 ├── func.yaml
 ├── mvnw
@@ -56,7 +56,7 @@ After the function has been built, it can be run locally.
 ❯ func run
 ```
 
-Functions can be invoked with a simple HTTP request. 
+Functions can be invoked with a simple HTTP request.
 You can test to see if the function is working by using your browser to visit
 http://localhost:8080.
 
@@ -150,7 +150,7 @@ then the object you return will be sent in the `data` property of a binary encod
 
 If the function received vanilla HTTP,
 then the object you return will be sent as the HTTP response body. In the example below, an invocation of this function
-through an incoming `CloudEvent`, will receive a response with a `CloudEvent` containing a list of purchases as its 
+through an incoming `CloudEvent`, will receive a response with a `CloudEvent` containing a list of purchases as its
 `data` property. If the invocation was via an ordinary HTTP request, the response will contain the same list of purchases
 in the HTTP response body, but no `CloudEvent` headers will be included.
 
@@ -197,14 +197,14 @@ Note that the type parameter of `CloudEvent<T>` must satisfy the conditions desc
 #### Example
 ```java
 public class Functions {
-    
+
     private boolean _processPurchase(Purchase purchase) {
         // do stuff
     }
-    
+
     public CloudEvent<Void> processPurchase(CloudEvent<Purchase> purchaseEvent) {
         System.out.println("subject is: ", purchaseEvent.subject());
-        
+
         if (!_processPurchase(purchaseEvent.data())) {
             return CloudEventBuilder.create()
                     .type("purchase.error")

docs/function-templates/typescript.md

@@ -47,7 +47,7 @@ After the function has been built, it can be run locally.
 ❯ func run
 ```
 
-Functions can be invoked with a simple HTTP request. 
+Functions can be invoked with a simple HTTP request.
 You can test to see if the function is working by using your browser to visit
 http://localhost:8080. You can also access liveness and readiness
 endpoints at http://localhost:8080/health/liveness and
@@ -136,7 +136,7 @@ function handle(context: Context, cloudevent?: CloudEvent): Record<string, strin
   // process customer and return custom headers
   // the response will be '204 No content'
   const customer = cloudevent.data;
-  return { headers: { "customer-id": customer.id } }; 
+  return { headers: { "customer-id": customer.id } };
 }
 ```
 
@@ -147,10 +147,10 @@ Developers may set the response code returned to the caller by adding a
 #### Example
 ```js
 function handle(context: Context, cloudevent?: CloudEvent): Record<string, string> {
-  // process customer 
+  // process customer
   const customer = cloudevent.data;
   if (customer.restricted) {
-    return { 
+    return {
       statusCode: 451
     }
   }
@@ -172,7 +172,7 @@ function handle(context: Context, cloudevent?: CloudEvent) Record<string, string
     const err = new Error(‘Unavailable for legal reasons’);
     err.statusCode = 451;
     throw err;
-  } 
+  }
 }
 ```
 
@@ -204,7 +204,7 @@ Access the function via `curl` to invoke it.
 curl http://example.com
 ```
 
-The function will log 
+The function will log
 
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}
@@ -230,7 +230,7 @@ Access the function via `curl` to invoke it.
 ```sh
 curl "http://example.com?name=tiger"
 ```
-The function will log 
+The function will log
 
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}
@@ -256,7 +256,7 @@ Access the function via `curl` to invoke it.
 curl -X POST -d '{"hello": "world"}'  -H'Content-type: application/json' http://example.com
 ```
 
-The function will log 
+The function will log
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}
 ```
@@ -276,7 +276,7 @@ Access the function via `curl` to invoke it.
 ```console
 curl -H'x-custom-header: some-value’' http://example.com
 ```
-The function will log 
+The function will log
 ```console
 {"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}
 ```

docs/reference/func_yaml.md

@@ -69,7 +69,7 @@ buildEnvs:
 ### `envs`
 
 The `envs` field allows you to set environment variables that will be
-available to your function at runtime. 
+available to your function at runtime.
 1. Environment variable can be set directly from a value
 2. Environment variable can be set from a local environment value. Eg. `'{{ env:LOCAL_ENV_VALUE }}'`, for more details see [Local Environment Variables section](#local-environment-variables).
 3. Environment variable can be set from a key in a Kubernetes Secret or ConfigMap. This Secret/ConfigMap needs to be created before it is referenced in a function. Eg. `'{{ secret:mysecret:key }}'` where `mysecret` is the name of the Secret and `key` is the referenced key; or `{{ configMap:myconfigmap:key }}` where `myconfigmap` is the name of the ConfigMap and `key` is the referenced key.
@@ -132,18 +132,18 @@ must exist in the namespace to succeed.
 More info: https://k8s.io/docs/tasks/configure-pod-container/configure-service-account
 
 ### `options`
-Options allows you to set specific configuration for the deployed function, allowing you to tweak Knative Service options related to autoscaling and other properties. If these options are not set, the Knative defaults will be used. 
+Options allows you to set specific configuration for the deployed function, allowing you to tweak Knative Service options related to autoscaling and other properties. If these options are not set, the Knative defaults will be used.
 - `scale`
   - `min`: Minimum number of replicas. Must me non-negative integer, default is 0. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/scale-bounds/#lower-bound).
   - `max`: Maximum number of replicas. Must me non-negative integer, default is 0 - meaning no limit. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/scale-bounds/#upper-bound).
   - `metric`: Defines which metric type is watched by the Autoscaler. Could be `concurrency` (default) or `rps`. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/autoscaling-metrics/).
   - `target`: Recommendation for when to scale up based on the concurrent number of incoming request. Defaults to `options.resources.limits.concurrency` when given. Can be float value greater than 0.01, default is 100. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/concurrency/#soft-limit).
   - `utilization`: Percentage of concurrent requests utilization before scaling up. Can be float value between 1 and 100, default is 70. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/concurrency/#target-utilization).
 - `resources`
-  - `requests` 
+  - `requests`
     - `cpu`: A CPU resource request for the container with deployed function. See related [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits).
     - `memory`: A memory resource request for the container with deployed function. See related [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits).
-  - `limits` 
+  - `limits`
     - `cpu`: A CPU resource limit for the container with deployed function. See related [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits).
     - `memory`: A memory resource limit for the container with deployed function. See related [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits).
     - `concurrency`: Hard Limit of concurrent requests to be processed by a single replica. Can be integer value greater than or equal to 0, default is 0 - meaning no limit. See related [Knative docs](https://knative.dev/docs/serving/autoscaling/concurrency/#hard-limit).