ralsina/tartrazine
1
0
Fork 0
mirror of https://github.com/ralsina/tartrazine.git synced 2024-09-20 07:21:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

refactoring: move public constant/types to enry.go

Browse Source 
Also re-arrange public API functions to have the same order
as they are in tests.
This commit is contained in:
Alex Bezzubov 2022-11-23 18:46:10 +01:00
parent a1d6d88745
commit a3304aa121
2 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
common.go
View File

@ -38,7 +38,7 @@ var defaultClassifier classifier = &naiveBayes{
} }
// GetLanguage applies a sequence of strategies based on the given filename and content // GetLanguage applies a sequence of strategies based on the given filename and content
// to find out the most probably language to return. // to find out the most probable language to return.
func GetLanguage(filename string, content []byte) (language string) { func GetLanguage(filename string, content []byte) (language string) {
languages := GetLanguages(filename, content) languages := GetLanguages(filename, content)
return firstLanguage(languages) return firstLanguage(languages)
@ -508,28 +508,6 @@ func GetLanguageExtensions(language string) []string {
return data.ExtensionsByLanguage[language] return data.ExtensionsByLanguage[language]
} }
// GetLanguageID returns the ID for the language. IDs are assigned by GitHub.
// The input must be the canonical language name. Aliases are not supported.
//
// NOTE: The zero value (0) is a valid language ID, so this API mimics the Go
// map API. Use the second return value to check if the language was found.
func GetLanguageID(language string) (int, bool) {
id, ok := data.IDByLanguage[language]
return id, ok
}
// Type represent language's type. Either data, programming, markup, prose, or unknown.
type Type int
// Type's values.
const (
Unknown Type = Type(data.TypeUnknown)
Data = Type(data.TypeData)
Programming = Type(data.TypeProgramming)
Markup = Type(data.TypeMarkup)
Prose = Type(data.TypeProse)
)
// GetLanguageType returns the type of the given language. // GetLanguageType returns the type of the given language.
func GetLanguageType(language string) (langType Type) { func GetLanguageType(language string) (langType Type) {
intType, ok := data.LanguagesType[language] intType, ok := data.LanguagesType[language]
@ -540,6 +518,15 @@ func GetLanguageType(language string) (langType Type) {
return langType return langType
} }
// GetLanguageGroup returns language group or empty string if language does not have group.
func GetLanguageGroup(language string) string {
if group, ok := data.LanguagesGroup[language]; ok {
return group
}
return ""
}
// GetLanguageByAlias returns either the language related to the given alias and ok set to true // GetLanguageByAlias returns either the language related to the given alias and ok set to true
// or Otherlanguage and ok set to false if the alias is not recognized. // or Otherlanguage and ok set to false if the alias is not recognized.
func GetLanguageByAlias(alias string) (lang string, ok bool) { func GetLanguageByAlias(alias string) (lang string, ok bool) {
@ -551,13 +538,14 @@ func GetLanguageByAlias(alias string) (lang string, ok bool) {
return return
} }
// GetLanguageGroup returns language group or empty string if language does not have group. // GetLanguageID returns the ID for the language. IDs are assigned by GitHub.
func GetLanguageGroup(language string) string { // The input must be the canonical language name. Aliases are not supported.
if group, ok := data.LanguagesGroup[language]; ok { //
return group // NOTE: The zero value (0) is a valid language ID, so this API mimics the Go
} // map API. Use the second return value to check if the language was found.
func GetLanguageID(language string) (int, bool) {
return "" id, ok := data.IDByLanguage[language]
return id, ok
} }
// GetLanguageInfo returns the LanguageInfo for a given language name, or an error if not found. // GetLanguageInfo returns the LanguageInfo for a given language name, or an error if not found.

14
enry.go
View File

@ -14,3 +14,17 @@
package enry // import "github.com/go-enry/go-enry/v2" package enry // import "github.com/go-enry/go-enry/v2"
//go:generate make code-generate //go:generate make code-generate
import "github.com/go-enry/go-enry/v2/data"
// Type represent language's type. Either data, programming, markup, prose, or unknown.
type Type int
// Type's values.
const (
Unknown Type = Type(data.TypeUnknown)
Data = Type(data.TypeData)
Programming = Type(data.TypeProgramming)
Markup = Type(data.TypeMarkup)
Prose = Type(data.TypeProse)
)