Go QRCode

https://github.com/yeqown/go-qrcode
Admin
Go QRCode is a powerful QR code generation library for Go that supports multiple encoding modes,...
Tokens:25,265
Snippets:179
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install go-qrcode with go get

Source: https://github.com/yeqown/go-qrcode/blob/main/README.md

Install the go-qrcode library using the go get command. This fetches the latest version of the v2 module.

```sh
go get -u github.com/yeqown/go-qrcode/v2
```

--------------------------------

### Run the Example

Source: https://github.com/yeqown/go-qrcode/blob/main/example/with-minimum-version/README.md

Execute the example code using the go run command.

```bash
go run main.go
```

--------------------------------

### Copy wasm files and serve index.html

Source: https://github.com/yeqown/go-qrcode/blob/main/example/webassembly/README.md

Copy the wasm_exec.js from the Go installation and the pre-compiled wasm file from the go-qrcode/wasm directory, then start a Python HTTP server to serve the index.html on http://localhost:8000.

```bash
cp "$(go env GOROOT)/misc/wasm/wasm_exec.js" .
cp "$PATH/go-qrcode/wasm/com.github.yeqown.goqrcode.wasm" .
# then serve the index.html in browser
python3 -m http.server 
# it serves the index.html on http://localhost:8000, you can use another way too.
```

--------------------------------

### Align example module requirements

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Updates the go.mod file for the example module to use specific internal versions.

```bash
(  cd example  go mod edit     -require=github.com/yeqown/go-qrcode/v2@v2.3.0     -require=github.com/yeqown/go-qrcode/writer/file@v1.0.1     -require=github.com/yeqown/go-qrcode/writer/standard@v1.4.0     -require=github.com/yeqown/go-qrcode/writer/terminal@v1.1.3)
```

--------------------------------

### Quick start: generate a QR code image

Source: https://github.com/yeqown/go-qrcode/blob/main/README.md

Generates a QR code from a URL and saves it as a JPEG image using the standard writer. Requires importing the qrcode and standard writer packages. The example writes to '../assets/repo-qrcode.jpeg'.

```go
package main

import (
	"github.com/yeqown/go-qrcode/v2"
	"github.com/yeqown/go-qrcode/writer/standard"
)

func main() {
	qrc, err := qrcode.New("https://github.com/yeqown/go-qrcode")
	if err != nil {
		fmt.Printf("could not generate QRCode: %v", err)
		return
	}
	
	w, err := standard.New("../assets/repo-qrcode.jpeg")
	if err != nil {
		fmt.Printf("standard.New failed: %v", err)
		return
	}
	
	// save file
	if err = qrc.Save(w); err != nil {
		fmt.Printf("could not save image: %v", err)
	}
}
```

--------------------------------

### Initialize Go 1.20 Workspace

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Creates a temporary workspace directory and initializes it with Go 1.20.14, including local replacements for file and example modules.

```bash
go120_workspace_dir=$(mktemp -d /private/tmp/go-qrcode-go120.XXXXXX)
(
  cd "$go120_workspace_dir"
  GOTOOLCHAIN=go1.20.14 go work init \
    /Users/apple/projects/opensource/go-qrcode \
    /Users/apple/projects/opensource/go-qrcode/example \
    /Users/apple/projects/opensource/go-qrcode/writer/file \
    /Users/apple/projects/opensource/go-qrcode/writer/standard \
    /Users/apple/projects/opensource/go-qrcode/writer/terminal
  GOTOOLCHAIN=go1.20.14 go work edit \
    -replace=github.com/yeqown/go-qrcode/v2@v2.3.0=/Users/apple/projects/opensource/go-qrcode \
    -replace=github.com/yeqown/go-qrcode/writer/standard@v1.4.0=/Users/apple/projects/opensource/go-qrcode/writer/standard \
    -replace=github.com/yeqown/go-qrcode/writer/terminal@v1.1.3=/Users/apple/projects/opensource/go-qrcode/writer/terminal \
    -replace=github.com/yeqown/go-qrcode/writer/file@v1.0.1=/Users/apple/projects/opensource/go-qrcode/writer/file
)
```

--------------------------------

### Generate QR code with qrcode examples

Source: https://github.com/yeqown/go-qrcode/blob/main/cmd/qrcode/README.md

Three examples show how to generate QR codes: default to a file, with custom output path, block size and borders, and to the terminal. The command uses positional text as the source text; the -m flag is used to specify the message. For terminal output, use --terminal flag.

```sh
qrcode "Hello, World!"
```

