[config]Support config license header comment style. #97

dongzl · 2022-03-19T03:19:41Z

Recently, I use this project to fix myself project license header, It is a GoLand project.

I find that the header comment style config at the languages.yaml and styles.yaml, and it doesn't support config.

The Go file license header comment style is //, like:

// Licensed to the Apache Software Foundation (ASF) under one
// ... ...

But I want the license header comment style is *, like:

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * ... ...
 */

So, I fix code and submit this PR.

I add the config languages at the .licenserc.yaml, and the license header comment style use this file config preferentially, if this file doesn't have this config, it use the default config at the languages.yaml.

dongzl · 2022-03-19T03:40:41Z

Hi skywalking-eyes community, I don't understand why the project CI failure, who can help me, Thanks.

Superskyyy · 2022-03-28T21:19:33Z

pkg/config/config.go

@@ -18,6 +18,7 @@
 package config

 import (
+	"github.com/apache/skywalking-eyes/pkg/comments"


@dongzl Please move this to line 25 and this should fix your lint, try run gofmt -s -w pkg/config/config.go to fix it automatically. Just a formatting issue compaint by the CI.

@dongzl Please move this to line 25 and this should fix your lint, try run gofmt -s -w pkg/config/config.go to fix it automatically. Just a formatting issue compaint by the CI.

@Superskyyy It's OK, Thanks very much.

wu-sheng · 2022-03-31T02:12:45Z

@kezhenxu94 Please take a look.

kezhenxu94

IT's better to merge the user-configured settings with the default ones (

skywalking-eyes/pkg/comments/config.go

Line 55 in eb0e0b0

var commentStyles = make(map[string]CommentStyle)

), so you don't need to change the fix logic.

kezhenxu94 · 2022-03-31T02:10:00Z

pkg/config/config.go

-	Deps   deps.ConfigDeps     `yaml:"dependency"`
+	Header    header.ConfigHeader          `yaml:"header"`
+	Deps      deps.ConfigDeps              `yaml:"dependency"`
+	Languages map[string]comments.Language `yaml:"language"`


This config should be under Header

kezhenxu94 · 2022-03-31T02:14:24Z

.licenserc.yaml

+    type: programming
+    color: "#00ADD8"
+    aliases:
+      - golang
+    extensions:
+      - ".go"
+    tm_scope: source.go
+    ace_mode: golang
+    codemirror_mode: go
+    codemirror_mime_type: text/x-go
+    language_id: 132
+    comment_style_id: SlashAsterisk


Please minimize the configs, we only need some of the fields, like comment_style_id and extensions,

Please minimize the configs, we only need some of the fields, like comment_style_id and extensions,

Hi @kezhenxu94 , Thanks for reply, I will fix it.

dongzl · 2022-03-31T10:07:00Z

Hi @kezhenxu94 , I considered about this way, but read code,
var commentStyles = make(map[string]CommentStyle) is private and comments/config.go's init method can't receive param, I don't know how to merge the config content, so I use this way now.

kezhenxu94 · 2022-03-31T10:12:11Z

Hi @kezhenxu94 , I considered about this way, but read code,
var commentStyles = make(map[string]CommentStyle) is private and comments/config.go's init method can't receive param, I don't know how to merge the config content, so I use this way now.

Hi @dongzl , the way I proposed needs some other changes for sure, you can

Add a method (OverrideLanguageCommentStyle) in

skywalking-eyes/pkg/comments/config.go

Line 107 in f23c9f4

}
Invoke the OverrideLanguageCommentStyle in

skywalking-eyes/pkg/header/config.go

Lines 102 to 103 in f23c9f4

