go.charczuk.com@v0.0.0-20240327042549-bc490516bd1a/sdk/copyright/constants.go

/*

Copyright (c) 2023 - Present. Will Charczuk. All rights reserved.
Use of this source code is governed by a MIT license that can be found in the LICENSE file at the root of the repository.

*/

package copyright

import (
	"errors"
	"regexp"
)

// DefaultCopyrightHolder is the default copyright holder to inject into the notice template.
//
// As of writing, it's blank. You'll want to provide it!
const DefaultCopyrightHolder = ""

// DefaultOpenSourceLicense is the default open source license.
const DefaultOpenSourceLicense = "MIT"

// DefaultNoticeBodyTemplate is the default notice body template.
const DefaultNoticeTemplate = `Copyright (c) {{ .Year }} - Present. {{ .CopyrightHolder }}. All rights reserved.
{{- if .Restrictions }}
{{ .Restrictions }}
{{- end -}}`

// DefaultRestrictionsOpenSource are the default open source restrictions.
const DefaultRestrictionsTemplate = `Use of this source code is governed by a {{ .License }} license that can be found in the LICENSE file at the root of the repository.`

// DefaultRestrictionsTemplateInternal are the default copyright restrictions to inject into the notice template.
const DefaultRestrictionsTemplateInternal = "{{ if .CopyrightHolder }}{{ .CopyrightHolder }} {{ end }}Confidential - Restricted"

const (
	TemplateFieldYear            = "Year"
	TemplateFieldCopyrightHolder = "CopyrightHolder"
	TemplateFieldLicense         = "License"
	TemplateFieldRestrictions    = "Restrictions"
)

// Extension is a string enum for known extensions.
type Extension string

// Extensions
const (
	ExtensionUnknown Extension = ""
	ExtensionCSS     Extension = ".css"
	ExtensionGo      Extension = ".go"
	ExtensionHTML    Extension = ".html"
	ExtensionJS      Extension = ".js"
	ExtensionJSX     Extension = ".jsx"
	ExtensionPy      Extension = ".py"
	ExtensionSASS    Extension = ".sass"
	ExtensionSCSS    Extension = ".scss"
	ExtensionTS      Extension = ".ts"
	ExtensionTSX     Extension = ".tsx"
	ExtensionYAML    Extension = ".yaml"
	ExtensionYML     Extension = ".yml"
	ExtensionSQL     Extension = ".sql"
	ExtensionProto   Extension = ".proto"
)

var (
	// KnownExtensions is a list of all the known extensions.
	KnownExtensions = []Extension{
		ExtensionCSS,
		ExtensionGo,
		ExtensionHTML,
		ExtensionJS,
		ExtensionJSX,
		ExtensionPy,
		ExtensionSCSS,
		ExtensionSASS,
		ExtensionTS,
		ExtensionTSX,
		ExtensionYAML,
		ExtensionYML,
		ExtensionSQL,
		ExtensionProto,
	}

	// DefaultExtensionInjectionTemplates is a mapping between file extension (including the prefix dot) to the injection templates.
	DefaultExtensionInjectionTemplates = map[Extension]string{
		ExtensionCSS:   cssInjectionTemplate,
		ExtensionGo:    goInjectionTemplate,
		ExtensionHTML:  htmlInjectionTemplate,
		ExtensionJS:    jsInjectionTemplate,
		ExtensionJSX:   jsInjectionTemplate,
		ExtensionPy:    pythonInjectionTemplate,
		ExtensionSASS:  sassInjectionTemplate,
		ExtensionSCSS:  scssInjectionTemplate,
		ExtensionTS:    tsInjectionTemplate,
		ExtensionTSX:   tsInjectionTemplate,
		ExtensionYAML:  yamlInjectionTemplate,
		ExtensionYML:   yamlInjectionTemplate,
		ExtensionSQL:   sqlInjectionTemplate,
		ExtensionProto: protoInjectionTemplate,
	}

	// DefaultExcludes is the default excluded directories.
	DefaultExcludes = []string{
		".git/*",
		".github/*",
		"*/_config",
		"*/_config/*",
		"*/dist/*",
		"*/node_modules/*",
		"*/testdata",
		"*/testdata/*",
		"*/vendor/*",
		"node_modules/*",
		"protogen/*",
		"*.pb.go",
		"vendor/*",
		"venv/*",
		"*/venv/*",
		".vscode/*",
		"*/.vscode/*",
		"*/_nextjs/*",
		"*/_nextjs",
		"*/_public/*",
		"*/_public",
		"*/_dist/*",
		"*/_dist",
	}

	// DefaultIncludes is the default included files list.
	DefaultIncludes = []string{
		"*.css",
		"*.go",
		"*.html",
		"*.js",
		"*.jsx",
		"*.py",
		"*.sass",
		"*.scss",
		"*.ts",
		"*.tsx",
		"*.yaml",
		"*.yml",
		"*.sql",
		"*.proto",
	}
)

// Error Strings
var (
	ErrVerifyFormat = "%s: copyright header missing or invalid"
)

// Error sentinels
var (
	ErrWalkSkip = errors.New("walk skip; we should not process this file or path")
	ErrFailure  = errors.New("failure; one or more steps failed")
)

const (
	// goNoticeTemplate is the notice template specific to go files
	// note: it _must_ end in two newlines to prevent linting / compiler failures.
	goInjectionTemplate = `/*

{{ .Notice }}

*/

`

	yamlInjectionTemplate = `#
{{ .Notice | prefix "# " }}
#
`

	htmlInjectionTemplate = `<!--
{{ .Notice }}
-->
`

	jsInjectionTemplate = `/**
{{ .Notice | prefix " * " }}
 */
`

	tsInjectionTemplate = `/**
{{ .Notice | prefix " * " }}
 */
`

	cssInjectionTemplate = `/*
{{ .Notice | prefix " * " }}
 */
`

	scssInjectionTemplate = `/*
{{ .Notice | prefix " * " }}
 */
`

	sassInjectionTemplate = `/*
{{ .Notice | prefix " * " }}
 */
`

	pythonInjectionTemplate = `#
{{ .Notice | prefix "# " }}
#

`

	sqlInjectionTemplate = `--
{{ .Notice | prefix "-- " }}
--
`

	protoInjectionTemplate = `//
{{ .Notice | prefix "// " }}
//

`
)

const (
	goBuildTagExpr      = `^(\/\/(go:build| \+build).*\n)+\n`
	tsReferenceTagsExpr = `^(\/\/\/ \<reference path=\"(.*)\" \/\>\n)+`
	yearExpr            = `([0-9]{4,}?)`
	shebangExpr         = `(?s)^(\s*)#!([^\n]+)\n`
)

var (
	goBuildTagMatch      = regexp.MustCompile(goBuildTagExpr)
	tsReferenceTagsMatch = regexp.MustCompile(tsReferenceTagsExpr)
	yearMatch            = regexp.MustCompile(yearExpr)
	shebangMatch         = regexp.MustCompile(shebangExpr)
)