ci(linting): update pre-commit hooks and add ignore for readme

Author: benjivesterby

.pre-commit-config.yaml

@@ -1,33 +1,60 @@
+exclude: '^package.json|package-lock.json|.*?\.tsv$'
+fail_fast: true 
 repos:
--   repo: https://github.com/Contrast-Labs/detect-secrets
-    rev: v1.1.2
+-   repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.42.1
+    hooks:
+        - id: commitizen
+          stages: [commit-msg]
+-   repo: https://github.com/Yelp/detect-secrets
+    rev: v1.4.0
     hooks:
     -   id: detect-secrets
-        name: Detect secrets
-        language: python
-        entry: detect-secrets-hook
         args: ['--baseline', '.secrets.baseline']
+        exclude: package.lock.json
+        stages: [commit]
 -   repo: https://github.com/golangci/golangci-lint
-    rev: v1.49.0
+    rev: v1.52.2
     hooks:
     -   id: golangci-lint
--   repo: https://github.com/Bahjat/pre-commit-golang    
+        stages: [commit]
+-   repo: https://github.com/Bahjat/pre-commit-golang
     rev: v1.0.3 # pragma: allowlist secret
     hooks:
       - id: go-unit-tests
+        stages: [commit]
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
     -   id: check-json
-    -   id: check-added-large-files
+        stages: [commit]
+      #-   id: no-commit-to-branch
+      #    args: ['--branch', 'main']
+      #    stages: [commit]
     -   id: pretty-format-json
+        args: ['--autofix']
+        stages: [commit]
     -   id: check-merge-conflict
+        stages: [commit]
     -   id: check-yaml
+        stages: [commit]
 -   repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.32.2
+    rev: v0.33.0
     hooks:
     -   id: markdownlint-fix
--   repo: https://github.com/koalaman/shellcheck-precommit
-    rev: v0.8.0
+        stages: [commit]
+        args: ["--ignore", "README.md"] # This is a generated file
+-   repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.2
+    hooks:
+    -   id: shellcheck
+        stages: [commit]
+-   repo: https://github.com/pre-commit/mirrors-eslint
+    rev: 'v8.36.0'
+    hooks:
+    -   id: eslint
+        stages: [commit]
+-   repo: https://github.com/dnephin/pre-commit-golang
+    rev: 'v0.5.1'
     hooks:
-    -   id: shellcheck
+      - id: go-mod-tidy

