Merge pull request #7 from grafana/update-docs

Update docs

Author: szkiba

.github/workflows/lint.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Setup go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.21"
+          go-version: "1.22.4"
           cache: false
       - name: Go linter
         uses: golangci/golangci-lint-action@v3

.github/workflows/release.yml

@@ -17,12 +17,12 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.21"
+          go-version: "1.22.4"
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
         with:
           distribution: goreleaser
-          version: "1.22.0"
+          version: "2.0.1"
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.21"
+          go-version: "1.22.4"
       - name: Checkout code
         uses: actions/checkout@v4
 

.gitignore

@@ -4,3 +4,4 @@
 /node_modules
 /package.json
 /yarn.lock
+test*.db

.goreleaser.yaml

@@ -1,4 +1,5 @@
 project_name: k6deps
+version: 2
 before:
   hooks:
     - go mod tidy
@@ -9,7 +10,7 @@ builds:
     goos: ["darwin", "linux", "windows"]
     goarch: ["amd64", "arm64"]
     ldflags:
-      - '-s -w -X main.version={{.Version}} -X main.appname={{.ProjectName}}'
+      - "-s -w -X main.version={{.Version}} -X main.appname={{.ProjectName}}"
     dir: cmd/k6deps
 source:
   enabled: true

cmd/cmd.go

@@ -1,4 +1,4 @@
-// Package cmd contains deps cobra command factory function.
+// Package cmd contains k6deps cobra command factory function.
 package cmd
 
 import (
@@ -48,7 +48,7 @@ func New() *cobra.Command {
 	opts := new(options)
 
 	cmd := &cobra.Command{
-		Use:   "deps [flags] [script-file]",
+		Use:   "k6deps [flags] [script-file]",
 		Short: "Extension dependency detection for k6.",
 		Long:  help,
 		Args:  cobra.MaximumNArgs(1),

cmd/cmd_test.go

@@ -15,7 +15,7 @@ func Test_New(t *testing.T) {
 
 	root := cmd.New()
 
-	require.Equal(t, "deps [flags] [script-file]", root.Use)
+	require.Equal(t, "k6deps [flags] [script-file]", root.Use)
 
 	dir := t.TempDir()
 

cmd/k6deps/main.go

@@ -4,7 +4,6 @@ package main
 import (
 	"log"
 	"os"
-	"strings"
 
 	"github.com/grafana/k6deps/cmd"
 	"github.com/spf13/cobra"
@@ -22,7 +21,6 @@ func main() {
 
 func newCmd(args []string) *cobra.Command {
 	cmd := cmd.New()
-	cmd.Use = strings.Replace(cmd.Use, cmd.Name(), appname, 1)
 	cmd.Version = version
 	cmd.SetArgs(args)
 

examples/combined.js

@@ -0,0 +1,13 @@
+"use k6 >= 0.50";
+"use k6 with k6/x/faker >= 0.3.0";
+"use k6 with k6/x/sql >= 0.4.0";
+
+import faker from "./faker.js";
+import sqlite from "./sqlite.js";
+
+export { setup, teardown } from "./sqlite.js";
+
+export default () => {
+  faker();
+  sqlite();
+};

examples/device.js

@@ -0,0 +1,10 @@
+// source: https://github.com/szkiba/xk6-faker/blob/v0.3.0/examples/custom-faker.js
+import { Faker } from "k6/x/faker";
+
+const faker = new Faker(11);
+
+export default function () {
+  console.log(faker.person.firstName());
+}
+
+// output: Josiah

examples/faker.js

@@ -0,0 +1,24 @@
+// source: https://github.com/grafana/xk6-sql/blob/v0.4.0/examples/sqlite3_test.js
+import sql from "k6/x/sql";
+
+const db = sql.open("sqlite3", "./test.db");
+
+export function setup() {
+  db.exec(`CREATE TABLE IF NOT EXISTS keyvalues (
+           id integer PRIMARY KEY AUTOINCREMENT,
+           key varchar NOT NULL,
+           value varchar);`);
+}
+
+export function teardown() {
+  db.close();
+}
+
+export default function () {
+  db.exec("INSERT INTO keyvalues (key, value) VALUES('plugin-name', 'k6-plugin-sql');");
+
+  let results = sql.query(db, "SELECT * FROM keyvalues WHERE key = $1;", "plugin-name");
+  for (const row of results) {
+    console.log(`key: ${row.key}, value: ${row.value}`);
+  }
+}

examples/script.js

@@ -1,15 +1,15 @@
 module github.com/grafana/k6deps
 
-go 1.21
+go 1.22.4
 
 require (
 	github.com/Masterminds/semver/v3 v3.2.1
-	github.com/evanw/esbuild v0.21.3
+	github.com/evanw/esbuild v0.21.5
 	github.com/grafana/clireadme v0.1.0
 	github.com/grafana/k6pack v0.2.0
-	github.com/spf13/cobra v1.8.0
+	github.com/spf13/cobra v1.8.1
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/term v0.18.0
+	golang.org/x/term v0.21.0
 )
 
 require (
@@ -19,6 +19,6 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rogpeppe/go-internal v1.12.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	golang.org/x/sys v0.18.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

examples/sqlite.js

@@ -1,11 +1,11 @@
 github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0=
 github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
-github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/evanw/esbuild v0.21.3 h1:SeawdSUXrp+Auz8K8AxvgmpjqfYhvJkdxqpgqgxuXmk=
-github.com/evanw/esbuild v0.21.3/go.mod h1:D2vIQZqV/vIf/VRHtViaUtViZmG7o+kKmlBfVQuRi48=
+github.com/evanw/esbuild v0.21.5 h1:oShm8TT5QUhf6vM7teg0nmd14eHu64dPmVluC2f4DMg=
+github.com/evanw/esbuild v0.21.5/go.mod h1:D2vIQZqV/vIf/VRHtViaUtViZmG7o+kKmlBfVQuRi48=
 github.com/grafana/clireadme v0.1.0 h1:KYEYSnYdSzmHf3bufaK6fQZ5j4dzvM/T+G6Ba+qNnAM=
 github.com/grafana/clireadme v0.1.0/go.mod h1:Wy4KIG2ZBGMYAYyF9l7qAy+yoJVasqk/txsRgoRI3gc=
 github.com/grafana/k6pack v0.2.0 h1:Y8udypzuzFdcFMRHnP5VkdjYXWLb/ouKzm4ct3OqPmg=
@@ -21,17 +21,17 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
 github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
-github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
+github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
+github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
-golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
-golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
+golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.21.0 h1:WVXCp+/EBEHOj53Rvu+7KiT/iElMrO8ACK16SMZ3jaA=
+golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

examples/user.js

@@ -0,0 +1,10 @@
+k6deps `v0.1.2` is here 🎉!
+
+**New features**:
+
+- add support for searching the manifest file without a script parameter, starting from the current directory
+
+**Fixes**:
+
+- accept k6 as valid dependency name
+

go.mod

@@ -0,0 +1,3 @@
+k6deps `v0.1.3` is here 🎉!
+
+This is a maintenance release.

go.sum

@@ -3,14 +3,12 @@ package main
 
 import (
 	_ "embed"
-	"strings"
 
 	"github.com/grafana/clireadme"
 	"github.com/grafana/k6deps/cmd"
 )
 
 func main() {
 	root := cmd.New()
-	root.Use = strings.ReplaceAll(root.Use, "deps", "k6deps")
 	clireadme.Main(root, 1)
 }