```sh
qrcode -o qrcode.png -s  20 -b 20,20,20,20 -m "Hello, World!"
```

```sh
qrcode --terminal "Hello, World!"
```

--------------------------------

### JavaScript example: generateQRCode with options

Source: https://github.com/yeqown/go-qrcode/blob/main/cmd/wasm/README.md

Shows how to call generateQRCode with an options object. The options include encodeVersion, encodeMode, encodeECLevel, output colors, transparency, width, shape, image encoder, and margin. The function returns a JSON object with success, error, and base64EncodedImage fields.

```javascript
let option = {
	encodeVersion: 0,   // 0 - 40
	encodeMode: 2,      // 0 - 3
	encodeECLevel: "Q", // L, M, Q, H
	
	outputBgColor: "#123123",   // #000000 - #ffffff
	outputBgTransparent: false, // true - false
	outputQrColor: "#666666",   // #000000 - #ffffff
	outputQrWidth: 20,          // 0 - 256
	outputCircleShape: true,    // true - false
	outputImageEncoder: "png",  // png, jpeg, jpg
	outputMargin: 20,           // 0 - 256
}
let r = generateQRCode("content", option)
// output:
// {
    "success": true,
    "error": "",
    "base64EncodedImage": "iVBORw0KGgoAAAANSUhEUgAAAmwAAAJ... more"
}
```

--------------------------------

### Use the custom shape in main

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/how-to-use-custom-shape.md

This example shows how to use the custom shape by creating a new shape with a radius percent of 0.7 and passing it to qrcode.New via qrcode.WithCustomShape. It then saves the generated QR code to a file named smaller.png.

```go
func main() {
	shape := newShape(0.7)
	qrc, err := qrcode.New("with-custom-shape", qrcode.WithCustomShape(shape))
	if err != nil {
		panic(err)
	}

	err = qrc.Save("./smaller.png")
	if err != nil {
		panic(err)
	}
}
```

--------------------------------

### Run local-workspace baseline tests

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Runs `go test ./...` for all modules in the local workspace. This is required because .issues and example consume APIs from the current checkout that are not in their published requirements, and nested modules do not track go.sum.

```bash
for module_dir in . .issues cmd/qrcode example writer/compressed writer/file writer/standard writer/terminal; do
  (
    cd "$module_dir"
    go test ./...
  )
done
```

```bash
installed_go_root=$(go env GOROOT)
(
  cd cmd/wasm
  GOOS=js GOARCH=wasm go test \
    -exec="$installed_go_root/misc/wasm/go_js_wasm_exec" \
    ./...
)
```

--------------------------------

### Implement a custom shape with smallerCircle

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/how-to-use-custom-shape.md

This example defines a smallerCircle shape that draws circles with a reduced radius for normal cells. The DrawFinder method temporarily sets the radius to full size to ensure the finder pattern is recognizable. The Draw method calculates the radius based on the cell dimensions and uses ctx.DrawCircle and ctx.Fill.

```go
func newShape(radiusPercent float64) qrcode.IShape {
	return &smallerCircle{smallerPercent: radiusPercent}
}

// smallerCircle use smaller circle to qrcode.  
type smallerCircle struct {
	smallerPercent float64
}

func (sc *smallerCircle) DrawFinder(ctx *qrcode.DrawContext) {
	// use normal radius to draw finder for that qrcode image can be recognized. 
	backup := sc.smallerPercent
	sc.smallerPercent = 1.0
	sc.Draw(ctx)
	sc.smallerPercent = backup
}

func (sc *smallerCircle) Draw(ctx *qrcode.DrawContext) {
	w, h := ctx.Edge()
	upperLeft := ctx.UpperLeft()
	color := ctx.Color()

	// choose a proper radius values
	radius := w / 2
	r2 := h / 2
	if r2 <= radius {
		radius = r2
	}

	// 80 percent smaller
	radius = int(float64(radius) * sc.smallerPercent)

	cx, cy := upperLeft.X+w/2, upperLeft.Y+h/2 // get center point
	ctx.DrawCircle(float64(cx), float64(cy), float64(radius))
	ctx.SetColor(color)
	ctx.Fill()

}
```

--------------------------------

### Initialize Compressed Writer with Option

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/compressed/README.md

Configure the Compressed Writer with a padding of 4 pixels and a block size of 1 pixel per bit, then create the writer and save the QR code. Any error during writer creation or saving causes a panic.

