updated files information

readme fixes and todos;
lowered go requirement to 1.18;

Author: amanofbits

README.md

@@ -1,47 +1,55 @@
 # Simser
-**Sim**ple **ser**ialization code generator for GO structs with unexported fields.  
+
+**Sim**ple **ser**ialization code generator for GO structs with unexported fields.
 
 Like `binary.Read`, but a bit different and without reflection.
 
 ## Features
 
 ### Core
+
 - go module mode only
 - simple sequential [de]serialization of simple structs
 - supports non-exported fields, as well as exported
 - basic (`int32`, `float64`, etc.), named (`type My uint64`, etc.) field types, and arrays of them (struct type fields,
-array of arrays and slice of arrays are not supported right now)
+  array of arrays and slice of arrays are not supported right now)
 - no reflection in generated code, it is simple and fast
 - possibility to select type[s] to serialize via `-types` CLI flag
 - customize output function names
 - customize output file name
 
 ### Advanced
+
 - slice field length can be set to any expression that returns `int`, by using tags. Currently [de]serialized instance can be referred to as "`o`", within expression.  
-E.g. `simser:"len=o.PreviousIntegerField-5"`.  
-Or `simser:"len=otherFunc()"`  
-Remember that only fields that get read _before_ the slice field will have meaningful values (unless some tricks were used)
+  E.g. `simser:"len=o.PreviousIntegerField-5"`.  
+  Or `simser:"len=otherFunc()"`  
+  Remember that only fields that get read _before_ the slice field will have meaningful values (unless some tricks were used)
 
 ## Usage
 
 #### Basic
 
-`//go:generate go run github.com/am4n0w4r/simser -types=Header,body`
-`//go:generate go run github.com/am4n0w4r/simser -types=all`
+`//go:generate go run github.com/amanofbits/simser -types=Header,body`
+`//go:generate go run github.com/amanofbits/simser -types=all`
 
 - `-types` (required): can be a comma-separated list of types you want to process, or reserved keyword `all` for processing all top-level `struct`s, found in file.  
-`all` usage and requiredness of the argument can change in the future.
+  `all` usage and requiredness of the argument can change in the future.
 - `-output` (optional): set output file name.
 
 #### Custom
 
-`//go:generate go run github.com/am4n0w4r/simser -types=Header -output=file.name -read-fn-name=customReadFnName -write-fn-name=CustomWriteFnName`
+`//go:generate go run github.com/amanofbits/simser -types=Header -output=file.name -read-fn-name=customReadFnName -write-fn-name=CustomWriteFnName`
 
 - `-read-fn-name` (optional): custom name for deserializing function. Is set per-file.
 - `-write-fn-name` (optional): custom name for deserializing function. Is set per-file.
 
-
 ## Project state
 
 A bit messy, not very optimal, but simple and working. It was developed quickly from scratch, to serve a particular practical purpose, so the code itself is rather not perfect, but generated code should be good and do the job.  
-It's the first time I worked with go's ast, so it was a lot of try-and-fail behind the scenes. Feel free to file issues.
+It's the first time I worked with go's ast, so it was a lot of try-and-fail behind the scenes. Feel free to file issues.
+
+### TODOs
+
+- add field skipping (skip, rskip, wskip tags)
+- add `_` fields support (don't assign them on read, just skip n bytes; write customizable padding byte instead)
+- add ability to select only r or w functions with flags like `-r[=customFnName]`, `-w[=customFnName]`

go.mod

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,12 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-module github.com/am4n0w4r/simser
+module github.com/amanofbits/simser
 
 // Before Go 1.21, the directive was advisory only; now it is a mandatory requirement
 // Source: https://go.dev/doc/modules/gomod-ref#go
-// So really no need to set this lower than 1.21
-go 1.21
+go 1.18
 
 require (
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d

internal/domain/domain.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/domain/functions.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/generator/fstringbuilder.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/generator/generator.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 package generator
 
 import (
-	"github.com/am4n0w4r/simser/internal/domain"
+	"github.com/amanofbits/simser/internal/domain"
 )
 
 func GenStructCode(s domain.InputStruct, out *Output, readFnName, writeFnName string) error {

internal/generator/output.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

internal/generator/sizegroups.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 package generator
 
 import (
-	"github.com/am4n0w4r/simser/internal/domain"
+	"github.com/amanofbits/simser/internal/domain"
 )
 
 // Returns a description of size groups as '[index]size', where:

internal/generator/templates.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/am4n0w4r/simser/internal/domain"
+	"github.com/amanofbits/simser/internal/domain"
 )
 
 // read toRead bytes

internal/parser/input.go

@@ -1,4 +1,4 @@
-// Copyright 2023 am4n0w4r
+// Copyright 2023 amanofbits
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ import (
 	"path/filepath"
 	"slices"
 
-	"github.com/am4n0w4r/simser/internal/domain"
+	"github.com/amanofbits/simser/internal/domain"
 	"golang.org/x/mod/modfile"
 	"golang.org/x/tools/go/packages"
 )