Add Linter (#71)

* Add golangci-lint

* Run on all branches?

* And on pull request to master

* Install clang and llvm

* Try to symlink libclang

* set c compiler

* Tidy up go.mod

* Golang 1.22

* Try now?

* Do we care?

* clang 18

* 18.1.8

* Add golangci-lint config

* Run golangci-lint --fix

* Run fix again

* Fix some errors

* Fix more

* Fix failing tests

* Some more repairs to runtime

* Clean up more

* More cleanup

* More linting

* More cleanup

* More error fixes

* Make CI Work

.github/workflows/go.yml

@@ -1,7 +1,4 @@
-# This workflow will build a golang project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
-
-name: Go
+name: Run Tests
 
 on:
   push:
@@ -19,7 +16,14 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.20'
+        go-version: '1.23'
+
+    - name: Install LLVM
+      run: |
+        echo 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-18 main' | sudo tee /etc/apt/sources.list.d/llvm.list
+        wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends llvm-18-dev
 
     - name: Build
       run: go build -v ./...

.github/workflows/golangci-lint.yml

@@ -0,0 +1,31 @@
+name: Lint
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.23'
+
+    - name: Install LLVM
+      run: |
+        echo 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-18 main' | sudo tee /etc/apt/sources.list.d/llvm.list
+        wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+        sudo apt-get update
+        sudo apt-get install --no-install-recommends llvm-18-dev
+
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: latest

.gitignore

@@ -0,0 +1 @@
+vendor

.golangci.yml

@@ -0,0 +1,207 @@
+run:
+  timeout: 3m
+
+include:
+  - ast
+  - lexer
+  - parser
+  - runtime
+  - object
+  - compiler
+
+linters-settings:
+  cyclop:
+    max-complexity: 30
+    package-average: 10.0
+
+  errcheck:
+    check-type-assertions: true
+
+  exhaustive:
+    check:
+      - switch
+      - map
+
+  exhaustruct:
+    exclude:
+      # std libs
+      - "^os/exec.Cmd$"
+      # 3rd party
+      - "^github.com/spf13/cobra.Command$"
+      - "^github.com/llir/llvm/ir.*$"
+
+  funlen:
+    lines: 100
+    statements: 50
+    ignore-comments: true
+
+  gocognit:
+    min-complexity: 20
+
+  gocritic:
+    settings:
+      captLocal:
+        paramsOnly: false
+      underef:
+        skipRecvDeref: false
+
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment # too strict
+    settings:
+      shadow:
+        strict: true
+
+  inamedparam:
+    skip-single-param: true
+
+  mnd:
+    ignored-functions:
+      - args.Error
+      - flag.Arg
+      - flag.Duration.*
+      - flag.Float.*
+      - flag.Int.*
+      - flag.Uint.*
+      - os.Chmod
+      - os.Mkdir.*
+      - os.OpenFile
+      - os.WriteFile
+      - prometheus.ExponentialBuckets.*
+      - prometheus.LinearBuckets
+
+  nakedret:
+    max-func-lines: 0
+
+  nolintlint:
+    allow-no-explanation: [ funlen, gocognit, lll ]
+    require-explanation: true
+    require-specific: true
+
+  perfsprint:
+    strconcat: false
+
+  sloglint:
+    # Enforce not using global loggers.
+    # Values:
+    # - "": disabled
+    # - "all": report all global loggers
+    # - "default": report only the default slog logger
+    # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global
+    # Default: ""
+    no-global: "all"
+    # Enforce using methods that accept a context.
+    # Values:
+    # - "": disabled
+    # - "all": report all contextless calls
+    # - "scope": report only if a context exists in the scope of the outermost function
+    # https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only
+    # Default: ""
+    context: "scope"
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    # Default: false
+    all: true
+
+linters:
+  disable-all: true
+  enable:
+    ## enabled by default
+    - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
+    - gosimple # specializes in simplifying a code
+    - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+    - ineffassign # detects when assignments to existing variables are not used
+    - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
+    - typecheck # like the front-end of a Go compiler, parses and type-checks Go code
+    - unused # checks for unused constants, variables, functions and types
+    ## disabled by default
+    - asasalint # checks for pass []any as any in variadic func(...any)
+    - asciicheck # checks that your code does not contain non-ASCII identifiers
+    - bidichk # checks for dangerous unicode character sequences
+    - bodyclose # checks whether HTTP response body is closed successfully
+    - canonicalheader # checks whether net/http.Header uses canonical header
+    - copyloopvar # detects places where loop variables are copied (Go 1.22+)
+    - cyclop # checks function and package cyclomatic complexity
+    - dupl # tool for code clone detection
+    - durationcheck # checks for two durations multiplied together
+    - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
+    - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
+    - exhaustive # checks exhaustiveness of enum switch statements
+    - fatcontext # detects nested contexts in loops
+    - forbidigo # forbids identifiers
+    - funlen # tool for detection of long functions
+    - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
+    - gochecknoglobals # checks that no global variables exist // TODO: enable after fixing issues
+    - gochecknoinits # checks that no init functions are present in Go code
+    - gochecksumtype # checks exhaustiveness on Go "sum types"
+    - gocognit # computes and checks the cognitive complexity of functions
+    - goconst # finds repeated strings that could be replaced by a constant
+    - gocritic # provides diagnostics that check for bugs, performance and style issues
+    - gocyclo # computes and checks the cyclomatic complexity of functions
+    - godot # checks if comments end in a period
+    - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
+    - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
+    - goprintffuncname # checks that printf-like functions are named with f at the end
+    - gosec # inspects source code for security problems
+    - lll # reports long lines
+    - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
+    - makezero # finds slice declarations with non-zero initial length
+    - mirror # reports wrong mirror patterns of bytes/strings usage
+    - mnd # detects magic numbers
+    - musttag # enforces field tags in (un)marshaled structs
+    - nakedret # finds naked returns in functions greater than a specified function length
+    - nestif # reports deeply nested if statements
+    - nilerr # finds the code that returns nil even if it checks that the error is not nil
+    - nilnil # checks that there is no simultaneous return of nil error and an invalid value
+    - noctx # finds sending http request without context.Context
+    - nolintlint # reports ill-formed or insufficient nolint directives
+    - nonamedreturns # reports all named returns
+    - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
+    - perfsprint # checks that fmt.Sprintf can be replaced with a faster alternative
+    - predeclared # finds code that shadows one of Go's predeclared identifiers
+    - promlinter # checks Prometheus metrics naming via promlint
+    - protogetter # reports direct reads from proto message fields when getters should be used
+    - reassign # checks that package variables are not reassigned
+    - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
+    - sloglint # ensure consistent code style when using log/slog
+    - spancheck # checks for mistakes with OpenTelemetry/Census spans
+    - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
+    - stylecheck # is a replacement for golint
+    - tenv # detects using os.Setenv instead of t.Setenv since Go1.17
+    - testableexamples # checks if examples are testable (have an expected output)
+    - testifylint # checks usage of github.com/stretchr/testify
+    - testpackage # makes you use a separate _test package
+    - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
+    - unconvert # removes unnecessary type conversions
+    - unparam # reports unused function parameters
+    - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
+    - wastedassign # finds wasted assignment statements
+    - whitespace # detects leading and trailing whitespace
+    - godox # detects FIXME, TODO and other comment keywords
+    - exhaustruct # checks if all structure fields are initialized
+    - interfacebloat # checks the number of methods inside an interface
+    - prealloc # [premature optimization, but can be used in some cases] finds slice declarations that could potentially be preallocated
+    - wrapcheck # checks that errors returned from external packages are wrapped
+    - tagalign # checks that struct tags are well aligned
+    - decorder # checks declaration order and count of types, constants, variables and functions
+
+issues:
+  max-same-issues: 50
+
+  exclude-rules:
+    - source: "(noinspection|TODO)"
+      linters: [ godot ]
+    - source: "//noinspection"
+      linters: [ gocritic ]
+    - path: "_test\\.go"
+      linters:
+        - bodyclose
+        - dupl
+        - funlen
+        - goconst
+        - gosec
+        - noctx
+        - wrapcheck

ast/ast.go

@@ -5,7 +5,7 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/0xM-D/interpreter/token"
+	"github.com/DustTheory/interpreter/token"
 )
 
 func (p *Program) TokenLiteral() string {
@@ -15,9 +15,9 @@ func (p *Program) TokenLiteral() string {
 func (p *Program) TokenValue() token.Token {
 	if len(p.Statements) > 0 {
 		return p.Statements[0].TokenValue()
-	} else {
-		return token.Token{Type: token.EOF, Literal: "", Linen: 0, Coln: 0}
 	}
+
+	return token.Token{Type: token.EOF, Literal: "", Linen: 0, Coln: 0}
 }
 
 func (p *Program) String() string {
@@ -135,7 +135,7 @@ func (b *BooleanLiteral) TokenLiteral() string    { return b.Token.Literal }
 func (b *BooleanLiteral) TokenValue() token.Token { return b.Token }
 func (b *BooleanLiteral) String() string          { return b.Token.Literal }
 
-func (ie *IfStatement) statementNode()         {}
+func (ie *IfStatement) statementNode()          {}
 func (ie *IfStatement) TokenLiteral() string    { return ie.Token.Literal }
 func (ie *IfStatement) TokenValue() token.Token { return ie.Token }
 func (ie *IfStatement) String() string {
@@ -152,7 +152,6 @@ func (ie *IfStatement) String() string {
 	}
 
 	return out.String()
-
 }
 
 func (bs *BlockStatement) statementNode()          {}

ast/ast_test.go

@@ -1,25 +1,28 @@
-package ast
+package ast_test
 
 import (
 	"testing"
 
-	"github.com/0xM-D/interpreter/token"
+	"github.com/DustTheory/interpreter/ast"
+	"github.com/DustTheory/interpreter/token"
 )
 
 func TestString(t *testing.T) {
-	program := &Program{
-		Statements: []Statement{
-			&LetStatement{
-				DeclarationStatement{
-					Token: token.Token{Type: token.LET, Literal: "let"},
-					Name: &Identifier{
-						Token: token.Token{Type: token.IDENT, Literal: "myVar"},
+	program := &ast.Program{
+		Statements: []ast.Statement{
+			&ast.LetStatement{
+				ast.DeclarationStatement{
+					Token: token.Token{Type: token.Let, Literal: "let", Linen: 0, Coln: 0},
+					Name: &ast.Identifier{
+						Token: token.Token{Type: token.Ident, Literal: "myVar", Linen: 0, Coln: 0},
 						Value: "myVar",
 					},
-					Value: &Identifier{
-						Token: token.Token{Type: token.IDENT, Literal: "anotherVar"},
+					Value: &ast.Identifier{
+						Token: token.Token{Type: token.Ident, Literal: "anotherVar", Linen: 0, Coln: 0},
 						Value: "anotherVar",
 					},
+					IsConstant: false,
+					Type:       nil,
 				},
 			},
 		},
@@ -28,5 +31,4 @@ func TestString(t *testing.T) {
 	if program.String() != "let myVar = anotherVar;" {
 		t.Errorf("program.String wrong. got=%q", program.String())
 	}
-
 }

ast/types.go

@@ -3,7 +3,7 @@ package ast
 import (
 	"math/big"
 
-	"github.com/0xM-D/interpreter/token"
+	"github.com/DustTheory/interpreter/token"
 )
 
 type Node interface {
@@ -45,7 +45,7 @@ type LetStatement struct {
 
 type ReturnStatement struct {
 	Token       token.Token
-	ReturnValue Expression
+	ReturnValue Expression `exhaustruct:"optional"`
 }
 
 type ExpressionStatement struct {