```go
option := compressed.Option{
	Padding:   4, // padding pixels around the qr code.
	BlockSize: 1, // block pixels which represents a bit data.
}

w, err := compressed.New(name, &option)
	if err != nil {
	panic(err)
}

if err := qrc.Save(w); err != nil {
	panic(err)
}
```

--------------------------------

### Set up baseline toolchains

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Uses GOTOOLCHAIN to verify Go 1.19.13 and Go 1.20.14 are available. Expected output shows the specific Go versions.

```bash
GOTOOLCHAIN=go1.19.13 go version
GOTOOLCHAIN=go1.20.14 go version
```

--------------------------------

### Using File Writer to save QR code

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/file/README.md

Demonstrates initializing a QR code and using the file writer to output it to standard output.

```go
package main

import (
	"github.com/yeqown/go-qrcode/v2"
	"github.com/yeqown/go-qrcode/writer/file"
)

func main() {
	qrc, _ := qrcode.New("with_file_writer")

	w := file.New(os.Stdout)

	if err := qrc.Save(w); err != nil {
		panic(err)
	}
}
```

--------------------------------

### Create standard writer with options

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Shows how to create a standard writer using standard.New with options, or standard.NewWith with an io.WriteCloser. The first creates the file automatically.

```go
options := []standard.ImageOption{
	standard.WithBgColorRGBHex("#ffffff"),
	standard.WithFgColorRGBHex("#000000"),
	// more ...
}

// New will create file automatically.
writer, err := standard.New("filename", options...)

// or use io.WriteCloser
var w io.WriterCloser
writer2, err := standard.NewWith(w, options...)
```

--------------------------------

### Run WASM Integration Tests

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Executes tests for the WASM module using the installed Go toolchain and the integration workspace.

```bash
installed_go_root=$(go env GOROOT)
(
  cd cmd/wasm
  GOOS=js GOARCH=wasm GOWORK="$integration_workspace_dir/go.work" go test \
    -exec="$installed_go_root/misc/wasm/go_js_wasm_exec" \
    ./...
)
```

--------------------------------

### Display qrcode CLI help output

Source: https://github.com/yeqown/go-qrcode/blob/main/cmd/qrcode/README.md

Run qrcode -h to display the help and version information. The output shows all global options and defaults, such as --output defaulting to qrcode.jpg and --block size default of 5. The help text includes the MIT license and copyright notice.

```sh
qrcode -h
Name:
   qrcode - qrcode [options] [source text]

Usage:
   qrcode [global options] command [command options] [arguments...]

Version:
   v2.0.0-beta

Description:
   QR code generator

Author:
   yeqown <yeqown@gmail.com>

Commands:
   help, h  Shows a list of commands or help for one command

Global options:
   --terminal                 --terminal (default: false)
   --output value, -o value   --output=<output file> (default: qrcode.jpg)
   --block value, -s value    --block=<block size> (default: 5)
   --borders value, -b value  --borders=<borders> (default: 0,0,0,0)
   --circle                   --circle (default: false)
   --help, -h                 show help (default: false)
   --version, -v              print the version (default: false)

Copyright:
   Copyright (c) 2018 yeqown

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
```

--------------------------------

### Initialize Go 1.19 Workspace

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Creates a temporary workspace directory and initializes it with Go 1.19.13, including local replacements for project modules.

```bash
go119_workspace_dir=$(mktemp -d /private/tmp/go-qrcode-go119.XXXXXX)
(
  cd "$go119_workspace_dir"
  GOTOOLCHAIN=go1.19.13 go work init \
    /Users/apple/projects/opensource/go-qrcode \
    /Users/apple/projects/opensource/go-qrcode/.issues \
    /Users/apple/projects/opensource/go-qrcode/cmd/qrcode \
    /Users/apple/projects/opensource/go-qrcode/cmd/wasm \
    /Users/apple/projects/opensource/go-qrcode/writer/compressed \
    /Users/apple/projects/opensource/go-qrcode/writer/standard \
    /Users/apple/projects/opensource/go-qrcode/writer/terminal
  GOTOOLCHAIN=go1.19.13 go work edit \
    -replace=github.com/yeqown/go-qrcode/v2@v2.3.0=/Users/apple/projects/opensource/go-qrcode \
    -replace=github.com/yeqown/go-qrcode/writer/standard@v1.4.0=/Users/apple/projects/opensource/go-qrcode/writer/standard \
    -replace=github.com/yeqown/go-qrcode/writer/terminal@v1.1.3=/Users/apple/projects/opensource/go-qrcode/writer/terminal \
    -replace=github.com/yeqown/go-qrcode/writer/compressed@v1.0.2=/Users/apple/projects/opensource/go-qrcode/writer/compressed
)
```

