[config]Support config license header comment style.

.licenserc.yaml

@@ -83,3 +83,18 @@ header: # `header` section is configurations for source codes license header.
 dependency:
   files:
     - go.mod
+
+language:
+  Go:
+    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

commands/header_fix.go

@@ -45,7 +45,7 @@ var FixCommand = &cobra.Command{
 		}
 
 		for _, file := range files {
-			if err := header.Fix(file, &Config.Header, &result); err != nil {
+			if err := header.Fix(file, &Config.Header, Config.Languages, &result); err != nil {
 				errors = append(errors, err.Error())
 			}
 		}

pkg/comments/config.go

@@ -114,3 +114,8 @@ func FileCommentStyle(filename string) *CommentStyle {
 	}
 	return nil
 }
+
+func FileCommentStyleByID(styleID string) *CommentStyle {
+	result := comments[styleID]
+	return &result
+}

pkg/comments/config_test.go

@@ -63,3 +63,12 @@ func TestCommentStyle(t *testing.T) {
 		})
 	}
 }
+
+func TestFileCommentStyleById(t *testing.T) {
+	styleId := "SlashAsterisk"
+	style := FileCommentStyleByID(styleId)
+	if len(style.ID) == 0 {
+		t.Logf("Comment style not exist, ID = %v", styleId)
+		t.Fail()
+	}
+}

pkg/config/.licenserc_test.yaml

@@ -0,0 +1,128 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+header: # `header` section is configurations for source codes license header.
+  license:
+    spdx-id: Apache-2.0 # the spdx id of the license, it's convenient when your license is standard SPDX license.
+    copyright-owner: Apache Software Foundation # the copyright owner to replace the [owner] in the `spdx-id` template.
+    content: | # `license` will be used as the content when `fix` command needs to insert a license header.
+      Licensed to the Apache Software Foundation (ASF) under one
+      or more contributor license agreements.  See the NOTICE file
+      distributed with this work for additional information
+      regarding copyright ownership.  The ASF licenses this file
+      to you 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.
+
+    # `pattern` is optional regexp if all the file headers are the same as `license` or the license of `spdx-id` and `copyright-owner`.
+    pattern: |
+      Licensed to the Apache Software Foundation (ASF) under one
+      or more contributor license agreements.  See the NOTICE file
+      distributed with this work for additional information
+      regarding copyright ownership.  The ASF licenses this file
+      to you 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.
+
+  paths: # `paths` are the path list that will be checked (and fixed) by license-eye, default is ['**'].
+    - '**'
+
+  paths-ignore: # `paths-ignore` are the path list that will be ignored by license-eye.
+    - 'dist'
+    - 'licenses'
+    - '**/*.md'
+    - '**/testdata/**'
+    - '**/go.mod'
+    - '**/go.sum'
+    - 'LICENSE'
+    - 'NOTICE'
+    - '**/assets/header-templates/**'
+    - '**/assets/lcs-templates/**'
+    - '**/assets/languages.yaml'
+    - '**/assets/assets.gen.go'
+    - 'docs/**.svg'
+
+  comment: on-failure # on what condition license-eye will comment on the pull request, `on-failure`, `always`, `never`.
+
+  # license-location-threshold specifies the index threshold where the license header can be located,
+  # after all, a "header" cannot be TOO far from the file start.
+  license-location-threshold: 80
+
+dependency:
+  files:
+    - go.mod
+
+language:
+  Go:
+    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
+  YAML:
+    type: data
+    color: "#cb171e"
+    tm_scope: source.yaml
+    aliases:
+      - yml
+    extensions:
+      - ".yml"
+      - ".mir"
+      - ".reek"
+      - ".rviz"
+      - ".sublime-syntax"
+      - ".syntax"
+      - ".yaml"
+      - ".yaml-tmlanguage"
+      - ".yaml.sed"
+      - ".yml.mysql"
+    filenames:
+      - ".clang-format"
+      - ".clang-tidy"
+      - ".gemrc"
+      - glide.lock
+      - yarn.lock
+    ace_mode: yaml
+    codemirror_mode: yaml
+    codemirror_mime_type: text/x-yaml
+    language_id: 407
+    comment_style_id: Hashtag

