add sqlint support for string type enums (#135)

.github/workflows/build_and_test.yml

@@ -24,12 +24,12 @@ jobs:
     name: run tests with go version ${{ matrix.go }}
     steps:
       - name: install go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go }}
 
       - name: checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Build
         run: make build
@@ -43,11 +43,10 @@ jobs:
             make coveralls
           fi
       - name: Upload coverage
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: coverage
           path: coverage.*
 
       - name: Assert no changes
-        if: ${{ matrix.go }} > '1.16'
         run: make assert-no-changes

.github/workflows/release.yml

@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: 1.19
 
@@ -28,14 +28,14 @@ jobs:
             ${{ runner.os }}-go-
 
       - name: Install GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v3
         with:
           install-only: true
       - name: Show GoReleaser version
         run: goreleaser -v
 
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v3
         if: success() && startsWith(github.ref, 'refs/tags/')
         with:
           # either 'goreleaser' (default) or 'goreleaser-pro'

Makefile

@@ -101,7 +101,7 @@ bin/goveralls: go.sum
 snapshots: snapshots_1.17
 snapshots: snapshots_1.18
 
-snapshots_%:
+snapshots_%: clean
 	echo "##### updating snapshots for golang $* #####"
 	docker run -i -t -w /app -v $(shell pwd):/app --entrypoint /bin/sh golang:$* -c './update-snapshots.sh || true'
 

README.md

@@ -50,6 +50,37 @@ func (x *ImageType) UnmarshalText(text []byte) error
 
 If you find that the options given are not adequate for your use case, there is an option to add a custom template (`-t` flag) to the processing engine so that your custom code can be created!
 
+## Now with string typed enums
+
+```go
+// ENUM(pending, running, completed, failed)
+type StrState string
+```
+
+```go
+const (
+ // StrStatePending is a StrState of type pending.
+ StrStatePending StrState = "pending"
+ // StrStateRunning is a StrState of type running.
+ StrStateRunning StrState = "running"
+ // StrStateCompleted is a StrState of type completed.
+ StrStateCompleted StrState = "completed"
+ // StrStateFailed is a StrState of type failed.
+ StrStateFailed StrState = "failed"
+)
+```
+
+If you would like to get integer values in sql, but strings elsewhere, you can assign an int value in the declaration
+like always, and specify the `--sqlint` flag.  Those values will be then used to convey the int value to sql, while allowing you to use only strings elsewhere.
+This might be helpful for things like swagger docs where you want the same type being used on the api layer, as you do in the
+sql layer, and not have swagger assume that your enumerations are integers, but are in fact strings!
+
+```go
+// swagger:enum StrState
+// ENUM(pending, running, completed, failed)
+type StrState string
+```
+
 ## Goal
 
 The goal of go-enum is to create an easy to use enum generator that will take a decorated type declaration like `type EnumName int` and create the associated constant values and funcs that will make life a little easier for adding new values.