--------------------------------

### Initialize QR Code with Minimum Version

Source: https://github.com/yeqown/go-qrcode/blob/main/example/with-minimum-version/README.md

Use qrcode.WithMinimumVersion to set the minimum version level. If the content requires a higher version, the library will automatically use that higher version instead.

```go
qrc, err := qrcode.NewWith("your-text-here",
    qrcode.WithMinimumVersion(9),
    qrcode.WithErrorCorrectionLevel(qrcode.ErrorCorrectionQuart),
)
```

--------------------------------

### Render QR Code in Terminal

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/terminal/README.md

Initializes a new QR code instance and uses the terminal writer to display it in the console.

```go
package main

import (
	"github.com/yeqown/go-qrcode/v2"
	"github.com/yeqown/go-qrcode/writer/terminal"
)

func main() {
	qrc, _ := qrcode.New("withTerminalWriter")

	w := terminal.New()

	if err := qrc.Save(w); err != nil {
		panic(err)
	}
}
```

--------------------------------

### Verify selected direct versions and unchanged image ceiling

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Uses rg to verify that testify is v1.11.1, CLI is v2.27.7, runewidth is v0.0.17, and x/image remains v0.24.0 in the specified go.mod files.

```bash
rg -n \
  'github.com/stretchr/testify v1.11.1|github.com/urfave/cli/v2 v2.27.7|github.com/mattn/go-runewidth v0.0.17|golang.org/x/image v0.24.0' \
  go.mod writer/standard/go.mod writer/terminal/go.mod cmd/qrcode/go.mod
```

--------------------------------

### WebAssembly instantiation and QR code generation

Source: https://github.com/yeqown/go-qrcode/blob/main/example/webassembly/index.html

This snippet shows how to load the WebAssembly module and call generateQRCode with an options object. The options include encodeVersion, encodeMode, encodeECLevel, outputBgColor, outputBgTransparent, outputQrColor, outputQrWidth, outputCircleShape, outputImageEncoder, and outputMargin. The result is a base64-encoded PNG image that is set as the source of an image element.

```javascript
const go = new Go();
WebAssembly.instantiateStreaming(fetch("com.github.yeqown.goqrcode.wasm"), go.importObject).then( result => {
    go.run(result.instance)
} );
const runFunction = function runFunction() {
    let option = {
        encodeVersion: 0,
        encodeMode: 2,
        encodeECLevel: "Q",
        outputBgColor: "#123123",
        outputBgTransparent: true,
        outputQrColor: "#666666",
        outputQrWidth: 20,
        outputCircleShape: true,
        outputImageEncoder: "png",
        outputMargin: 20,
    }
    let rr = generateQRCode("https://github.com/yeqown", option);
    console.log(generateQRCode);
    console.log("runFunction called", rr);
    if (rr.success) {
        document.getElementById("qrc").src = "data:image/png;base64," + rr.base64EncodedImage;
    }
}
```

--------------------------------

### Verify Go Baselines with Workspace Integration

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Iterates through specified module directories to run tests and vet checks using a specific Go toolchain and workspace configuration.

```bash
for module_dir in writer/file example; do
  (
    cd "$module_dir"
    GOTOOLCHAIN=go1.20.14 GOWORK="$go120_workspace_dir/go.work" go test ./...
    GOTOOLCHAIN=go1.20.14 GOWORK="$go120_workspace_dir/go.work" go vet ./...
  )
done
```

--------------------------------

### Generate halftone QR code with standard.WithHalftone

Source: https://github.com/yeqown/go-qrcode/blob/main/example/with-halftone/README.md

Generates a QR code with a halftone background image using the standard package. The transparent flag enables a transparent background and PNG format. Requires the standard package and a test.jpeg image.

```go
var (
	transparent = flag.Bool("transparent", false, "set background to transparent")
)

func main() {
	qrc, err := qrcode.New("https://github.com/yeqown/go-qrcode")
	if err != nil {
		panic(err)
	}
	
	options := []standard.ImageOption{
		standard.WithHalftone("./test.jpeg"),
		standard.WithQRWidth(21),
	}
	filename := "./halftone-qr.png"
	
	if *transparent {
		options = append(
			options,
			standard.WithBuiltinImageEncoder(standard.PNG_FORMAT),
			standard.WithBgTransparent(),
		)
		filename = "./halftone-qr-transparent.png"
	}
	
	w0, err := standard.New(filename, options...)
	handleErr(err)
	err = qrc.Save(w0)
	handleErr(err)
}
```