pkg/config/config.go

@@ -22,15 +22,17 @@ import (
 
 	"github.com/apache/skywalking-eyes/assets"
 	"github.com/apache/skywalking-eyes/internal/logger"
+	"github.com/apache/skywalking-eyes/pkg/comments"
 	"github.com/apache/skywalking-eyes/pkg/deps"
 	"github.com/apache/skywalking-eyes/pkg/header"
 
 	"gopkg.in/yaml.v3"
 )
 
 type Config struct {
-	Header header.ConfigHeader `yaml:"header"`
-	Deps   deps.ConfigDeps     `yaml:"dependency"`
+	Header    header.ConfigHeader          `yaml:"header"`
+	Deps      deps.ConfigDeps              `yaml:"dependency"`
+	Languages map[string]comments.Language `yaml:"language"`
 }
 
 // Parse reads and parses the header check configurations in config file.

pkg/config/config_test.go

@@ -0,0 +1,39 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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.
+
+package config
+
+import "testing"
+
+func TestParseConfig(t *testing.T) {
+	config := &Config{
+
+	}
+	configFile := ".licenserc_test.yaml"
+	config.Parse(configFile)
+	if len(config.Header.GetLicenseContent()) == 0 {
+		t.Fail()
+	}
+	t.Logf("Parse config dependency files size = %v", len(config.Deps.Files))
+	if len(config.Deps.Files) == 0 {
+		t.Fail()
+	}
+	t.Logf("Parse config languages size = %v", len(config.Languages))
+	if len(config.Languages) == 0 {
+		t.Fail()
+	}
+}

pkg/header/fix.go

@@ -29,14 +29,14 @@ import (
 )
 
 // Fix adds the configured license header to the given file.
-func Fix(file string, config *ConfigHeader, result *Result) error {
+func Fix(file string, config *ConfigHeader, languages map[string]comments.Language, result *Result) error {
 	var r Result
 	if err := CheckFile(file, config, &r); err != nil || !r.HasFailure() {
 		logger.Log.Warnln("Try to fix a valid file, do nothing:", file)
 		return err
 	}
 
-	style := comments.FileCommentStyle(file)
+	style := getCommentStyle(file, languages)
 
 	if style == nil {
 		return fmt.Errorf("unsupported file: %v", file)
@@ -45,6 +45,39 @@ func Fix(file string, config *ConfigHeader, result *Result) error {
 	return InsertComment(file, style, config, result)
 }
 
+func getCommentStyle(filename string, languages map[string]comments.Language) *comments.CommentStyle {
+	result := comments.FileCommentStyle(filename)
+	configCommentStyles := configCommentStyle(languages)
+	for extension, styleID := range configCommentStyles {
+		if strings.HasSuffix(filename, extension) {
+			result = comments.FileCommentStyleByID(styleID)
+		}
+	}
+	return result
+}
+
+func configCommentStyle(languages map[string]comments.Language) map[string]string {
+	result := make(map[string]string)
+	if len(languages) == 0 {
+		return result
+	}
+	for _, lang := range languages {
+		for _, extension := range lang.Extensions {
+			if lang.CommentStyleID == "" {
+				continue
+			}
+			result[extension] = lang.CommentStyleID
+		}
+		for _, filename := range lang.Filenames {
+			if lang.CommentStyleID == "" {
+				continue
+			}
+			result[filename] = lang.CommentStyleID
+		}
+	}
+	return result
+}
+
 func InsertComment(file string, style *comments.CommentStyle, config *ConfigHeader, result *Result) error {
 	stat, err := os.Stat(file)
 	if err != nil {