Skip to content

Commit e26833f

Browse files
committed
ref: rename package age to agenor (#411)
ref: rename module from agenor to jaywalk (#411) ref: restructure repo layout (#411) ref: rename package age to agenor (#411)
1 parent 7f40058 commit e26833f

301 files changed

Lines changed: 1062 additions & 1062 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CLAUDE.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ filtering, hibernation (deferred activation of callbacks until a condition is me
88
resume from a previously interrupted session, concurrent navigation via pants worker pool,
99
and hook-able traversal behaviour.
1010

11-
- **Module**: `github.com/snivilised/agenor`
12-
- **Package alias**: `age` (import as `age "github.com/snivilised/agenor"`)
13-
- **Docs**: <https://pkg.go.dev/github.com/snivilised/agenor>
11+
- **Module**: `github.com/snivilised/jaywalk`
12+
- **Package alias**: `age` (import as `jw "github.com/snivilised/jaywalk"`)
13+
- **Docs**: <https://pkg.go.dev/github.com/snivilised/jaywalk>
1414

1515
## Build & Test Commands
1616

@@ -70,10 +70,10 @@ The low-level API composes these explicitly:
7070

7171
```go
7272
// Walk/Prime
73-
age.Walk().Configure().Extent(age.Prime(facade, opts...)).Navigate(ctx)
73+
jw.Walk().Configure().Extent(jw.Prime(facade, opts...)).Navigate(ctx)
7474

7575
// Run/Resume
76-
age.Run(wg).Configure().Extent(age.Resume(facade, opts...)).Navigate(ctx)
76+
jw.Run(wg).Configure().Extent(jw.Resume(facade, opts...)).Navigate(ctx)
7777
```
7878

7979
### Scenario composites
@@ -92,10 +92,10 @@ lint warnings from bare literals:
9292

9393
```go
9494
const isPrime = true
95-
age.Tortoise(isPrime)(facade, opts...).Navigate(ctx)
95+
jw.Tortoise(isPrime)(facade, opts...).Navigate(ctx)
9696

9797
var wg sync.WaitGroup
98-
age.Hare(isPrime, &wg)(facade, opts...).Navigate(ctx)
98+
jw.Hare(isPrime, &wg)(facade, opts...).Navigate(ctx)
9999
wg.Wait()
100100
```
101101

@@ -113,12 +113,12 @@ relic := &pref.Relic{...} // resume sessions only
113113

114114
### Enums
115115

116-
All enum values are in the `enums` package. Do not use `age.` prefixed aliases
116+
All enum values are in the `enums` package. Do not use `jw.` prefixed aliases
117117
for enum values - use `enums.` directly:
118118

119119
```go
120-
enums.SubscribeFiles // not age.SubscribeFiles
121-
enums.MetricNoFilesInvoked // not age.MetricNoFilesInvoked
120+
enums.SubscribeFiles // not jw.SubscribeFiles
121+
enums.MetricNoFilesInvoked // not jw.MetricNoFilesInvoked
122122
enums.ResumeStrategyFastward
123123
```
124124

@@ -128,27 +128,27 @@ Options are passed as variadic `...pref.Option` to `Prime`/`Resume` or to a comp
128128
All `With*` option constructors are re-exported from the root `age` package:
129129

130130
```go
131-
age.WithFilter(...)
132-
age.WithDepth(5)
133-
age.WithOnBegin(handler)
134-
age.WithCPU // use all available CPUs for Run
135-
age.WithNoW(n) // use n workers for Run
131+
jw.WithFilter(...)
132+
jw.WithDepth(5)
133+
jw.WithOnBegin(handler)
134+
jw.WithCPU // use all available CPUs for Run
135+
jw.WithNoW(n) // use n workers for Run
136136
```
137137

138-
Use `age.IfOption` / `age.IfOptionF` / `age.IfElseOptionF` for conditional options.
138+
Use `jw.IfOption` / `jw.IfOptionF` / `jw.IfElseOptionF` for conditional options.
139139

140140
## Key Types
141141

142142
| Type | Package | Purpose |
143143
| --- | --- | --- |
144-
| `age.Node` | `core` | A file system node passed to the client callback |
145-
| `age.Servant` | `core` | Provides the client with traversal properties |
146-
| `age.Client` | `core` | The callback signature: `func(node *age.Node) error` |
147-
| `age.Navigator` | `core` | Returned by `Extent()`; call `.Navigate(ctx)` on it |
148-
| `age.Options` | `pref` | Full options struct available inside `With*` constructors |
149-
| `age.Using` | `pref` | Alias for `pref.Using` (Prime facade) |
150-
| `age.Relic` | `pref` | Alias for `pref.Relic` (Resume facade) |
151-
| `age.TraversalFS` | `tfs` | File system interface required for traversal |
144+
| `jw.Node` | `core` | A file system node passed to the client callback |
145+
| `jw.Servant` | `core` | Provides the client with traversal properties |
146+
| `jw.Client` | `core` | The callback signature: `func(node *jw.Node) error` |
147+
| `jw.Navigator` | `core` | Returned by `Extent()`; call `.Navigate(ctx)` on it |
148+
| `jw.Options` | `pref` | Full options struct available inside `With*` constructors |
149+
| `jw.Using` | `pref` | Alias for `pref.Using` (Prime facade) |
150+
| `jw.Relic` | `pref` | Alias for `pref.Relic` (Resume facade) |
151+
| `jw.TraversalFS` | `tfs` | File system interface required for traversal |
152152

153153
## Internal Packages (do not import directly)
154154

@@ -163,15 +163,15 @@ Use `age.IfOption` / `age.IfOptionF` / `age.IfElseOptionF` for conditional optio
163163

164164
## Test Helpers
165165

166-
- **`test/hanno`** (`github.com/snivilised/agenor/test/hanno`) - utilities for building
166+
- **`test/hanno`** (`github.com/snivilised/jaywalk/test/hanno`) - utilities for building
167167
virtual file system trees; see `GO-USER-CONFIG.md` for `Nuxx` usage
168168
- **`test/data/musico-index.xml`** - standard XML fixture representing a sample music
169169
directory tree, used by `Nuxx` to populate an in-memory file system
170170
- **`internal/laboratory`** - internal-only test utilities; do not use from outside the module
171171

172172
## i18n
173173

174-
- Translation structs are defined in `github.com/snivilised/agenor/locale`
174+
- Translation structs are defined in `github.com/snivilised/jaywalk/locale`
175175
- Follow the i18n conventions in `GO-USER-CONFIG.md`
176176

177177
## File References

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
[![A B](https://img.shields.io/badge/branching-commonflow-informational?style=flat)](https://commonflow.org)
44
[![A B](https://img.shields.io/badge/merge-rebase-informational?style=flat)](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
55
[![A B](https://img.shields.io/badge/branch%20history-linear-blue?style=flat)](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
6-
[![Go Reference](https://pkg.go.dev/badge/github.com/snivilised/agenor.svg)](https://pkg.go.dev/github.com/snivilised/agenor)
7-
[![Go report](https://goreportcard.com/badge/github.com/snivilised/agenor)](https://goreportcard.com/report/github.com/snivilised/agenor)
6+
[![Go Reference](https://pkg.go.dev/badge/github.com/snivilised/jaywalk.svg)](https://pkg.go.dev/github.com/snivilised/jaywalk)
7+
[![Go report](https://goreportcard.com/badge/github.com/snivilised/jaywalk)](https://goreportcard.com/report/github.com/snivilised/jaywalk)
88
[![Coverage Status](https://coveralls.io/repos/github/snivilised/agenor/badge.svg?branch=main)](https://coveralls.io/github/snivilised/agenor?branch=main&kill_cache=1)
9-
[![Astrolib Continuous Integration](https://github.com/snivilised/agenor/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/snivilised/agenor/actions/workflows/ci-workflow.yml)
9+
[![Astrolib Continuous Integration](https://github.com/snivilised/jaywalk/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/snivilised/jaywalk/actions/workflows/ci-workflow.yml)
1010
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
1111
[![A B](https://img.shields.io/badge/commit-conventional-commits?style=flat)](https://www.conventionalcommits.org/)
1212

cmd/jay/CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
`jay` is a Go CLI application that acts as a companion tool to the `agenor` directory-walking library. It uses `cobra`/`mamba` for the CLI layer and `viper` for configuration management.
66

7-
- **Repo**: `github.com/snivilised/agenor` (`jay` lives at `cmd/jay` within it)
8-
- **Module**: `github.com/snivilised/agenor` (jay is the CLI frontend, located at `cmd/jay` within the agenor module)
7+
- **Repo**: `github.com/snivilised/jaywalk` (`jay` lives at `cmd/jay` within it)
8+
- **Module**: `github.com/snivilised/jaywalk` (jay is the CLI frontend, located at `cmd/jay` within the agenor module)
99
- **Entry point for jay**: `./cmd/jay/main.go`
1010

1111
## Build & Test Commands
@@ -32,7 +32,7 @@ All flags are defined in `cmd/internal/cfg/flags.go`.
3232

3333
## agenor Integration
3434

35-
`jay` uses `agenor` (`github.com/snivilised/agenor`) as its directory-walking backend. Follow these conventions:
35+
`jay` uses `agenor` (`github.com/snivilised/jaywalk`) as its directory-walking backend. Follow these conventions:
3636

3737
- Construct facades as named variables before passing to `Tortoise`/`Hare` - never inline:
3838

@@ -53,7 +53,7 @@ All flags are defined in `cmd/internal/cfg/flags.go`.
5353

5454
## i18n
5555

56-
- Translation structs are defined in `github.com/snivilised/agenor/locale`
56+
- Translation structs are defined in `github.com/snivilised/jaywalk/locale`
5757
- Follow the i18n conventions in `GO-USER-CONFIG.md`; locale struct placement is per the package above
5858

5959
## File References

cmd/jay/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package main
22

33
import (
4-
"github.com/snivilised/agenor/cmd/command"
4+
"github.com/snivilised/jaywalk/src/app/command"
55
)
66

77
func main() {

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/snivilised/agenor
1+
module github.com/snivilised/jaywalk
22

33
go 1.26.0
44

locale/locale-defs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package locale
33
const (
44
// SourceID defines the ID (by convention the repo URL) required
55
// for i18n translation purposes.
6-
SourceID = "github.com/snivilised/agenor"
6+
SourceID = "github.com/snivilised/jaywalk/src/agenor"
77
)
88

99
type agenorTemplData struct{}

locale/messages-errors_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import (
88
. "github.com/onsi/ginkgo/v2"
99
. "github.com/onsi/gomega"
1010

11-
"github.com/snivilised/agenor/locale"
12-
"github.com/snivilised/agenor/test/hanno"
11+
"github.com/snivilised/jaywalk/locale"
12+
"github.com/snivilised/jaywalk/src/agenor/test/hanno"
1313
"github.com/snivilised/li18ngo"
1414
)
1515

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
github.com/snivilised/agenor/enums
2-
github.com/snivilised/agenor/internal/filtering/constant.go
3-
github.com/snivilised/agenor/internal/third
4-
github.com/snivilised/agenor/internal/laboratory
5-
github.com/snivilised/agenor/test/hanno
6-
github.com/snivilised/agenor/test/hydra
7-
github.com/snivilised/agenor/test/cmd
1+
github.com/snivilised/jaywalk/enums
2+
github.com/snivilised/jaywalk/internal/filtering/constant.go
3+
github.com/snivilised/jaywalk/internal/third
4+
github.com/snivilised/jaywalk/internal/laboratory
5+
github.com/snivilised/jaywalk/test/hanno
6+
github.com/snivilised/jaywalk/test/hydra
7+
github.com/snivilised/jaywalk/test/cmd

builders.go renamed to src/agenor/builders.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
package age
1+
package agenor
22

33
import (
4-
"github.com/snivilised/agenor/enums"
5-
"github.com/snivilised/agenor/internal/enclave"
6-
"github.com/snivilised/agenor/internal/kernel"
7-
"github.com/snivilised/agenor/internal/third/lo"
8-
"github.com/snivilised/agenor/pref"
4+
"github.com/snivilised/jaywalk/src/agenor/enums"
5+
"github.com/snivilised/jaywalk/src/agenor/internal/enclave"
6+
"github.com/snivilised/jaywalk/src/agenor/internal/kernel"
7+
"github.com/snivilised/jaywalk/src/internal/third/lo"
8+
"github.com/snivilised/jaywalk/src/agenor/pref"
99
)
1010

1111
type buildArtefacts struct {
File renamed without changes.

0 commit comments

Comments
 (0)