--------------------------------

### Create lightweight local tags

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Create local tags for the release on the verified commit.

```bash
git tag v2.3.0
git tag writer/standard/v1.4.0
git tag writer/terminal/v1.1.3
git tag writer/file/v1.0.1
git tag writer/compressed/v1.0.2
```

--------------------------------

### Standard writer image options

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Lists all available ImageOption functions with their signatures and comments. Includes options for background, foreground, gradient, logo, shape, encoder, border, halftone, and logo size.

```go
// WithBgTransparent makes the background transparent.
func WithBgTransparent() ImageOption {}

// WithBgColor background color
func WithBgColor(c color.Color) ImageOption {}

// WithBgColorRGBHex background color
func WithBgColorRGBHex(hex string) ImageOption {}

// WithFgColor QR color
func WithFgColor(c color.Color) ImageOption {}

// WithFgColorRGBHex Hex string to set QR Color
func WithFgColorRGBHex(hex string) ImageOption {}

// QR gradient
func WithFgGradient(g *LinearGradient)

// WithLogoImage .
func WithLogoImage(img image.Image) ImageOption {}

// WithLogoImageFilePNG load image from file, PNG is required
func WithLogoImageFilePNG(f string) ImageOption {}

// WithLogoImageFileJPEG load image from file, JPEG is required
func WithLogoImageFileJPEG(f string) ImageOption {}

// WithQRWidth specify width of each qr block
func WithQRWidth(width uint8) ImageOption {}

// WithCircleShape use circle shape as rectangle(default)
func WithCircleShape() ImageOption {}

// WithCustomShape use custom shape as rectangle(default)
func WithCustomShape(shape IShape) ImageOption {}

// WithBuiltinImageEncoder option includes: JPEG_FORMAT as default, PNG_FORMAT.
// This works like WithBuiltinImageEncoder, the different between them is
// formatTyp is enumerated in (JPEG_FORMAT, PNG_FORMAT)
func WithBuiltinImageEncoder(format formatTyp) ImageOption

// WithCustomImageEncoder to use custom image encoder to encode image.Image into
// io.Writer
func WithCustomImageEncoder(encoder ImageEncoder) ImageOption

// WithBorderWidth specify the both 4 sides' border width. Notice that
// WithBorderWidth(a) means all border width use this variable `a`,
// WithBorderWidth(a, b) mean top/bottom equal to `a`, left/right equal to `b`.
// WithBorderWidth(a, b, c, d) mean top, right, bottom, left.
func WithBorderWidth(widths ...int) ImageOption

// WithHalftone ...
func WithHalftone(path string) ImageOption

// WithLogoSizeMultiplier used in Writer in validLogoImage method to validate logo size
func WithLogoSizeMultiplier(multiplier int)

// WithLogoSafeZone specify the safe zone of logo image
func WithLogoSafeZone()
```

--------------------------------

### standard.WithLogoImageFilePNG

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that loads a logo image from a PNG file and places it in the center of the QR code.

```APIDOC
## standard.WithLogoImageFilePNG

### Description
Returns an ImageOption that loads a logo image from a PNG file and places it in the center of the QR code.

### Method
WithLogoImageFilePNG

### Signature
func WithLogoImageFilePNG(f string) ImageOption

### Parameters
- **f** (string) - Required - The path to the PNG file.
```

--------------------------------

### Test and Vet Go 1.19 Consumers

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Iterates through module directories to run tests and vet commands using the Go 1.19.13 toolchain.

```bash
for module_dir in . cmd/qrcode writer/compressed writer/standard writer/terminal; do
  (
    cd "$module_dir"
    GOTOOLCHAIN=go1.19.13 GOWORK="$go119_workspace_dir/go.work" go test ./...
    GOTOOLCHAIN=go1.19.13 GOWORK="$go119_workspace_dir/go.work" go vet ./...
  )
done
```

--------------------------------

### Run Combined Workspace Integration

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Initializes a temporary workspace, replaces local modules, and executes tests across all project modules.

