Giter VIP home page Giter VIP logo

notany's Introduction

notany

Go Reference test codecov

Linter notany limits possible types for arguments of any type.

// arg must be string, fmt.Stringer, or AllowedType.
func FuncWithAnyTypeArg(arg any) {
  // ...
}

type AllowedType struct{}
func main() {
  pkg.FuncWithAnyTypeArg("ok")          // ok
  pkg.FuncWithAnyTypeArg(time.Now())    // ok because time.Time implements fmt.Stringer
  pkg.FuncWithAnyTypeArg(AllowedType{}) // ok
  pkg.FuncWithAnyTypeArg(1.0)           // <- float64 is not allowed
  pkg.FuncWithAnyTypeArg(true)          // <- bool is not allowed
}

How to use

Build your notany binary by writing main.go like below.

package main

import (
  "github.com/qawatake/notany"
  "golang.org/x/tools/go/analysis/unitchecker"
)

func main() {
  unitchecker.Main(
    notany.NewAnalyzer(
      notany.Target{
        PkgPath:  "pkg/in/which/target/func/is/defined",
        FuncName: "FuncWithAnyTypeArg",
        ArgPos:   1,
        Allowed: []notany.Allowed{
          {
            PkgPath:  "",
            TypeName: "int",
          },
          {
            PkgPath:  "fmt",
            TypeName: "Stringer",
          },
          {
            PkgPath:  "pkg/in/which/allowed/type/is/defined",
            TypeName: "AllowedType",
          },
        },
      },
    ),
  )
}

Then, run go vet with your notany binary.

go vet -vettool=/path/to/your/notany ./...

notany's People

Contributors

qawatake avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.