func (config *ConfigHeader) Finalize() error {

if len(config.Paths) == 0 {

dongzl · 2022-03-31T12:27:34Z

Hi @kezhenxu94 , I considered about this way, but read code,
var commentStyles = make(map[string]CommentStyle) is private and comments/config.go's init method can't receive param, I don't know how to merge the config content, so I use this way now.

Hi @dongzl , the way I proposed needs some other changes for sure, you can

Add a method (OverrideLanguageCommentStyle) in

skywalking-eyes/pkg/comments/config.go

Line 107 in f23c9f4

}

Invoke the OverrideLanguageCommentStyle in

skywalking-eyes/pkg/header/config.go

Lines 102 to 103 in f23c9f4

func (config *ConfigHeader) Finalize() error {

if len(config.Paths) == 0 {

Hi @kezhenxu94 , OK I understand, I will try it.

kezhenxu94 · 2022-04-06T01:53:11Z

pkg/header/config.go

@@ -104,6 +106,8 @@ func (config *ConfigHeader) Finalize() error {
 		config.Paths = []string{"**"}
 	}

+	comments.OverrideLanguageCommentStyle(config.Languages)


Concerns are addressed

kezhenxu94 · 2022-04-06T02:08:02Z

@dongzl nice done! Can you open another pull request to add the usage into the documentation as well?

dongzl · 2022-04-06T02:52:57Z

@dongzl nice done! Can you open another pull request to add the usage into the documentation as well?

Hi @kezhenxu94 , Thanks for your code review, I will finish documentation.

dongzl added 6 commits March 19, 2022 09:42

config: support config license header comment style.

805c48b

config: add unit test for support config license header comment style.

d7b293d

config: add config parse unit test.

1374ea2

config: add config example for language comment style.

ac4c5c6

Fixes code style check problem.

44c1b5f

Fixes code style check problem.

b143265

wu-sheng requested a review from kezhenxu94 March 19, 2022 04:01

Superskyyy previously requested changes Mar 28, 2022

View reviewed changes

Fixes code style check problem.

7c98f16

wu-sheng added the feature label Mar 31, 2022

wu-sheng added this to the 0.3.0 milestone Mar 31, 2022

kezhenxu94 requested changes Mar 31, 2022

View reviewed changes

dongzl added 4 commits April 4, 2022 10:18

config: support config license header comment style, fix code logic.

8d99904

Fixes test config file directory.

3ca930f

Fixes checkstyle problem.

e916383

Remove unused test file.

badd0f6

dongzl requested review from kezhenxu94 and Superskyyy April 4, 2022 02:42

Fixes project config.

672c344

kezhenxu94 approved these changes Apr 6, 2022

View reviewed changes

kezhenxu94 merged commit 66a8bd6 into apache:main Apr 6, 2022

dongzl deleted the support-config-language branch April 6, 2022 05:46

kezhenxu94 mentioned this pull request Apr 12, 2022

[INFRA] Support for Block Comment Style for Python files apache/skywalking#7547

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[config]Support config license header comment style. #97

[config]Support config license header comment style. #97

dongzl commented Mar 19, 2022

dongzl commented Mar 19, 2022

Superskyyy Mar 28, 2022

dongzl Mar 31, 2022

wu-sheng commented Mar 31, 2022

kezhenxu94 left a comment

kezhenxu94 Mar 31, 2022

kezhenxu94 Mar 31, 2022

dongzl Mar 31, 2022

dongzl commented Mar 31, 2022

kezhenxu94 commented Mar 31, 2022

dongzl commented Mar 31, 2022

kezhenxu94 Apr 6, 2022

kezhenxu94 commented Apr 6, 2022

dongzl commented Apr 6, 2022

[config]Support config license header comment style. #97

[config]Support config license header comment style. #97

Conversation

dongzl commented Mar 19, 2022

dongzl commented Mar 19, 2022

Superskyyy Mar 28, 2022

Choose a reason for hiding this comment

dongzl Mar 31, 2022

Choose a reason for hiding this comment

wu-sheng commented Mar 31, 2022

kezhenxu94 left a comment

Choose a reason for hiding this comment

kezhenxu94 Mar 31, 2022

Choose a reason for hiding this comment

kezhenxu94 Mar 31, 2022

Choose a reason for hiding this comment

dongzl Mar 31, 2022

Choose a reason for hiding this comment

dongzl commented Mar 31, 2022

kezhenxu94 commented Mar 31, 2022

dongzl commented Mar 31, 2022

kezhenxu94 Apr 6, 2022

Choose a reason for hiding this comment

kezhenxu94 commented Apr 6, 2022

dongzl commented Apr 6, 2022