```bash
integration_workspace_dir=$(mktemp -d /private/tmp/go-qrcode-integration.XXXXXX)
(
  cd "$integration_workspace_dir"
  go work init \
    /Users/apple/projects/opensource/go-qrcode \
    /Users/apple/projects/opensource/go-qrcode/.issues \
    /Users/apple/projects/opensource/go-qrcode/cmd/qrcode \
    /Users/apple/projects/opensource/go-qrcode/cmd/wasm \
    /Users/apple/projects/opensource/go-qrcode/example \
    /Users/apple/projects/opensource/go-qrcode/writer/compressed \
    /Users/apple/projects/opensource/go-qrcode/writer/file \
    /Users/apple/projects/opensource/go-qrcode/writer/standard \
    /Users/apple/projects/opensource/go-qrcode/writer/terminal
  go work edit \
    -replace=github.com/yeqown/go-qrcode/v2@v2.3.0=/Users/apple/projects/opensource/go-qrcode \
    -replace=github.com/yeqown/go-qrcode/writer/standard@v1.4.0=/Users/apple/projects/opensource/go-qrcode/writer/standard \
    -replace=github.com/yeqown/go-qrcode/writer/terminal@v1.1.3=/Users/apple/projects/opensource/go-qrcode/writer/terminal \
    -replace=github.com/yeqown/go-qrcode/writer/file@v1.0.1=/Users/apple/projects/opensource/go-qrcode/writer/file \
    -replace=github.com/yeqown/go-qrcode/writer/compressed@v1.0.2=/Users/apple/projects/opensource/go-qrcode/writer/compressed
)

for module_dir in . .issues cmd/qrcode example writer/compressed writer/file writer/standard writer/terminal; do
  (
    cd "$module_dir"
    GOWORK="$integration_workspace_dir/go.work" go test ./...
  )
done
```

--------------------------------

### Build WASM binary with GOOS=js GOARCH=wasm

Source: https://github.com/yeqown/go-qrcode/blob/main/cmd/wasm/README.md

Command to build the WebAssembly binary from the cmd/wasm directory. Sets GOOS=js and GOARCH=wasm and outputs to com.github.yeqown.goqrcode.wasm.

```bash
cd $PATH/to/go-qrcode/cmd/wasm
GOOS=js GOARCH=wasm go build -o com.github.yeqown.goqrcode.wasm .
```

--------------------------------

### Verify Directives and Formatting

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Uses ripgrep to check Go directives and module references, and git to verify file integrity and status.

```bash
rg -n '^go ' --hidden -g 'go.mod' -g 'go.work'
rg -n 'github.com/yeqown/go-qrcode' --hidden -g 'go.mod'
git diff --check
git status --short
```

--------------------------------

### Build with Race Detector

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Builds the project with the race detector enabled using the integration workspace.

```bash
GOWORK="$integration_workspace_dir/go.work" go build -race ./...
```

--------------------------------

### qrcode [global options] command [command options] [arguments...]

Source: https://github.com/yeqown/go-qrcode/blob/main/cmd/qrcode/README.md

The main command for generating QR codes. It accepts source text as an argument and various global options to customize output.

```APIDOC
## COMMAND [qrcode]

### Description
The qrcode command generates a QR code from the provided source text. It supports various options to control output format, size, and borders.

### Method
CLI command

### Usage
`qrcode [global options] command [command options] [arguments...]`

### Global Options
- `--terminal` (bool) - Optional - If set, prints the QR code to the terminal instead of saving to a file. Default: false
- `--output value, -o value` (string) - Optional - Specifies the output file path. Default: "qrcode.jpg"
- `--block value, -s value` (int) - Optional - Size of each block in pixels. Default: 5
- `--borders value, -b value` (string) - Optional - Border widths as comma-separated values for top, right, bottom, left. Format: "top,right,bottom,left". Default: "0,0,0,0"
- `--circle` (bool) - Optional - Uses circular blocks in the QR code. Default: false
- `--help, -h` (bool) - Optional - Shows help information. Default: false
- `--version, -v` (bool) - Optional - Prints the version. Default: false

### Command
- `help, h` - Shows a list of commands or help for one command.

### Examples

Generate a QR code into a file with default options:
```sh
qrcode "Hello, World!"
```

Generate a QR code into a PNG file with custom block size and borders:
```sh
qrcode -o qrcode.png -s 20 -b 20,20,20,20 -m "Hello, World!"
```

Note: The example includes `-m` flag which is not listed in the global options; it may be an undocumented flag or a typo.

Generate a QR code into the terminal:
```sh
qrcode --terminal "Hello, World!"
```
```

--------------------------------

### Upgrade root and standard test dependencies

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Upgrades github.com/stretchr/testify to v1.11.1 in the root module and the writer/standard module, using GOTOOLCHAIN=go1.19.13 and GOWORK=off.