.secrets.baseline

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.2",
+  "version": "1.4.0",
   "plugins_used": [
     {
       "name": "ArtifactoryDetector"

README.md

@@ -1,4 +1,5 @@
 # stream
+
 --
     import "."
 
@@ -49,16 +50,18 @@ var ErrFnRequired = fmt.Errorf("nil InterceptFunc, Fn is required")
 ```go
 func Any[T any](ctx context.Context, in <-chan T) <-chan any
 ```
+
 Any accepts an incoming data channel and converts the channel to a readonly
 channel of the `any` type.
 
 #### func  Distribute
 
 ```go
 func Distribute[T any](
-	ctx context.Context, in <-chan T, out ...chan<- T,
+ ctx context.Context, in <-chan T, out ...chan<- T,
 )
 ```
+
 Distribute accepts an incoming data channel and distributes the data among the
 supplied outgoing data channels using a dynamic select statement.
 
@@ -71,6 +74,7 @@ ensure that the goroutine is properly terminated.
 ```go
 func Drain[T any](ctx context.Context, in <-chan T)
 ```
+
 Drain accepts a channel and drains the channel until the channel is closed or
 the context is canceled.
 
@@ -79,6 +83,7 @@ the context is canceled.
 ```go
 func FanIn[T any](ctx context.Context, in ...<-chan T) <-chan T
 ```
+
 FanIn accepts incoming data channels and forwards returns a single channel that
 receives all the data from the supplied channels.
 
@@ -90,9 +95,10 @@ ensure that the goroutine is terminated.
 
 ```go
 func FanOut[T any](
-	ctx context.Context, in <-chan T, out ...chan<- T,
+ ctx context.Context, in <-chan T, out ...chan<- T,
 )
 ```
+
 FanOut accepts an incoming data channel and copies the data to each of the
 supplied outgoing data channels.
 
@@ -104,11 +110,12 @@ ensure that the goroutine is properly terminated.
 
 ```go
 func Intercept[T, U any](
-	ctx context.Context,
-	in <-chan T,
-	fn InterceptFunc[T, U],
+ ctx context.Context,
+ in <-chan T,
+ fn InterceptFunc[T, U],
 ) <-chan U
 ```
+
 Intercept accepts an incoming data channel and a function literal that accepts
 the incoming data and returns data of the same type and a boolean indicating
 whether the data should be forwarded to the output channel. The function is
@@ -119,9 +126,10 @@ not canceled or the incoming channel remains open.
 
 ```go
 func Pipe[T any](
-	ctx context.Context, in <-chan T, out chan<- T,
+ ctx context.Context, in <-chan T, out chan<- T,
 )
 ```
+
 Pipe accepts an incoming data channel and pipes it to the supplied outgoing data
 channel.
 
@@ -133,25 +141,25 @@ that the goroutine is properly terminated.
 
 ```go
 type DurationScaler struct {
-	// Interval is the number the current step must be divisible by in order
-	// to modify the time.Duration.
-	Interval int
-
-	// ScalingFactor is a value between -1 and 1 that is used to modify the
-	// time.Duration of a ticker or timer. The value is multiplied by
-	// the ScalingFactor is multiplied by the duration for scaling.
-	//
-	// For example, if the ScalingFactor is 0.5, then the duration will be
-	// multiplied by 0.5. If the ScalingFactor is -0.5, then the duration will
-	// be divided by 0.5. If the ScalingFactor is 0, then the duration will
-	// not be modified.
-	//
-	// A negative ScalingFactor will cause the duration to decrease as the
-	// step value increases causing the ticker or timer to fire more often
-	// and create more routines. A positive ScalingFactor will cause the
-	// duration to increase as the step value increases causing the ticker
-	// or timer to fire less often and create less routines.
-	ScalingFactor float64
+ // Interval is the number the current step must be divisible by in order
+ // to modify the time.Duration.
+ Interval int
+
+ // ScalingFactor is a value between -1 and 1 that is used to modify the
+ // time.Duration of a ticker or timer. The value is multiplied by
+ // the ScalingFactor is multiplied by the duration for scaling.
+ //
+ // For example, if the ScalingFactor is 0.5, then the duration will be
+ // multiplied by 0.5. If the ScalingFactor is -0.5, then the duration will
+ // be divided by 0.5. If the ScalingFactor is 0, then the duration will
+ // not be modified.
+ //
+ // A negative ScalingFactor will cause the duration to decrease as the
+ // step value increases causing the ticker or timer to fire more often
+ // and create more routines. A positive ScalingFactor will cause the
+ // duration to increase as the step value increases causing the ticker
+ // or timer to fire less often and create less routines.
+ ScalingFactor float64
 }
 ```
 
@@ -164,19 +172,18 @@ a configured step value and modifier (between -1 and 1) value.
 type InterceptFunc[T, U any] func(context.Context, T) (U, bool)
 ```
 
-
 #### type Scaler
 
 ```go
 type Scaler[T, U any] struct {
-	Wait time.Duration
-	Life time.Duration
-	Fn   InterceptFunc[T, U]
-
-	// WaitModifier is used to modify the Wait time based on the number of
-	// times the Scaler has scaled up. This is useful for systems
-	// that are CPU bound and need to scale up more/less quickly.
-	WaitModifier DurationScaler
+ Wait time.Duration
+ Life time.Duration
+ Fn   InterceptFunc[T, U]
+
+ // WaitModifier is used to modify the Wait time based on the number of
+ // times the Scaler has scaled up. This is useful for systems
+ // that are CPU bound and need to scale up more/less quickly.
+ WaitModifier DurationScaler
 }
 ```
 
@@ -209,6 +216,7 @@ successful send occurs. (This should only loop twice).
 ```go
 func (s Scaler[T, U]) Exec(ctx context.Context, in <-chan T) (<-chan U, error)
 ```
+
 Exec starts the internal Scaler routine (the first layer of processing) and
 returns the output channel where the resulting data from the Fn function will be
 sent.