license-eye/pkg/header/fix/angle_bracket.go

// Licensed to 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. Apache Software Foundation (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 fix

import (
	"fmt"
	"io/ioutil"
	"os"
	"reflect"
	"strings"

	"github.com/apache/skywalking-eyes/license-eye/pkg/header"
)

// AngleBracket adds the configured license header to files whose comment starts with <!--.
func AngleBracket(file string, config *header.ConfigHeader, result *header.Result) error {
	stat, err := os.Stat(file)
	if err != nil {
		return err
	}

	content, err := ioutil.ReadFile(file)
	if err != nil {
		return err
	}

	if len(content) > 5 && !reflect.DeepEqual(content[0:5], []byte("<?xml")) { // doesn't contains xml declaration
		lines := "<!--\n  ~ " + strings.Join(strings.Split(config.License, "\n"), "\n  ~ ") + "\n-->\n"

		if err := ioutil.WriteFile(file, append([]byte(lines), content...), stat.Mode()); err != nil {
			return err
		}

		result.Fix(file)
	} else {
		// TODO: tackle with the "xml declaration"
		return fmt.Errorf("xml with xml declaration is not supported yet")
	}

	return nil
}