```bash
GOTOOLCHAIN=go1.19.13 GOWORK=off go get github.com/stretchr/testify@v1.11.1
```

```bash
(
  cd writer/standard
  GOTOOLCHAIN=go1.19.13 GOWORK=off go get github.com/stretchr/testify@v1.11.1
)
```

--------------------------------

### Run CI-equivalent Race Tests under Go 1.19

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Executes race detection tests for specific modules using the Go 1.19.13 toolchain.

```bash
for module_dir in . writer/standard writer/terminal; do
  (
    cd "$module_dir"
    GOTOOLCHAIN=go1.19.13 GOWORK="$go119_workspace_dir/go.work" go test -race ./...
  )
done
```

--------------------------------

### Run the final release gate

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Verify the worktree state and commit history before proceeding with the release.

```bash
git status --short
git diff --check origin/main...HEAD
git log --oneline --decorate origin/main..HEAD
```

--------------------------------

### Pseudocode for custom writer implementation

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/README.md

Illustrates the structure of a custom writer implementing the Writer interface. It iterates over the matrix and paints white or black blocks based on the state, with a note that states can be mapped to colors for intensive control.

```text
// define your own writer structure to implement `Writer` interface.
object writer {};

writer.Write(matrix.Matrix):
	// these should be `IMAGE` stream controller, it receives matrix
	// it decide how to print the image. 
	object paint;  
	
	// set use BLACK, unset use WHITE. Or provides matrix.State to colors mapping
	// so that you can control QR Image output intensively. 
	foreach row in matrix:
		foreach column in row:
			if column.State in [StateFalse]:
				// paint a WHITE square block
				paint.draw(x, y, WHITE);
			else:
				// paint a BLACK square block, 
				paint.draw(x, y, BLACK);
	// loop end;
	// output paint;
```

--------------------------------

### standard.WithHalftone

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that applies a halftone effect using an image file.

```APIDOC
## standard.WithHalftone

### Description
Returns an ImageOption that applies a halftone effect using an image file.

### Method
WithHalftone

### Signature
func WithHalftone(path string) ImageOption

### Parameters
- **path** (string) - Required - The path to the halftone image file.
```

--------------------------------

### standard.WithQRWidth

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that specifies the width of each QR code block (module).

```APIDOC
## standard.WithQRWidth

### Description
Returns an ImageOption that specifies the width of each QR code block (module).

### Method
WithQRWidth

### Signature
func WithQRWidth(width uint8) ImageOption

### Parameters
- **width** (uint8) - Required - The width of each QR block.
```

--------------------------------

### standard.WithLogoImageFileJPEG

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that loads a logo image from a JPEG file and places it in the center of the QR code.

```APIDOC
## standard.WithLogoImageFileJPEG

### Description
Returns an ImageOption that loads a logo image from a JPEG file and places it in the center of the QR code.

### Method
WithLogoImageFileJPEG

### Signature
func WithLogoImageFileJPEG(f string) ImageOption

### Parameters
- **f** (string) - Required - The path to the JPEG file.
```

--------------------------------

### standard.New

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Creates a new standard writer that writes the QR code image to a file. The file is created automatically. Options can be provided to customize the image.

```APIDOC
## standard.New

### Description
Creates a new standard writer that writes the QR code image to a file. The file is created automatically.

### Method
New

### Signature
func New(filename string, options ...ImageOption) (Writer, error)

### Parameters
- **filename** (string) - Required - The path to the output file.
- **options** (ImageOption) - Optional - A variadic list of image options to customize the QR code rendering.

### Usage Example
```go
options := []standard.ImageOption{
    standard.WithBgColorRGBHex("#ffffff"),
    standard.WithFgColorRGBHex("#000000"),
    // more ...
}

writer, err := standard.New("filename", options...)
```
```

--------------------------------

### Upgrade CLI dependency

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Upgrades github.com/urfave/cli/v2 to v2.27.7 in the cmd/qrcode module.

```bash
(
  cd cmd/qrcode
  GOTOOLCHAIN=go1.19.13 GOWORK=off go get github.com/urfave/cli/v2@v2.27.7
)
```

--------------------------------

### standard.WithBuiltinImageEncoder

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that sets the built-in image encoder format (JPEG or PNG).

```APIDOC
## standard.WithBuiltinImageEncoder

### Description
Returns an ImageOption that sets the built-in image encoder format (JPEG or PNG).

### Method
WithBuiltinImageEncoder

### Signature
func WithBuiltinImageEncoder(format formatTyp) ImageOption

### Parameters
- **format** (formatTyp) - Required - The format type, one of JPEG_FORMAT or PNG_FORMAT.
```

