Fix: Enhance the code style (#732)

Signed-off-by: barnettZQG <[email protected]>

.golangci.yml

@@ -0,0 +1,226 @@
+run:
+  timeout: 10m
+
+  skip-files:
+    - "zz_generated\\..+\\.go$"
+    - ".*_test.go$"
+
+  skip-dirs:
+    - "hack"
+    - "e2e"
+
+output:
+  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
+  format: colored-line-number
+
+linters-settings:
+  errcheck:
+    # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
+    # default is false: such cases aren't reported by default.
+    check-type-assertions: false
+
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
+    # default is false: such cases aren't reported by default.
+    check-blank: false
+
+    # [deprecated] comma-separated list of pairs of the form pkg:regex
+    # the regex is used to ignore names within pkg. (default "fmt:.*").
+    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
+    ignore: fmt:.*,io/ioutil:^Read.*
+
+  exhaustive:
+    # indicates that switch statements are to be considered exhaustive if a
+    # 'default' case is present, even if all enum members aren't listed in the
+    # switch
+    default-signifies-exhaustive: true
+
+  govet:
+    # report about shadowed variables
+    check-shadowing: false
+
+  revive:
+    # minimal confidence for issues, default is 0.8
+    min-confidence: 0.8
+
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+
+  goimports:
+    # put imports beginning with prefix after 3rd-party packages;
+    # it's a comma-separated list of prefixes
+    local-prefixes: github.com/kubevela/velaux
+
+  gocyclo:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 30
+
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+
+  dupl:
+    # tokens count to trigger issue, 150 by default
+    threshold: 100
+
+  goconst:
+    # minimal length of string constant, 3 by default
+    min-len: 3
+    # minimal occurrences count to trigger, 3 by default
+    min-occurrences: 5
+
+  lll:
+    # tab width in spaces. Default to 1.
+    tab-width: 1
+
+  unused:
+    # treat code as a program (not a library) and report unused exported identifiers; default is false.
+    # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+
+  unparam:
+    # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
+    # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+
+  nakedret:
+    # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
+    max-func-lines: 30
+
+  gocritic:
+    # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks.
+    # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
+    enabled-tags:
+      - performance
+
+    settings: # settings passed to gocritic
+      captLocal: # must be valid enabled check name
+        paramsOnly: true
+      rangeValCopy:
+        sizeThreshold: 32
+
+  makezero:
+    # Allow only slices initialized with a length of zero. Default is false.
+    always: false
+
+linters:
+  enable:
+    - megacheck
+    - govet
+    - gocyclo
+    - gocritic
+    - goconst
+    - goimports
+    - gofmt  # We enable this as well as goimports for its simplify mode.
+    - revive
+    - unconvert
+    - misspell
+    - nakedret
+    - exportloopref
+  disable:
+    - deadcode
+    - scopelint
+    - structcheck
+    - varcheck
+    - rowserrcheck
+    - sqlclosecheck
+    - errchkjson
+    - contextcheck
+  presets:
+    - bugs
+    - unused
+  fast: false
+
+
+issues:
+  # Excluding configuration per-path and per-linter
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test(ing)?\.go
+      linters:
+        - gocyclo
+        - errcheck
+        - dupl
+        - gosec
+        - exportloopref
+        - unparam
+
+    # Ease some gocritic warnings on test files.
+    - path: _test\.go
+      text: "(unnamedResult|exitAfterDefer)"
+      linters:
+        - gocritic
+
+    # These are performance optimisations rather than style issues per se.
+    # They warn when function arguments or range values copy a lot of memory
+    # rather than using a pointer.
+    - text: "(hugeParam|rangeValCopy):"
+      linters:
+        - gocritic
+
+    # This "TestMain should call os.Exit to set exit code" warning is not clever
+    # enough to notice that we call a helper method that calls os.Exit.
+    - text: "SA3000:"
+      linters:
+        - staticcheck
+
+    - text: "k8s.io/api/core/v1"
+      linters:
+        - goimports
+
+    # This is a "potential hardcoded credentials" warning. It's triggered by
+    # any variable with 'secret' in the same, and thus hits a lot of false
+    # positives in Kubernetes land where a Secret is an object type.
+    - text: "G101:"
+      linters:
+        - gosec
+        - gas
+
+    # This is an 'errors unhandled' warning that duplicates errcheck.
+    - text: "G104:"
+      linters:
+        - gosec
+        - gas
+
+    # The Azure AddToUserAgent method appends to the existing user agent string.
+    # It returns an error if you pass it an empty string lettinga you know the
+    # user agent did not change, making it more of a warning.
+    - text: \.AddToUserAgent
+      linters:
+        - errcheck
+
+    - text: "don't use an underscore"
+      linters:
+        - revive
+
+    - text: "package-comments: should have a package comment"
+      linters:
+        - revive
+
+    - text: "error-strings: error strings should not be capitalized or end with punctuation or a newline"
+      linters:
+        - revive
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is true.
+  exclude-use-default: false
+
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing
+  # large codebase. It's not practical to fix all existing issues at the moment
+  # of integration: much better don't allow issues in new code.
+  # Default is false.
+  new: false
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-per-linter: 0
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same-issues: 0

packages/velaux-ui/src/services/plugin/PluginCache.ts

@@ -26,7 +26,7 @@ export function getPluginInfo(id: string): Promise<PluginMeta> {
     return Promise.resolve(v);
   }
   return getBackendSrv()
-    .get(`/api/v1/plugins/${pluginId}`)
+    .get(`/api/v1/plugins/${id}`)
     .then((settings: any) => {
       pluginInfoCache[pluginId] = settings;
       return settings;

pkg/plugin/loader/loader.go

@@ -17,7 +17,6 @@ limitations under the License.
 package loader
 
 import (
-	"context"
 	"encoding/json"
 	"errors"
 	"net/url"
@@ -35,30 +34,36 @@ import (
 )
 
 var (
-	ErrInvalidPluginJSON         = errors.New("did not find valid type or id properties in plugin.json")
+	// ErrInvalidPluginJSON -
+	ErrInvalidPluginJSON = errors.New("did not find valid type or id properties in plugin.json")
+	// ErrInvalidPluginJSONFilePath -
 	ErrInvalidPluginJSONFilePath = errors.New("invalid plugin.json filepath was provided")
-	ErrInvalidInclude            = errors.New("the include config is invalid in plugin.json")
+	// ErrInvalidInclude -
+	ErrInvalidInclude = errors.New("the include config is invalid in plugin.json")
 )
 
+// Loader the tool class to load the plugin from the specified path.
 type Loader struct {
 	pluginFinder finder.Finder
 }
 
+// New -
 func New() *Loader {
 	return &Loader{
 		pluginFinder: finder.New(),
 	}
 }
 
-func (l *Loader) Load(ctx context.Context, class types.Class, paths []string, ignore map[string]struct{}) ([]*types.Plugin, error) {
+// Load load plugins from the specified path.
+func (l *Loader) Load(class types.Class, paths []string, ignore map[string]struct{}) ([]*types.Plugin, error) {
 	pluginJSONPaths, err := l.pluginFinder.Find(paths)
 	if err != nil {
 		return nil, err
 	}
-	return l.loadPlugins(ctx, class, pluginJSONPaths, ignore)
+	return l.loadPlugins(class, pluginJSONPaths, ignore)
 }
 
-func (l *Loader) loadPlugins(ctx context.Context, class types.Class, pluginJSONPaths []string, existingPlugins map[string]struct{}) ([]*types.Plugin, error) {
+func (l *Loader) loadPlugins(class types.Class, pluginJSONPaths []string, existingPlugins map[string]struct{}) ([]*types.Plugin, error) {
 	var foundPlugins = foundPlugins{}
 
 	// load plugin.json files and map directory to JSON data
@@ -139,14 +144,6 @@ func (l *Loader) readPluginJSON(pluginJSONPath string) (types.JSONData, error) {
 		return types.JSONData{}, err
 	}
 
-	if len(plugin.Dependencies.Plugins) == 0 {
-		plugin.Dependencies.Plugins = []types.Dependency{}
-	}
-
-	if plugin.Dependencies.VelaUXVersion == "" {
-		plugin.Dependencies.VelaUXVersion = "*"
-	}
-
 	klog.Infof("Loaded plugin,id: %s type: %s path: %s", plugin.ID, plugin.Type, pluginJSONPath)
 
 	return plugin, nil

pkg/plugin/loader/loader_test.go

@@ -17,7 +17,6 @@ limitations under the License.
 package loader
 
 import (
-	"context"
 	"testing"
 
 	"gotest.tools/assert"
@@ -27,7 +26,7 @@ import (
 
 func TestLoad(t *testing.T) {
 	l := New()
-	plugins, err := l.Load(context.TODO(), types.External, []string{"../../../plugins"}, nil)
+	plugins, err := l.Load(types.External, []string{"../../../plugins"}, nil)
 	assert.Equal(t, err, nil)
 	assert.Equal(t, len(plugins), 1)
 	assert.Equal(t, plugins[0].ID, "app-demo")

pkg/plugin/registry/in_memory.go

@@ -8,25 +8,30 @@ import (
 	plugins "github.com/kubevela/velaux/pkg/plugin/types"
 )
 
+// InMemoryPoll save the plugin to memory.
 type InMemoryPoll struct {
 	store map[string]*plugins.Plugin
 	mu    sync.RWMutex
 }
 
+// ProvideService -
 func ProvideService() *InMemoryPoll {
 	return NewInMemory()
 }
 
+// NewInMemory create a memory plugin pool
 func NewInMemory() *InMemoryPoll {
 	return &InMemoryPoll{
 		store: make(map[string]*plugins.Plugin),
 	}
 }
 
+// Plugin load a plugin
 func (i *InMemoryPoll) Plugin(_ context.Context, pluginID string) (*plugins.Plugin, bool) {
 	return i.plugin(pluginID)
 }
 
+// Plugins load all plugins
 func (i *InMemoryPoll) Plugins(_ context.Context) []*plugins.Plugin {
 	i.mu.RLock()
 	defer i.mu.RUnlock()
@@ -39,6 +44,7 @@ func (i *InMemoryPoll) Plugins(_ context.Context) []*plugins.Plugin {
 	return res
 }
 
+// Add save a plugin to pool
 func (i *InMemoryPoll) Add(_ context.Context, p *plugins.Plugin) error {
 	if i.isRegistered(p.ID) {
 		return fmt.Errorf("plugin %s is already registered", p.ID)
@@ -51,6 +57,7 @@ func (i *InMemoryPoll) Add(_ context.Context, p *plugins.Plugin) error {
 	return nil
 }
 
+// Remove remove a plugin from pool
 func (i *InMemoryPoll) Remove(_ context.Context, pluginID string) error {
 	if !i.isRegistered(pluginID) {
 		return fmt.Errorf("plugin %s is not registered", pluginID)