From dc1e825e2b46fffa01887a48ea4c1bf2e832b91e Mon Sep 17 00:00:00 2001 From: storyicon Date: Thu, 22 Jul 2021 00:58:28 +0800 Subject: [PATCH] chore(*): format Signed-off-by: storyicon --- LICENSE | 201 ++++++++++++++++++++ README.md | 5 +- README_CN.md | 1 + cmd/powerproto/subcommands/build/command.go | 12 +- cmd/powerproto/subcommands/env/command.go | 6 +- cmd/powerproto/subcommands/tidy/command.go | 3 + pkg/bootstraps/build.go | 2 +- pkg/bootstraps/tidy.go | 4 +- pkg/component/actionmanager/manager.go | 6 +- pkg/component/compilermanager/manager.go | 4 +- pkg/component/configmanager/manager.go | 4 +- pkg/configs/configs.go | 2 +- pkg/configs/item.go | 2 +- pkg/util/file.go | 2 +- pkg/util/logger/logger.go | 2 + pkg/util/yaml.go | 1 - 16 files changed, 233 insertions(+), 24 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index ec181fa..dfc17fc 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ PowerProto is used to solve the following three main problems: 5. support batch and recursive compilation of proto files to improve efficiency. 6. cross-platform support PostAction, you can perform some routine operations (such as replacing "omitempty" in all generated files) after the compilation. 7. support PostShell, execute specific shell scripts after the compilation. -8. support `google apis` one-click installation and version control。 +8. support google apis one-click installation and version control。 ## Installation and Dependencies @@ -61,7 +61,7 @@ PowerProto is used to solve the following three main problems: Installation can be performed by executing the following command directly: ``` -go install github.com/storyicon/powerproto/cmd/powerproto +go install github.com/storyicon/powerproto/cmd/powerproto@latest ``` ### II. out-of-the-box version @@ -78,6 +78,7 @@ powerproto -h powerproto init -h powerproto tidy -h powerproto build -h +powerproto env -h ``` It has the advantage that the documentation on the command line is always consistent with your binary version. diff --git a/README_CN.md b/README_CN.md index 296b47e..9d23e73 100644 --- a/README_CN.md +++ b/README_CN.md @@ -77,6 +77,7 @@ powerproto -h powerproto init -h powerproto tidy -h powerproto build -h +powerproto env -h ``` 它的好处是命令行中的文档永远和你的二进制版本保持一致。而Github上的文档可能会一直是对应最新的二进制。 diff --git a/cmd/powerproto/subcommands/build/command.go b/cmd/powerproto/subcommands/build/command.go index eed06b1..025444d 100644 --- a/cmd/powerproto/subcommands/build/command.go +++ b/cmd/powerproto/subcommands/build/command.go @@ -42,7 +42,7 @@ compile proto files and execute the post actions/shells: powerproto build -r -a [dir] ` -// compile proto files +// CommandBuild is used to compile proto files // powerproto build -r . // powerproto build . // powerproto build xxxxx.proto @@ -57,7 +57,13 @@ func CommandBuild(log logger.Logger) *cobra.Command { Long: strings.TrimSpace(description), Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { + log.SetLogLevel(logger.LevelInfo) ctx := cmd.Context() + if debugMode { + ctx = consts.WithDebugMode(ctx) + log.LogWarn(nil, "running in debug mode") + log.SetLogLevel(logger.LevelDebug) + } if dryRun { ctx = consts.WithDryRun(ctx) log.LogWarn(nil, "running in dryRun mode") @@ -65,10 +71,6 @@ func CommandBuild(log logger.Logger) *cobra.Command { if !postScriptEnabled { ctx = consts.WithDisableAction(ctx) } - if debugMode { - ctx = consts.WithDebugMode(ctx) - log.LogWarn(nil, "running in debug mode") - } target, err := filepath.Abs(args[0]) if err != nil { diff --git a/cmd/powerproto/subcommands/env/command.go b/cmd/powerproto/subcommands/env/command.go index 2eae085..e6162e5 100644 --- a/cmd/powerproto/subcommands/env/command.go +++ b/cmd/powerproto/subcommands/env/command.go @@ -24,10 +24,10 @@ import ( "github.com/storyicon/powerproto/pkg/util/logger" ) -// Print environment variables related to program operation +// CommandEnv is used to print environment variables related to program operation func CommandEnv(log logger.Logger) *cobra.Command { return &cobra.Command{ - Use: "env", + Use: "env", Short: "list the environments and binary files", Run: func(cmd *cobra.Command, args []string) { log.LogInfo(nil, "[ENVIRONMENT]") @@ -41,7 +41,7 @@ func CommandEnv(log logger.Logger) *cobra.Command { } log.LogInfo(nil, "[BIN]") - for _, key := range []string { + for _, key := range []string{ "go", "git", } { diff --git a/cmd/powerproto/subcommands/tidy/command.go b/cmd/powerproto/subcommands/tidy/command.go index 7127194..5d031c0 100644 --- a/cmd/powerproto/subcommands/tidy/command.go +++ b/cmd/powerproto/subcommands/tidy/command.go @@ -57,6 +57,7 @@ func tidy(ctx context.Context, return nil } +// CommandTidy is used to clean the config file // By default, clean the powerproto.yaml of the current directory and all parent directories // You can also explicitly specify the configuration file to clean up func CommandTidy(log logger.Logger) *cobra.Command { @@ -66,7 +67,9 @@ func CommandTidy(log logger.Logger) *cobra.Command { Short: "tidy the config file. It will replace the version number and install the protoc and proto plugins that declared in the config file", Run: func(cmd *cobra.Command, args []string) { ctx := cmd.Context() + log.SetLogLevel(logger.LevelInfo) if debugMode { + log.SetLogLevel(logger.LevelDebug) ctx = consts.WithDebugMode(ctx) log.LogWarn(nil, "running in debug mode") } diff --git a/pkg/bootstraps/build.go b/pkg/bootstraps/build.go index d45c031..be16643 100644 --- a/pkg/bootstraps/build.go +++ b/pkg/bootstraps/build.go @@ -290,7 +290,7 @@ func StepPostShell(ctx context.Context, // Compile is used to compile proto files func Compile(ctx context.Context, targets []string) error { log := logger.NewDefault("compile") - log.SetLogLevel(logger.LevelError) + log.SetLogLevel(logger.LevelInfo) if consts.IsDebugMode(ctx) { log.SetLogLevel(logger.LevelDebug) } diff --git a/pkg/bootstraps/tidy.go b/pkg/bootstraps/tidy.go index c3631b6..e2e4b23 100644 --- a/pkg/bootstraps/tidy.go +++ b/pkg/bootstraps/tidy.go @@ -31,7 +31,7 @@ import ( // StepTidyConfig is used to tidy configs by proto file targets func StepTidyConfig(ctx context.Context, targets []string) error { log := logger.NewDefault("tidy") - log.SetLogLevel(logger.LevelError) + log.SetLogLevel(logger.LevelInfo) if consts.IsDebugMode(ctx) { log.SetLogLevel(logger.LevelDebug) } @@ -72,7 +72,7 @@ func StepTidyConfig(ctx context.Context, targets []string) error { return nil } -// StepTidyConfig is used clean config +// StepTidyConfigFile is used clean config // It will amend the 'latest' version to the latest version number in 'vx.y.z' format func StepTidyConfigFile(ctx context.Context, pluginManager pluginmanager.PluginManager, diff --git a/pkg/component/actionmanager/manager.go b/pkg/component/actionmanager/manager.go index 010618b..94376d2 100644 --- a/pkg/component/actionmanager/manager.go +++ b/pkg/component/actionmanager/manager.go @@ -51,10 +51,10 @@ func NewBasicActionManager(log logger.Logger) (*BasicActionManager, error) { return &BasicActionManager{ Logger: log.NewLogger("actionmanager"), actions: map[string]actions.ActionFunc{ - "move": actions.ActionMove, + "move": actions.ActionMove, "replace": actions.ActionReplace, - "remove": actions.ActionRemove, - "copy": actions.ActionCopy, + "remove": actions.ActionRemove, + "copy": actions.ActionCopy, }, }, nil } diff --git a/pkg/component/compilermanager/manager.go b/pkg/component/compilermanager/manager.go index 9d571b6..71c5f35 100644 --- a/pkg/component/compilermanager/manager.go +++ b/pkg/component/compilermanager/manager.go @@ -36,7 +36,7 @@ type BasicCompilerManager struct { configManager configmanager.ConfigManager pluginManager pluginmanager.PluginManager - tree map[string]Compiler + tree map[string]Compiler treeLock sync.RWMutex } @@ -51,7 +51,7 @@ func NewCompilerManager(ctx context.Context, return NewBasicCompilerManager(ctx, log, configManager, pluginManager) } -// BasicCompilerManager is used to create basic CompilerManager +// NewBasicCompilerManager is used to create basic CompilerManager func NewBasicCompilerManager(ctx context.Context, log logger.Logger, configManager configmanager.ConfigManager, diff --git a/pkg/component/configmanager/manager.go b/pkg/component/configmanager/manager.go index 9212fc8..94632dd 100644 --- a/pkg/component/configmanager/manager.go +++ b/pkg/component/configmanager/manager.go @@ -46,7 +46,7 @@ type BasicConfigManager struct { treeLock sync.RWMutex } -// New is used to create a basic ConfigManager +// NewBasicConfigManager is used to create a basic ConfigManager func NewBasicConfigManager(log logger.Logger) (*BasicConfigManager, error) { return &BasicConfigManager{ Logger: log.NewLogger("configmanager"), @@ -54,7 +54,7 @@ func NewBasicConfigManager(log logger.Logger) (*BasicConfigManager, error) { }, nil } -// GetCompiler is used to get config of specified proto file path +// GetConfig is used to get config of specified proto file path func (b *BasicConfigManager) GetConfig(ctx context.Context, protoFilePath string) (configs.ConfigItem, error) { possiblePath := configs.ListConfigPaths(filepath.Dir(protoFilePath)) for _, configFilePath := range possiblePath { diff --git a/pkg/configs/configs.go b/pkg/configs/configs.go index 1fcdb30..43d98e9 100644 --- a/pkg/configs/configs.go +++ b/pkg/configs/configs.go @@ -83,7 +83,7 @@ func LoadConfigs(path string) ([]*Config, error) { return ret, nil } -// Similar to LoadConfigs, but obtains the abstraction of the Config prototype structure +// LoadConfigItems is similar to LoadConfigs, but obtains the abstraction of the Config prototype structure func LoadConfigItems(path string) ([]ConfigItem, error) { data, err := LoadConfigs(path) if err != nil { diff --git a/pkg/configs/item.go b/pkg/configs/item.go index 4fcf023..24a26cc 100644 --- a/pkg/configs/item.go +++ b/pkg/configs/item.go @@ -28,7 +28,7 @@ type ConfigItem interface { Config() *Config } -// GetConfigs is used to generate Config from given config entity +// GetConfigItems is used to generate ConfigItem from given config entity func GetConfigItems(data []*Config, path string) []ConfigItem { ret := make([]ConfigItem, 0, len(data)) for i, item := range data { diff --git a/pkg/util/file.go b/pkg/util/file.go index c2769d7..0dd51d1 100644 --- a/pkg/util/file.go +++ b/pkg/util/file.go @@ -110,7 +110,7 @@ func GetFilesWithExtRecursively(target string, targetExt string) ([]string, erro return data, err } -// GetFilesWithExtRecursively is used to list files with a specific suffix +// GetFilesWithExt is used to list files with a specific suffix // expectExt should contain the prefix '.' func GetFilesWithExt(dir string, targetExt string) ([]string, error) { children, err := ioutil.ReadDir(dir) diff --git a/pkg/util/logger/logger.go b/pkg/util/logger/logger.go index 74831ea..fe007d2 100644 --- a/pkg/util/logger/logger.go +++ b/pkg/util/logger/logger.go @@ -58,6 +58,7 @@ type Config struct { Level Level } +// Level is the structure of log level type Level struct { Name string Color color.Attribute @@ -65,6 +66,7 @@ type Level struct { Writer io.Writer } +// defines a set of log level var ( LevelDebug = Level{Name: "debug", Color: color.FgWhite, Index: 0, Writer: os.Stdout} LevelInfo = Level{Name: "info", Color: color.FgWhite, Index: 1, Writer: os.Stdout} diff --git a/pkg/util/yaml.go b/pkg/util/yaml.go index 80ab5d8..70f76a8 100644 --- a/pkg/util/yaml.go +++ b/pkg/util/yaml.go @@ -71,4 +71,3 @@ func LoadConfig(filename string, pointer interface{}) error { return nil } -