--------------------------------

### standard.NewWith

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Creates a new standard writer that writes the QR code image to an io.WriteCloser. This allows writing to any writable stream, such as a network connection or in-memory buffer.

```APIDOC
## standard.NewWith

### Description
Creates a new standard writer that writes the QR code image to an io.WriteCloser.

### Method
NewWith

### Signature
func NewWith(w io.WriteCloser, options ...ImageOption) (Writer, error)

### Parameters
- **w** (io.WriteCloser) - Required - The destination writer that implements io.WriteCloser.
- **options** (ImageOption) - Optional - A variadic list of image options to customize the QR code rendering.

### Usage Example
```go
var w io.WriteCloser
writer2, err := standard.NewWith(w, options...)
```
```

--------------------------------

### Review and commit the external dependency update

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Checks the diff and status, then stages and commits the dependency metadata changes. If go.work.sum did not change, omit it from git add.

```bash
git diff --check
git diff -- go.mod go.sum writer/standard/go.mod writer/terminal/go.mod cmd/qrcode/go.mod go.work.sum
git status --short
```

```bash
git add go.mod go.sum writer/standard/go.mod writer/terminal/go.mod cmd/qrcode/go.mod go.work.sum
git commit -m "chore(deps): update compatible external dependencies"
```

--------------------------------

### Verify Issues Module under Go 1.19

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Copies the issues module to a temporary directory, reconfigures the module path, and runs tests and vet commands.

```bash
issues_go119_dir=$(mktemp -d /private/tmp/issues-go119.XXXXXX)
cp -R .issues/. "$issues_go119_dir"
(
  cd "$issues_go119_dir"
  GOTOOLCHAIN=go1.19.13 GOWORK=off go mod edit \
    -module=example.com/issues \
    -replace=github.com/yeqown/go-qrcode/v2@v2.3.0=/Users/apple/projects/opensource/go-qrcode \
    -replace=github.com/yeqown/go-qrcode/writer/compressed@v1.0.2=/Users/apple/projects/opensource/go-qrcode/writer/compressed
  GOTOOLCHAIN=go1.19.13 GOWORK=off go mod tidy -go=1.19 -compat=1.19
  GOTOOLCHAIN=go1.19.13 GOWORK=off go test ./...
  GOTOOLCHAIN=go1.19.13 GOWORK=off go vet ./...
)
```

--------------------------------

### Create ignored test fixture directories

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Creates testdata directories for writer/standard and writer/terminal. These directories are expected to be git-ignored, so git status remains clean.

```bash
mkdir -p writer/standard/testdata writer/terminal/testdata
```

--------------------------------

### Align command module requirements

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Updates the go.mod files for the qrcode command module to use specific internal versions.

```bash
(  cd cmd/qrcode  go mod edit     -require=github.com/yeqown/go-qrcode/v2@v2.3.0     -require=github.com/yeqown/go-qrcode/writer/standard@v1.4.0     -require=github.com/yeqown/go-qrcode/writer/terminal@v1.1.3)
```

--------------------------------

### standard.WithLogoImage

Source: https://github.com/yeqown/go-qrcode/blob/main/writer/standard/README.md

Returns an ImageOption that sets a logo image to be placed in the center of the QR code.

```APIDOC
## standard.WithLogoImage

### Description
Returns an ImageOption that sets a logo image to be placed in the center of the QR code.

### Method
WithLogoImage

### Signature
func WithLogoImage(img image.Image) ImageOption

### Parameters
- **img** (image.Image) - Required - The logo image.
```

--------------------------------

### Re-run tests for externally changed modules

Source: https://github.com/yeqown/go-qrcode/blob/main/docs/superpowers/plans/2026-08-05-dependency-and-module-release.md

Runs go test for the root module, writer/standard, writer/terminal, and cmd/qrcode modules. The cmd/qrcode test uses -mod=mod.

```bash
GOTOOLCHAIN=go1.19.13 GOWORK=off go test ./...
```

```bash
for module_dir in writer/standard writer/terminal; do
  (
    cd "$module_dir"
    GOTOOLCHAIN=go1.19.13 GOWORK=off go test ./...
  )
done
```

```bash
(
  cd cmd/qrcode
  GOTOOLCHAIN=go1.19.13 GOWORK=off go test -mod=mod ./...
)
```
Tokens:
Raw