🔀 Merge branch 'release/1.0.0' into stable

🔖 Bump version just to publish example

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### [1.0.0] - 2025-03-31 - 🚀 Stable release!
+
+#### Support
+
+- 📝 Vastly improved [go docs](https://pkg.go.dev/codeberg.org/danjones000/nomino).
+- 📝 Fill out README with examples and links.
+
+#### Tools
+
+- 🛠 Replace all linting with golangci-lint
+
+#### Code quality
+
+- 🚨 A bunch of small improvements from new linter
+
 ### [0.5.0] - 2025-03-19 - ✨ Different types of UUIDs
 
 #### Features

README.md

@@ -4,10 +4,80 @@ The purpose of nomino is to generate (probably random) filenames, for example, i
 
 It takes a lot of inspiration (although no actual code) from [Onym](https://github.com/Blaspsoft/onym).
 
-Note that this is still not at a stable release. There will be breaking changes between minor releases until it reaches 1.0.0. Patch releases shouldn't contain breaking changes however. Once it reaches 1.0.0, breaking changes will only happen between major releases.
+Make sure to check out the [official documentation][docs].
 
-## TODO
+## Installation
 
-I'll fill this out more in depth later.
+Add `codeberg.org/danjones000/nomino` to your project. You can do `go get codeberg.org/danjones000/nomino`, or simply add it to an import and run `go mod tidy`.
 
-For now, check [official documentation](https://pkg.go.dev/codeberg.org/danjones000/nomino).
+But, you probably already know this.
+
+## Usage
+
+There are **a lot** of examples in the [official documentation][examples]. Take a look through these to get an idea.
+
+The main concept in `nomino` is the [Generator][]. The simplest way to generate a random filename, is to use the [Generator][] directly, in this way:
+
+```go
+import (
+    "fmt"
+    "codeberg.org/danjones000/nomino"
+)
+
+func main() {
+    name, _ := nomino.Random().Make()
+    fmt.Println(name) // Du3Sfh8p.txt
+}
+```
+
+The second argument is an error. Most of the generators are always successful, and that error will be `nil`, but you should check the errors if you're not sure.
+
+The second way to generate a new filename is using the [Make][] function.
+
+```go
+import (
+    "fmt"
+    "codeberg.org/danjones000/nomino"
+)
+
+func main() {
+    config := nomino.NewConfig(nomino.WithGenerator(nomino.Random()))
+    name, _ := nomino.Make(config)
+    fmt.Println(name) // Du3Sfh8p.txt
+}
+```
+
+Although in these examples, `nomino.Make` is more verbose, it can be beneficial to using that function if you have some customizations to how you generate the filenames.
+
+### Configuration
+
+The [Config][] allows you to customize how the generated filename works with various [Options][Option]. The [options][Option] allows you to customize things like [adding a prefix](https://pkg.go.dev/codeberg.org/danjones000/nomino#WithPrefix), or changing the [extension](https://pkg.go.dev/codeberg.org/danjones000/nomino#WithExtension) of the generated filename (by default, it uses `.txt`).
+
+Have a look at [all the Options][Option].
+
+### Generator
+
+The [Generator][] is the piece that returns the "random" portion of the generated filename, although, it doesn't actually have to be random.
+
+Here are the built-in [Generators][Generator]:
+
+- [UUID](https://pkg.go.dev/codeberg.org/danjones000/nomino#UUID) generates a UUID. This is the default if none is specified.
+- [Random](https://pkg.go.dev/codeberg.org/danjones000/nomino#Random) generates a random string. By default, it's 8 characters long, but can be whatever length you provide.
+- [Incremental](https://pkg.go.dev/codeberg.org/danjones000/nomino#Incremental) will generate just a series of integers, starting at 0.
+- [Timestamp](https://pkg.go.dev/codeberg.org/danjones000/nomino#Timestamp) generates a string from the current time. It will look like "2009-11-10T23-00-00+0000.txt", although this can be customized.
+- Both [Slug](https://pkg.go.dev/codeberg.org/danjones000/nomino#Slug) and [Hash](https://pkg.go.dev/codeberg.org/danjones000/nomino#Hash) work on the original name provided by [WithOriginal](https://pkg.go.dev/codeberg.org/danjones000/nomino#WithOriginal). Slug generats a slug from the name, while Hash hashes it. By default, it uses MD5.
+
+You can also use multiple generators, either [in order](https://pkg.go.dev/codeberg.org/danjones000/nomino#MultiGeneratorInOrder), or [in a random order](https://pkg.go.dev/codeberg.org/danjones000/nomino#MultiGeneratorRandomOrder).
+
+Finally, you can create a [custom generator](https://pkg.go.dev/codeberg.org/danjones000/nomino#example-WithGenerator-CustomGenerator) as well.
+
+## RTFM (Read the fabulous manual)
+
+[Official docs][docs], especially the [examples][]. Especially check out the [full example](https://pkg.go.dev/codeberg.org/danjones000/nomino#example-package), which includes how to use a global configuration.
+
+[docs]: https://pkg.go.dev/codeberg.org/danjones000/nomino
+[examples]: https://pkg.go.dev/codeberg.org/danjones000/nomino#pkg-examples
+[Generator]: https://pkg.go.dev/codeberg.org/danjones000/nomino#Generator
+[Config]: https://pkg.go.dev/codeberg.org/danjones000/nomino#Config
+[Option]: https://pkg.go.dev/codeberg.org/danjones000/nomino#Option
+[Make]: https://pkg.go.dev/codeberg.org/danjones000/nomino#Make

config.go

@@ -1,5 +1,6 @@
 package nomino
 
+// Config controls how the generatred filename is created.
 type Config struct {
 	original  string
 	prefix    string
@@ -9,7 +10,9 @@ type Config struct {
 	generator Generator
 }
 
-// NewConfig returns a new Config with the specified Options.
+// NewConfig returns a new [Config] with each [Option] specified.
+// With no Options, the Config uses an extension of .txt, a separator
+// of _, and the [UUID] [Generator].
 func NewConfig(options ...Option) Config {
 	conf := Config{
 		extension: ".txt",
@@ -22,7 +25,7 @@ func NewConfig(options ...Option) Config {
 	return conf
 }
 
-// AddOptions creates a new Config with options added.
+// AddOptions creates a new [Config] with each [Option] added.
 func (c Config) AddOptions(options ...Option) Config {
 	for _, opt := range options {
 		opt(&c)

examples_test.go

@@ -17,8 +17,10 @@ func NominoConfig() nomino.Config {
 	)
 }
 
-// / HandleImgUploads generates new filenames for images with a png extension.
+// HandleImgUploads generates new filenames for images with a png extension.
 func HandleImgUploads(orig string) string {
+	// Here, we use nomino.Make function to generate the filename.
+	// We use our global config, and add in a few extra Options specific to this.
 	newName, _ := nomino.Make(
 		NominoConfig(),
 		nomino.WithExtension("png"),
@@ -32,6 +34,8 @@ func HandleImgUploads(orig string) string {
 // We ignore the original filename and use a timestamp for the generated part
 // with a webm extension.
 func HandleVidUploads() string {
+	// Because we're using a different Generator, we chose to use the Make method on the Generator.
+	// We add in additional Options with the `AddOptions` method on the `Config`
 	newName, _ := nomino.Timestamp(nomino.TimestampUTC()).
 		MakeWithConfig(NominoConfig().AddOptions(
 			nomino.WithExtension("webm"),
@@ -39,7 +43,7 @@ func HandleVidUploads() string {
 	return newName
 }
 
-// Example shows how to use nomino.
+// This example shows how to use nomino.
 func Example() {
 	// Pretend we have an image upload
 	filename := "George"

gen_file.go

@@ -9,7 +9,7 @@ import (
 	"github.com/gosimple/slug"
 )
 
-// ErrMissingOriginal is the error returned by Slug if there is no filename.
+// ErrMissingOriginal is the error returned by [Slug] if there is no filename.
 var ErrMissingOriginal = errors.New("missing original filename")
 
 func getOriginal(c *Config) (string, error) {
@@ -37,21 +37,21 @@ func Slug(lang ...string) Generator {
 	}
 }
 
-// HashingFunc is a function that generates a hash.Hash.
+// HashingFunc is a function that generates a [hash.Hash].
 type HashingFunc func() hash.Hash
 
-// New allows HashingFunc to be used as a Hasher.
+// New allows [HashingFunc] to be used as a [Hasher].
 func (hf HashingFunc) New() hash.Hash {
 	return hf()
 }
 
-// Hasher is a type returns a hash.Hash.
-// All crypto.Hash may be used.
+// Hasher is a type returns a [hash.Hash].
+// All [crypto.Hash] may be used.
 type Hasher interface {
 	New() hash.Hash
 }
 
-// ErrInvalidHash is returned by the Hash generator when an invalid HashType is passed.
+// ErrInvalidHash is returned by the [Hash] [Generator] when an invalid [Hasher] is passed.
 var ErrInvalidHash = errors.New("invalid hash type")
 
 // Hash generates a name from a hash of the filename.

gen_int.go

@@ -11,7 +11,7 @@ type incConf struct {
 	cb    func(int) string
 }
 
-// IncrementalOption sets an option for the Incremental Generator.
+// IncrementalOption sets an option for the [Incremental] [Generator].
 type IncrementalOption func(c *incConf)
 
 // Incremental generates a name that is a series of integers.
@@ -30,21 +30,21 @@ func Incremental(opts ...IncrementalOption) Generator {
 	}
 }
 
-// IncrementalStart sets the starting integer for Incremental.
+// IncrementalStart sets the starting integer for [Incremental].
 func IncrementalStart(start int) IncrementalOption {
 	return func(c *incConf) {
 		c.start = start
 	}
 }
 
-// IncrementalStepsets the step by which Incremental increases with each invocation.
+// IncrementalStepsets the step by which [Incremental] increases with each invocation.
 func IncrementalStep(step int) IncrementalOption {
 	return func(c *incConf) {
 		c.step = step
 	}
 }
 
-// IncrementalFormatsets the format for the number generated by Incremental.
+// IncrementalFormatsets the format for the number generated by [Incremental].
 // It will be formatted with Printf. This is mostly likely useful with a format like "%02d".
 func IncrementalFormat(format string) IncrementalOption {
 	return func(c *incConf) {

gen_rand.go

@@ -8,8 +8,8 @@ import (
 	"github.com/google/uuid"
 )
 
-// UUIDer is an interface for generating UUIDs.
-// It is recommended that you use either the UUIDv4 or UUIDv7 variables.
+// UUIDer is an interface for generating UUIDs, by the [UUID] [Generator].
+// It is recommended that you use either the [UUIDv4] or [UUIDv7] variables.
 type UUIDer interface {
 	UUID() (uuid.UUID, error)
 }
@@ -17,7 +17,7 @@ type UUIDer interface {
 // UUIDFunc is a function that generates a UUID.
 type UUIDFunc func() (uuid.UUID, error)
 
-// UUID allows UUIDFunc to be used as a UUIDer.
+// UUID allows [UUIDFunc] to be used as a [UUIDer].
 func (u UUIDFunc) UUID() (uuid.UUID, error) {
 	return u()
 }
@@ -33,7 +33,7 @@ var (
 	UUIDv7 = UUIDFunc(uuid.NewV7)
 )
 
-// UUID generates a UUID. If nil.is passed as an argument,
+// UUID generates a UUID. If nil is passed as an argument,
 // a UUIDv4 is generated.
 func UUID(u UUIDer) Generator {
 	if u == nil {
@@ -52,10 +52,10 @@ type randConf struct {
 	length int
 }
 
-// RandomOption is an option for the Random Generator.
+// RandomOption is an option for the [Random] [Generator].
 type RandomOption func(*randConf)
 
-// RandomLength controls the length of the string generated by Random.
+// RandomLength controls the length of the string generated by [Random].
 func RandomLength(length int) RandomOption {
 	return func(c *randConf) {
 		c.length = length
@@ -75,7 +75,7 @@ func fillBuffer(buff *strings.Builder, length int) {
 	}
 }
 
-// Random generates a random string containing the characters [A-Za-z0-9].
+// Random generates a random string containing the characters A-Za-z0-9.
 // By default, it will be eight characters long.
 func Random(opts ...RandomOption) Generator {
 	c := randConf{8}

gen_ts.go

@@ -2,10 +2,10 @@ package nomino
 
 import "time"
 
-// FileTimestamp is the default format for WithTimestamp and WithTime.
+// FileTimestamp is the default format for [Timestamp].
 const FileTimestamp string = "2006-01-02T15-04-05-0700"
 
-// FileTimestampNoTZ is the default format for WithTimestampUTC and WithTimeUTC.
+// FileTimestampNoTZ is the default format when using the [TimestampUTC] [TimestampOption].
 const FileTimestampNoTZ string = "2006-01-02T15-04-05"
 
 type timestampConf struct {
@@ -14,7 +14,7 @@ type timestampConf struct {
 	utc    bool
 }
 
-// TimestampOption provides options for the Timestamp Generator.
+// TimestampOption provides options for the [Timestamp] [Generator].
 type TimestampOption func(c *timestampConf)
 
 // Timestamp generates a a date and time. By default, it uses the current time, and will.
@@ -35,7 +35,7 @@ func Timestamp(opts ...TimestampOption) Generator {
 }
 
 // TimestampFormat sets the format for the generated name.
-// Consult time.Time.Format for details on the format.
+// Consult [time.Time.Format] for details on the format.
 func TimestampFormat(format string) TimestampOption {
 	return func(c *timestampConf) {
 		c.format = format
@@ -43,7 +43,7 @@ func TimestampFormat(format string) TimestampOption {
 }
 
 // TimestampTime sets the time for the generated name.
-// By default, it uses the current time.
+// By default, [Timestamp] uses the current time.
 func TimestampTime(t time.Time) TimestampOption {
 	return func(c *timestampConf) {
 		c.ts = t

generators.go

@@ -10,25 +10,25 @@ import (
 // for example.
 type Generator func(conf *Config) (string, error)
 
-// Make allows you to generate a new string directly from a Generator.
+// Make allows you to generate a new string directly from a [Generator].
 func (g Generator) Make(opts ...Option) (string, error) {
 	return g.MakeWithConfig(NewConfig(opts...))
 }
 
-// MakeWithConfig allows you to generate a new string directly from a Generator
+// MakeWithConfig allows you to generate a new string directly from a [Generator]
 // with a pre-existing Config.
 func (g Generator) MakeWithConfig(c Config) (string, error) {
 	return Make(c.AddOptions(WithGenerator(g)))
 }
 
-// WithGenerator sets the specified generator.
+// WithGenerator sets the specified [Generator].
 func WithGenerator(g Generator) Option {
 	return func(c *Config) {
 		c.generator = g
 	}
 }
 
-// ErrMissingGenerators is returned by a multi-generator if no generators are supplied.
+// ErrMissingGenerators is returned by a multi-generator if a [Generator] isn't supplied.
 var ErrMissingGenerators = errors.New("no generators supplied")
 
 func missingGen(*Config) (string, error) {
@@ -36,7 +36,7 @@ func missingGen(*Config) (string, error) {
 }
 
 // MultiGeneratorInOrder allows the use of multiple generators. Each new invokation will use the next generator in turn.
-// If none are passed, the generator will always return ErrMissingGenerators.
+// If none are passed, the generator will always return [ErrMissingGenerators].
 func MultiGeneratorInOrder(gens ...Generator) Generator {
 	if len(gens) == 0 {
 		return missingGen
@@ -55,7 +55,7 @@ func MultiGeneratorInOrder(gens ...Generator) Generator {
 }
 
 // MultiGeneratorRandomOrder allows the use of multiple generators. Each new invokation will use one of the generators randomly.
-// If none are passed, the generator will always return ErrMissingGenerators.
+// If none are passed, the generator will always return [ErrMissingGenerators].
 func MultiGeneratorRandomOrder(gens ...Generator) Generator {
 	if len(gens) == 0 {
 		return missingGen

nomino.go

@@ -0,0 +1,7 @@
+// Package nomino is a utility that allows us to generate random filenames.
+//
+// There are two main methods of using nomino.
+//
+//  1. Using the [Make] function.
+//  2. Creating a generator, and using its [Generator.Make] method.
+package nomino

options.go

@@ -6,7 +6,7 @@ import (
 	"github.com/gosimple/slug"
 )
 
-// Option sets configuration parameters for Config.
+// Option sets configuration parameters for [Config].
 type Option func(c *Config)
 
 // WithOriginal sets the original filename.
@@ -18,7 +18,7 @@ func WithOriginal(o string) Option {
 }
 
 // WithOriginal sets the original filename as a slug.
-// This should not be used with the Slug Generator (as it would be redundant).
+// This should not be used with the [Slug] [Generator] (as it would be redundant).
 func WithOriginalSlug(o string) Option {
 	return func(c *Config) {
 		c.original = slug.Make(o)
@@ -26,7 +26,7 @@ func WithOriginalSlug(o string) Option {
 }
 
 // WithOriginal sets the original filename as a slug, taking the language into account.
-// This should not be used with the Slug Generator (as it would be redundant).
+// This should not be used with the [Slug] [Generator] (as it would be redundant).
 func WithOriginalSlugLang(o, lang string) Option {
 	return func(c *Config) {
 		c.original = slug.MakeLang(o, lang)