dan/nomino
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

💡 Document code

Browse source
This commit is contained in:
Dan Jones 2025-03-10 13:46:13 -05:00
commit abe7acffd4
2 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
generators.go
View file

@ -20,26 +20,34 @@ func uuidGen() (string, error) {
return u.String(), nil return u.String(), nil
} }
// WithUUID sets a generator that creates a UUIDv4
func WithUUID() Option { func WithUUID() Option {
return func(c *config) { return func(c *config) {
setGenerator(c, uuidGen) setGenerator(c, uuidGen)
} }
} }
// FileTimestamp is the default format for WithTimestamp and WithTime
const FileTimestamp string = "2006-01-02_03-05-06-0700" const FileTimestamp string = "2006-01-02_03-05-06-0700"
// WithTimestamp sets a generator that creates a date and time for the current time.
// The format is FileStamp
func WithTimestamp() Option { func WithTimestamp() Option {
return WithTimestampFormat(FileTimestamp) return WithTimestampFormat(FileTimestamp)
} }
// WithTimestampFormat sets a generator the creates a date and time for the current time with the supplied format.
func WithTimestampFormat(f string) Option { func WithTimestampFormat(f string) Option {
return WithFormattedTime(time.Now(), f) return WithFormattedTime(time.Now(), f)
} }
// WithTime sets a generator that creates a date and time for the supplied time.
// The format is FileStamp
func WithTime(t time.Time) Option { func WithTime(t time.Time) Option {
return WithFormattedTime(t, FileTimestamp) return WithFormattedTime(t, FileTimestamp)
} }
// WithFormattedTime sets a generator that creates a date and time for the supplied time with the supplied format.
func WithFormattedTime(t time.Time, f string) Option { func WithFormattedTime(t time.Time, f string) Option {
return func(c *config) { return func(c *config) {
setGenerator(c, func() (string, error) { setGenerator(c, func() (string, error) {
@ -48,12 +56,15 @@ func WithFormattedTime(t time.Time, f string) Option {
} }
} }
// FileTimestamp is the default format for WithTimestampUTC and WithTimeUTC
const FileTimestampNoTZ string = "2006-01-02_03-05-06" const FileTimestampNoTZ string = "2006-01-02_03-05-06"
// WithTimestampUTC sets a generator the creates a date and time for the current time in UTC without a timezone in the format.
func WithTimestampUTC() Option { func WithTimestampUTC() Option {
return WithTimeUTC(time.Now()) return WithTimeUTC(time.Now())
} }
// WithTimeUTC sets a generate that creates a date and time for the supplied time in UTC without a timezone in the format.
func WithTimeUTC(t time.Time) Option { func WithTimeUTC(t time.Time) Option {
return WithFormattedTime(t.UTC(), FileTimestampNoTZ) return WithFormattedTime(t.UTC(), FileTimestampNoTZ)
} }

7
options.go
View file

@ -17,32 +17,39 @@ func defaultConf() config {
} }
} }
// Option is an option for nomino
type Option func(c *config) type Option func(c *config)
// WithOriginal sets the original filename.
// This will be included in the generated name after the generated string and before the suffix.
func WithOriginal(o string) Option { func WithOriginal(o string) Option {
return func(c *config) { return func(c *config) {
c.original = "_" + o c.original = "_" + o
} }
} }
// WithPrefix sets a prefix for the generated name.
func WithPrefix(p string) Option { func WithPrefix(p string) Option {
return func(c *config) { return func(c *config) {
c.prefix = p + "_" c.prefix = p + "_"
} }
} }
// WithSuffix sets a suffix for the generated name. It will be included in the base name before the suffix.
func WithSuffix(s string) Option { func WithSuffix(s string) Option {
return func(c *config) { return func(c *config) {
c.suffix = "_" + s c.suffix = "_" + s
} }
} }
// WithoutExtension sets no extension for the generated filename. By default, it will be txt
func WithoutExtension() Option { func WithoutExtension() Option {
return func(c *config) { return func(c *config) {
c.extension = "" c.extension = ""
} }
} }
// WithExtension sets the extension for the generated filename.
func WithExtension(ext string) Option { func WithExtension(ext string) Option {
return func(c *config) { return func(c *config) {
c.extension = "." + strings.TrimPrefix(ext, ".") c.extension = "." + strings.TrimPrefix(ext, ".")