golang.org/x/text v0.34.0: collate.Collator.CompareString

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify collate.Collator.CompareString in pkg:golang/golang.org/x/text@v0.34.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/text@v0.34.0
Demonstrate these symbols/APIs:
  - collate.Collator.CompareString
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

package sample

import (
	"testing"

	"golang.org/x/text/collate"
	"golang.org/x/text/language"
)

func TestCompareStringIdentical(t *testing.T) {
	c := collate.New(language.English)
	if res := c.CompareString("hello", "hello"); res != 0 {
		t.Fatalf("expected 0 for identical strings, got %d", res)
	}
}

func TestCompareStringLexicographicalOrder(t *testing.T) {
	c := collate.New(language.English)
	if res := c.CompareString("apple", "banana"); res != -1 {
		t.Fatalf("expected -1 for apple < banana, got %d", res)
	}
	if res := c.CompareString("zebra", "apple"); res != 1 {
		t.Fatalf("expected 1 for zebra > apple, got %d", res)
	}
}

func TestCompareStringIgnoreCase(t *testing.T) {
	cDefault := collate.New(language.English)
	if res := cDefault.CompareString("golang", "GOLANG"); res == 0 {
		t.Fatalf("expected non-zero without IgnoreCase, got %d", res)
	}

	cIgnore := collate.New(language.English, collate.IgnoreCase)
	if res := cIgnore.CompareString("golang", "GOLANG"); res != 0 {
		t.Fatalf("expected 0 with IgnoreCase, got %d", res)
	}
}

func TestCompareStringLoose(t *testing.T) {
	cDefault := collate.New(language.English)
	if res := cDefault.CompareString("resume", "résumé"); res == 0 {
		t.Fatalf("expected non-zero without Loose, got %d", res)
	}

	cLoose := collate.New(language.English, collate.Loose)
	if res := cLoose.CompareString("resume", "résumé"); res != 0 {
		t.Fatalf("expected 0 with Loose option, got %d", res)
	}
}

func TestCompareStringNumeric(t *testing.T) {
	cDefault := collate.New(language.English)
	if res := cDefault.CompareString("item2", "item12"); res != 1 {
		t.Fatalf("expected 1 without Numeric (lexicographical '2' > '1'), got %d", res)
	}

	cNumeric := collate.New(language.English, collate.Numeric)
	if res := cNumeric.CompareString("item2", "item12"); res != -1 {
		t.Fatalf("expected -1 with Numeric option ('item2' < 'item12'), got %d", res)
	}
}

func TestCompareStringLocaleSpecificSwedish(t *testing.T) {
	cSwedish := collate.New(language.Swedish)
	if res := cSwedish.CompareString("ö", "z"); res != 1 {
		t.Fatalf("expected 1 (ö > z in Swedish collation), got %d", res)
	}
}

{"case":{"caseId":"case:sha256:08dfa28e35d906b6de03044cde18b92da6298c47cdd4d8e13ee65b3e590dcd5c","contract":["collate.New initialized with language.English returns 0 when CompareString is called on identical strings","collate.New initialized with language.English returns -1 for 'apple' vs 'banana' and 1 for 'zebra' vs 'apple'","collate.New with collate.IgnoreCase returns 0 when CompareString is called on 'golang' and 'GOLANG'","collate.New with collate.Loose returns 0 when CompareString is called on 'resume' and 'résumé'","collate.New with collate.Numeric returns -1 when CompareString is called on 'item2' and 'item12'","collate.New initialized with language.Swedish returns 1 when CompareString compares 'ö' and 'z'"],"goal":"verify collate.Collator.CompareString in pkg:golang/golang.org/x/text@v0.34.0","kind":"HOW","packages":["pkg:golang/golang.org/x/text@v0.34.0"],"schemaVersion":1,"symbols":["collate.Collator.CompareString"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/golang.org/x/text@v0.34.0"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/text@v0.34.0","symbols":["collate.Collator.CompareString"],"verifierAdapter":"golang@1"}

module sample-851534276

go 1.24.0

require golang.org/x/text v0.34.0

golang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk=
golang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA=

package sample

import (
	"golang.org/x/text/collate"
	"golang.org/x/text/language"
)

// CompareStrings compares two strings using the specified language tag and collation options.
func CompareStrings(tag language.Tag, a, b string, opts ...collate.Option) int {
	c := collate.New(tag, opts...)
	return c.CompareString(a, b)
}

{
  "schemaVersion": 1,
  "goal": "verify collate.Collator.CompareString in pkg:golang/golang.org/x/text@v0.34.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/text@v0.34.0"
  ],
  "symbols": [
    "collate.Collator.CompareString"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}