ralsina/tartrazine
1
0
Fork 0
mirror of https://github.com/ralsina/tartrazine.git synced 2025-06-18 22:23:07 -03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add documentation to LanguageInfo struct fields

Browse Source 
These are adapted from https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
This commit is contained in:
Luke Francl
2021-10-12 16:13:59 -07:00
parent 6212f1fcb4
commit b6b72c6c08
2 changed files with 58 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
data/languageInfo.go
View File

@ -6,20 +6,35 @@ package data
// LanguageInfo exposes the data for a language's Linguist YAML entry as a Go struct. // LanguageInfo exposes the data for a language's Linguist YAML entry as a Go struct.
// See https://github.com/github/linguist/blob/master/lib/linguist/languages.yml // See https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
type LanguageInfo struct { type LanguageInfo struct {
// Name is the language name. May contain symbols not safe for use in some filesystems (e.g., `F*`).
Name string Name string
// FSName is the filesystem safe name. Will only be set if Name is not safe for use in all filesystems.
FSName string FSName string
// Type is the language Type. See data.Type for values.
Type Type Type Type
// Color is the CSS hex color to represent the language. Only used if type is "programming" or "markup".
Color string Color string
// Group is the name of the parent language. Languages in a group are counted in the statistics as the parent language.
Group string Group string
// Aliases is a slice of additional aliases (implicitly includes name.downcase)
Aliases []string Aliases []string
// Extensions is a slice of associated extensions (the first one is considered the primary extension).
Extensions []string Extensions []string
// A slice of associated interpreters
Interpreters []string Interpreters []string
// Filenames is a slice of filenames commonly associated with the language.
Filenames []string Filenames []string
// MimeType (maps to codemirror_mime_type in linguist.yaml) is the string name of the file mime type used for highlighting whenever a file is edited.
MimeType string MimeType string
// TMScope is the TextMate scope that represents this programming language.
TMScope string TMScope string
// AceMode is the name of the Ace Mode used for highlighting whenever a file is edited.
AceMode string AceMode string
// CodemirrorMode is the name of the CodeMirror Mode used for highlighting whenever a file is edited.
CodemirrorMode string CodemirrorMode string
// Wrap is a boolean flag to enable line wrapping in an editor.
Wrap bool Wrap bool
// LanguageID is the Linguist-assigned numeric ID for the language.
LanguageID int LanguageID int
} }

15
internal/code-generator/assets/languageInfo.go.tmpl
View File

@ -3,20 +3,35 @@ package data
// LanguageInfo exposes the data for a language's Linguist YAML entry as a Go struct. // LanguageInfo exposes the data for a language's Linguist YAML entry as a Go struct.
// See https://github.com/github/linguist/blob/master/lib/linguist/languages.yml // See https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
type LanguageInfo struct { type LanguageInfo struct {
// Name is the language name. May contain symbols not safe for use in some filesystems (e.g., `F*`).
Name string Name string
// FSName is the filesystem safe name. Will only be set if Name is not safe for use in all filesystems.
FSName string FSName string
// Type is the language Type. See data.Type for values.
Type Type Type Type
// Color is the CSS hex color to represent the language. Only used if type is "programming" or "markup".
Color string Color string
// Group is the name of the parent language. Languages in a group are counted in the statistics as the parent language.
Group string Group string
// Aliases is a slice of additional aliases (implicitly includes name.downcase)
Aliases []string Aliases []string
// Extensions is a slice of associated extensions (the first one is considered the primary extension).
Extensions []string Extensions []string
// A slice of associated interpreters
Interpreters []string Interpreters []string
// Filenames is a slice of filenames commonly associated with the language.
Filenames []string Filenames []string
// MimeType (maps to codemirror_mime_type in linguist.yaml) is the string name of the file mime type used for highlighting whenever a file is edited.
MimeType string MimeType string
// TMScope is the TextMate scope that represents this programming language.
TMScope string TMScope string
// AceMode is the name of the Ace Mode used for highlighting whenever a file is edited.
AceMode string AceMode string
// CodemirrorMode is the name of the CodeMirror Mode used for highlighting whenever a file is edited.
CodemirrorMode string CodemirrorMode string
// Wrap is a boolean flag to enable line wrapping in an editor.
Wrap bool Wrap bool
// LanguageID is the Linguist-assigned numeric ID for the language.
LanguageID int LanguageID int
} }