build: use make for building the project (filebrowser#1304)

.circleci/config.yml

@@ -1,55 +1,39 @@
-version: 2
+version: 2.1
+references:
+ base_container: &base_container
+ docker:
+ - image: filebrowser/builder:v1.1.0
 jobs:
  lint:
- docker:
- - image: golangci/golangci-lint:v1.31.0
+ <<: *base_container
  steps:
  - checkout
- - run: golangci-lint run -v
- build-node:
- docker:
- - image: circleci/node
- steps:
- - checkout
- - run:
- name: "Build"
- command: ./wizard.sh -a
- - run:
- name: "Cleanup"
- command: rm -rf frontend/node_modules
- - persist_to_workspace:
- root: .
- paths:
- - '*'
+ - run: make lint
  test:
- docker:
- - image: circleci/golang:1.15.2
+ <<: *base_container
  steps:
  - checkout
  - run:
  name: "Test"
- command: go test ./...
- build-go:
- docker:
- - image: circleci/golang:1.15.2
+ command: make test
+ build:
+ <<: *base_container
  steps:
- - attach_workspace:
- at: '~/project'
+ - checkout
  - run:
- name: "Compile"
- command: GOOS=linux GOARCH=amd64 ./wizard.sh -c
+ name: "Build"
+ command: make build
  - run:
  name: "Cleanup"
  command: |
- rm -rf frontend/build
- git checkout -- go.sum # TODO: why is it being changed?
+ rm -rf frontend/node_modules
+ rm -rf bin/
  - persist_to_workspace:
  root: .
  paths:
  - '*'
  release:
- docker:
- - image: circleci/golang:1.15.2
+ <<: *base_container
  steps:
  - attach_workspace:
  at: '~/project'
@@ -69,22 +53,16 @@ workflows:
  filters:
  tags:
  only: /.*/
- - build-node:
- filters:
- tags:
- only: /.*/
- - build-go:
+ - build:
  filters:
  tags:
  only: /.*/
- requires:
- - build-node
- - lint
- - test
  - release:
  context: deploy
  requires:
- - build-go
+ - build
+ - test
+ - lint
  filters:
  tags:
  only: /^v.*/

.gitignore

@@ -28,3 +28,5 @@ yarn-error.log*
 *.njsproj
 *.sln
 *.sw*
+bin/
+build/

.golangci.yml

@@ -63,7 +63,6 @@ linters:
  - goconst
  - gocritic
  - gocyclo
- - gofmt
  - goimports
  - golint
  - gomnd

.versionrc

@@ -0,0 +1,14 @@
+{
+ "types": [
+ { "type": "feat", "section": "Features" },
+ { "type": "fix", "section": "Bug Fixes" },
+ { "type": "perf", "section": "Performance improvements" },
+ { "type": "revert", "section": "Reverts" },
+ { "type": "refactor", "section": "Refactorings" },
+ { "type": "build", "section": "Build" },
+ { "type": "ci", "hidden": true },
+ { "type": "test", "hidden": true },
+ { "type": "chore", "hidden": true },
+ { "type": "docs", "hidden": true }
+ ]
+}

Makefile

@@ -0,0 +1,98 @@
+SHELL := /bin/bash
+BASE_PATH := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+VERSION ?= $(shell git describe --tags --always --match=v* 2> /dev/null || \
+ cat $(CURDIR)/.version 2> /dev/null || echo v0)
+VERSION_HASH = $(shell git rev-parse HEAD)
+
+BIN = $(BASE_PATH)/bin
+PATH := $(BIN):$(PATH)
+export PATH
+
+# printing
+V = 0
+Q = $(if $(filter 1,$V),,@)
+M = $(shell printf "\033[34;1m▶\033[0m")
+
+GO = GOGC=off go
+# go module
+MODULE = $(shell env GO111MODULE=on $(GO) list -m)
+
+DATE ?= $(shell date +%FT%T%z)
+VERSION ?= $(shell git describe --tags --always --match=v* 2> /dev/null || \
+ cat $(CURDIR)/.version 2> /dev/null || echo v0)
+VERSION_HASH = $(shell git rev-parse HEAD)
+BRANCH = $(shell git rev-parse --abbrev-ref HEAD)
+
+LDFLAGS += -X "$(MODULE)/varsion.Version=$(VERSION)" -X "$(MODULE)/varsion.CommitSHA=$(VERSION_HASH)"
+
+# tools
+$(BIN):
+ @mkdir -p $@
+$(BIN)/%: | $(BIN) ; $(info $(M) installing $(PACKAGE)…)
+ $Q env GOBIN=$(BIN) $(GO) install $(PACKAGE)
+
+GOLANGCI_LINT = $(BIN)/golangci-lint
+$(BIN)/golangci-lint: PACKAGE=github.com/golangci/golangci-lint/cmd/[email protected]
+
+GOIMPORTS = $(BIN)/goimports
+$(BIN)/goimports: PACKAGE=golang.org/x/tools/cmd/[email protected]
+
+RICE = $(BIN)/rice
+$(BIN)/rice: PACKAGE=github.com/GeertJohan/go.rice/[email protected]
+
+## build: Build
+.PHONY: build
+build: | build-frontend build-backend ; $(info $(M) building…)
+
+## build-frontend: Build frontend
+.PHONY: build-frontend
+build-frontend: | ; $(info $(M) building frontend…)
+ $Q cd frontend && npm ci && npm run build
+
+## build-backend: Build backend
+.PHONY: build-backend
+build-backend: | $(RICE) ; $(info $(M) building backend…)
+ $Q cd ./http && rm -rf rice-box.go && $(RICE) embed-go
+ $Q $(GO) build -ldflags '$(LDFLAGS)' -o filebrowser
+
+## test: Run all tests
+.PHONY: test
+test: | test-frontend test-backend ; $(info $(M) running tests…)
+
+## test-frontend: Run frontend tests
+.PHONY: test-frontend
+test-frontend: | ; $(info $(M) running frontend tests…)
+
+## test-backend: Run backend tests
+.PHONY: test-backend
+test-backend: | $(RICE) ; $(info $(M) running backend tests…)
+ $Q $(GO) test -v ./...
+
+## lint: Lint
+.PHONY: lint
+lint: lint-frontend lint-backend lint-commits | ; $(info $(M) running all linters…)
+
+## lint-frontend: Lint frontend
+.PHONY: lint-frontend
+lint-frontend: | ; $(info $(M) running frontend linters…)
+ $Q cd frontend && npm ci && npm run lint
+
+## lint-backend: Lint backend
+.PHONY: lint-backend
+lint-backend: | $(GOLANGCI_LINT) ; $(info $(M) running backend linters…)
+ $Q $(GOLANGCI_LINT) run
+
+## lint-commits: Lint commits
+.PHONY: lint-commits
+lint-commits: | ; $(info $(M) running commitlint…)
+ $Q ./scripts/commitlint.sh
+
+## bump-version: Bump app version
+.PHONY: bump-version
+bump-version: | ; $(info $(M) creating a new release…)
+ $Q ./scripts/bump_version.sh
+
+## help: Show this help
+.PHONY: help
+help:
+ @sed -n 's/^## //p' $(MAKEFILE_LIST) | column -t -s ':' | sed -e 's/^/ /' | sort

auth/json.go

@@ -40,7 +40,7 @@ func (a JSONAuth) Auth(r *http.Request, sto users.Store, root string) (*users.Us
 
  // If ReCaptcha is enabled, check the code.
  if a.ReCaptcha != nil && len(a.ReCaptcha.Secret) > 0 {
- ok, err := a.ReCaptcha.Ok(cred.ReCaptcha) //nolint:shadow
+ ok, err := a.ReCaptcha.Ok(cred.ReCaptcha) //nolint:govet
 
  if err != nil {
  return nil, err

cmd/cmds_add.go

@@ -14,7 +14,7 @@ var cmdsAddCmd = &cobra.Command{
  Use: "add <event> <command>",
  Short: "Add a command to run on a specific event",
  Long: `Add a command to run on a specific event.`,
- Args: cobra.MinimumNArgs(2), //nolint:mnd
+ Args: cobra.MinimumNArgs(2), //nolint:gomnd
  Run: python(func(cmd *cobra.Command, args []string, d pythonData) {
  s, err := d.store.Settings.Get()
  checkErr(err)

cmd/cmds_rm.go

@@ -23,7 +23,7 @@ You can also specify an optional parameter (index_end) so
 you can remove all commands from 'index' to 'index_end',
 including 'index_end'.`,
  Args: func(cmd *cobra.Command, args []string) error {
- if err := cobra.RangeArgs(2, 3)(cmd, args); err != nil { //nolint:mnd
+ if err := cobra.RangeArgs(2, 3)(cmd, args); err != nil { //nolint:gomnd
  return err
  }
 
@@ -43,7 +43,7 @@ including 'index_end'.`,
  i, err := strconv.Atoi(args[1])
  checkErr(err)
  f := i
- if len(args) == 3 { //nolint:mnd
+ if len(args) == 3 { //nolint:gomnd
  f, err = strconv.Atoi(args[2])
  checkErr(err)
  }

cmd/root.go

@@ -152,12 +152,15 @@ user created with the credentials from options "username" and "password".`,
  err = os.Chmod(server.Socket, os.FileMode(socketPerm))
  checkErr(err)
  case server.TLSKey != "" && server.TLSCert != "":
- cer, err := tls.LoadX509KeyPair(server.TLSCert, server.TLSKey) //nolint:shadow
+ cer, err := tls.LoadX509KeyPair(server.TLSCert, server.TLSKey) //nolint:govet
  checkErr(err)
- listener, err = tls.Listen("tcp", adr, &tls.Config{Certificates: []tls.Certificate{cer}}) //nolint:shadow
+ listener, err = tls.Listen("tcp", adr, &tls.Config{
+ MinVersion: tls.VersionTLS12,
+ Certificates: []tls.Certificate{cer}},
+ )
  checkErr(err)
  default:
- listener, err = net.Listen("tcp", adr) //nolint:shadow
+ listener, err = net.Listen("tcp", adr)
  checkErr(err)
  }
 

cmd/rule_rm.go

@@ -44,7 +44,7 @@ including 'index_end'.`,
  i, err := strconv.Atoi(args[0])
  checkErr(err)
  f := i
- if len(args) == 2 { //nolint:mnd
+ if len(args) == 2 { //nolint:gomnd
  f, err = strconv.Atoi(args[1])
  checkErr(err)
  }

cmd/users_add.go

@@ -15,7 +15,7 @@ var usersAddCmd = &cobra.Command{
  Use: "add <username> <password>",
  Short: "Create a new user",
  Long: `Create a new user and add it to the database.`,
- Args: cobra.ExactArgs(2), //nolint:mnd
+ Args: cobra.ExactArgs(2), //nolint:gomnd
  Run: python(func(cmd *cobra.Command, args []string, d pythonData) {
  s, err := d.store.Settings.Get()
  checkErr(err)

cmd/users_import.go

@@ -67,7 +67,7 @@ list or set it to 0.`,
  // with the new username. If there is, print an error and cancel the
  // operation
  if user.Username != onDB.Username {
- if conflictuous, err := d.store.Users.Get("", user.Username); err == nil { //nolint:shadow
+ if conflictuous, err := d.store.Users.Get("", user.Username); err == nil { //nolint:govet
  checkErr(usernameConflictError(user.Username, conflictuous.ID, user.ID))
  }
  }

cmd/utils.go

@@ -72,7 +72,7 @@ func dbExists(path string) (bool, error) {
  d := filepath.Dir(path)
  _, err = os.Stat(d)
  if os.IsNotExist(err) {
- if err := os.MkdirAll(d, 0700); err != nil { //nolint:shadow
+ if err := os.MkdirAll(d, 0700); err != nil { //nolint:govet
  return false, err
  }
  return false, nil

commitlint.config.js

@@ -0,0 +1,34 @@
+module.exports = {
+ rules: {
+ 'body-leading-blank': [1, 'always'],
+ 'body-max-line-length': [2, 'always', 100],
+ 'footer-leading-blank': [1, 'always'],
+ 'footer-max-line-length': [2, 'always', 100],
+ 'header-max-length': [2, 'always', 100],
+ 'scope-case': [2, 'always', 'lower-case'],
+ 'subject-case': [
+ 2,
+ 'never',
+ ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+ ],
+ 'subject-full-stop': [2, 'never', '.'],
+ 'type-case': [2, 'always', 'lower-case'],
+ 'type-empty': [2, 'never'],
+ 'type-enum': [
+ 2,
+ 'always',
+ [
+ 'feat',
+ 'fix',
+ 'perf',
+ 'revert',
+ 'refactor',
+ 'build',
+ 'ci',
+ 'test',
+ 'chore',
+ 'docs',
+ ],
+ ],
+ },
+};

files/file.go

@@ -79,7 +79,7 @@ func NewFileInfo(opts FileOptions) (*FileInfo, error) {
 
  if opts.Expand {
  if file.IsDir {
- if err := file.readListing(opts.Checker, opts.ReadHeader); err != nil { //nolint:shadow
+ if err := file.readListing(opts.Checker, opts.ReadHeader); err != nil { //nolint:govet
  return nil, err
  }
  return file, nil