go mnd

Go -Mnd - детектор магического числа для Golang

Ветеринарный анализатор для обнаружения магических чисел.

Что такое волшебное число?
Волшебное число - это числовое буквальное, которое не определяется как постоянная, но может измениться, и, следовательно, может быть трудно обновить. Это считается плохой практикой программирования для использования чисел непосредственно в любом исходном коде без объяснения объяснения. Это затрудняет чтение, понимание и поддержание программ.

Статус проекта

Установить

Местный

Этот анализатор требует Голанга в версии> = 1.12, потому что он зависит от API GO/Analysis .

 go get -u github.com/tommy-muehle/go-mnd/v2/cmd/mnd

Действие GitHub

Вы можете запустить Go-Mnd как действие GitHub следующим образом:

 name: Example workflow
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
jobs:
  tests:
    runs-on: ubuntu-latest
    env:
      GO111MODULE: on
    steps:
      - name: Checkout Source
        uses: actions/checkout@v2
      - name: Run go-mnd
        uses: tommy-muehle/go-mnd@master
        with:
          args: ./...

Гитлаб CI

Вы можете запустить Go-Mnd в трубопровод Gitlab CI следующим образом:

 stages:
  - lint

go:lint:mnd:
  stage: lint
  needs: []
  image: golang:latest
  before_script:
    - go get -u github.com/tommy-muehle/go-mnd/v2/cmd/mnd
    - go mod tidy
    - go mod vendor
  script:
    - go vet -vettool $(which mnd) ./...

Домашний

Чтобы установить с Homebrew, запустите:

 brew tap tommy-muehle/tap && brew install tommy-muehle/tap/mnd

Докер

Чтобы получить последнее доступное изображение Docker:

 docker pull tommymuehle/go-mnd

Окна

В Windows скачать последний релиз.

Использование

 go vet -vettool $(which mnd) ./...

или напрямую

 mnd ./...

или через Docker

 docker run --rm -v "$PWD":/app -w /app tommymuehle/go-mnd:latest ./...

Параметры

Опция -checks позволяет определить разделенный запятой список чеков.

Опция -ignored-numbers позволяет вам определить разделенную запятую список чисел для игнорирования.
Например: -ignored-numbers=1000,10_000,3.14159264

Опция -ignored-functions позволяет вам определить отдельный список шаблонов regexp имени функции, чтобы исключить.
Например: -ignored-functions=math.*,http.StatusText,make

Опция -ignored-files позволяет исключить отдельный список паттернов режима имени файла.
Например: -ignored-files=magic_.*.go,.*_numbers.go

Чеки

По умолчанию в этом детекторе анализируются аргументы, назначения, случаи, условия, операции и обратные операторы.

• аргумент

 t := http.StatusText(200)

• назначать

 c := &http.Client{
    Timeout: 5 * time.Second,
}

• случай

 switch x {
    case 3:
}

• состояние

 if x > 7 {
}

• операция

 var x, y int
y = 10 * x

• возвращаться

 return 3

Исключает

По умолчанию числа 0 и 1, а также тестовые файлы исключены!

Далее известно исключает

Функция «дата» в пакете «Время».

 t := time.Date(2017, time.September, 26, 12, 13, 14, 0, time.UTC)

Дополнительные пользовательские исключения могут быть определены через флаг опции.

Разработка

Строить

Вы можете построить бинар с:

 make

Тесты

Вы можете запустить все модульные тесты, используя:

 make test

И с отчетом о покрытии:

 make test-coverage

Docker Image

Вы также можете создать изображение Docker, используя команду:

 make image

Наклейки

Просто оставьте мне сообщение через Twitter DM или по электронной почте, если вы хотите, чтобы несколько наклеек для вас или для вашей пользовательской группы Gopher.

Лицензия

Лицензия MIT (MIT). Пожалуйста, смотрите лицензию для получения дополнительной информации.