diff options
| author | Shulhan <ms@kilabit.info> | 2023-12-10 03:05:13 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2023-12-10 03:05:13 +0700 |
| commit | d4129bf1f9ea8fedaf273a50347a0c62b6ec07e0 (patch) | |
| tree | 7541268704b4902aff6b214c4ef109d8f932d4a1 | |
| parent | 582deec99c0028a6759cfc70f2edd05a98547827 (diff) | |
| download | ciigo-d4129bf1f9ea8fedaf273a50347a0c62b6ec07e0.tar.xz | |
all: fix all warnings reported by linter revive
Unfortunately, this breaks some API and exported fields, but its better
than creating revive.toml file to add an exception.
Some breaking changes,
* Field [ConvertOptions.HtmlTemplate] become [ConvertOptions.HTMLTemplate]
* Method [Converter.SetHtmlTemplateFile] become
[Converter.SetHTMLTemplateFile]
* Method [Converter.ToHtmlFile] become [Converter.ToHTMLFile]
| -rw-r--r-- | ciigo.go | 32 | ||||
| -rw-r--r-- | ciigo_test.go | 4 | ||||
| -rw-r--r-- | cmd/ciigo-example/main.go | 4 | ||||
| -rw-r--r-- | cmd/ciigo/main.go | 2 | ||||
| -rw-r--r-- | convert_options.go | 5 | ||||
| -rw-r--r-- | converter.go | 40 | ||||
| -rw-r--r-- | embedded_css.go | 2 | ||||
| -rw-r--r-- | file_markup.go | 4 | ||||
| -rw-r--r-- | filehtml.go | 12 | ||||
| -rw-r--r-- | server.go | 10 | ||||
| -rw-r--r-- | watcher.go | 14 | ||||
| -rw-r--r-- | watcher_test.go | 10 |
12 files changed, 69 insertions, 70 deletions
@@ -37,8 +37,8 @@ var defExcludes = []string{ } // Convert all markup files inside directory "dir" recursively into HTML -// files using ConvertOptions HtmlTemplate file as base template. -// If HtmlTemplate is empty it will default to use embedded HTML template. +// files using ConvertOptions HTMLTemplate file as base template. +// If HTMLTemplate is empty it will default to use embedded HTML template. // See template_index_html.go for template format. func Convert(opts *ConvertOptions) (err error) { var ( @@ -56,7 +56,7 @@ func Convert(opts *ConvertOptions) (err error) { return fmt.Errorf(`%s: %w`, logp, err) } - converter, err = NewConverter(opts.HtmlTemplate) + converter, err = NewConverter(opts.HTMLTemplate) if err != nil { return fmt.Errorf(`%s: %w`, logp, err) } @@ -78,7 +78,7 @@ func Convert(opts *ConvertOptions) (err error) { // recursively, and then embed them into Go file defined by // EmbedOptions.GoFileName. // -// If HtmlTemplate option is empty it default to use embedded HTML +// If HTMLTemplate option is empty it default to use embedded HTML // template. // See template_index_html.go for template format. func GoEmbed(opts *EmbedOptions) (err error) { @@ -100,7 +100,7 @@ func GoEmbed(opts *EmbedOptions) (err error) { return fmt.Errorf(`%s: %w`, logp, err) } - converter, err = NewConverter(opts.HtmlTemplate) + converter, err = NewConverter(opts.HTMLTemplate) if err != nil { return fmt.Errorf(`%s: %w`, logp, err) } @@ -110,7 +110,7 @@ func GoEmbed(opts *EmbedOptions) (err error) { return fmt.Errorf(`%s: %w`, logp, err) } - if isHtmlTemplateNewer(opts) { + if isHTMLTemplateNewer(opts) { convertForce = true } @@ -127,8 +127,8 @@ func GoEmbed(opts *EmbedOptions) (err error) { return fmt.Errorf(`%s: %w`, logp, err) } - if len(opts.HtmlTemplate) > 0 { - _, err = mfs.AddFile(internalTemplatePath, opts.HtmlTemplate) + if len(opts.HTMLTemplate) > 0 { + _, err = mfs.AddFile(internalTemplatePath, opts.HTMLTemplate) if err != nil { return fmt.Errorf(`%s: %w`, logp, err) } @@ -193,7 +193,7 @@ func Watch(opts *ConvertOptions) (err error) { return fmt.Errorf(`%s: %w`, logp, err) } - converter, err = NewConverter(opts.HtmlTemplate) + converter, err = NewConverter(opts.HTMLTemplate) if err != nil { return fmt.Errorf(`%s: %w`, logp, err) } @@ -211,22 +211,22 @@ func Watch(opts *ConvertOptions) (err error) { return nil } -// isHtmlTemplateNewer will return true if HtmlTemplate is not defined or +// isHTMLTemplateNewer will return true if HTMLTemplate is not defined or // newer than embedded GoFileName. -func isHtmlTemplateNewer(opts *EmbedOptions) bool { +func isHTMLTemplateNewer(opts *EmbedOptions) bool { var ( - logp = `isHtmlTemplateNewer` + logp = `isHTMLTemplateNewer` - fiHtmlTmpl fs.FileInfo + fiHTMLTmpl fs.FileInfo fiGoEmbed fs.FileInfo err error ) - if len(opts.HtmlTemplate) == 0 { + if len(opts.HTMLTemplate) == 0 { return true } - fiHtmlTmpl, err = os.Stat(opts.HtmlTemplate) + fiHTMLTmpl, err = os.Stat(opts.HTMLTemplate) if err != nil { log.Fatalf(`%s: %s`, logp, err) } @@ -244,7 +244,7 @@ func isHtmlTemplateNewer(opts *EmbedOptions) bool { log.Fatalf(`%s: %s`, logp, err) } - return fiHtmlTmpl.ModTime().After(fiGoEmbed.ModTime()) + return fiHTMLTmpl.ModTime().After(fiGoEmbed.ModTime()) } // isExtensionMarkup return true if the file extension ext match with one of diff --git a/ciigo_test.go b/ciigo_test.go index 02eb9a2..c72a1b2 100644 --- a/ciigo_test.go +++ b/ciigo_test.go @@ -14,9 +14,9 @@ import ( ) func TestMain(m *testing.M) { - var templateCss = template.CSS(`body{}`) + var templateCSS = template.CSS(`body{}`) - _embeddedCSS = &templateCss + _embeddedCSS = &templateCSS os.Exit(m.Run()) } diff --git a/cmd/ciigo-example/main.go b/cmd/ciigo-example/main.go index b23c4f7..fdac340 100644 --- a/cmd/ciigo-example/main.go +++ b/cmd/ciigo-example/main.go @@ -26,7 +26,7 @@ func main() { opts = &ciigo.ServeOptions{ ConvertOptions: ciigo.ConvertOptions{ Root: "_example", - HtmlTemplate: "_example/html.tmpl", + HTMLTemplate: "_example/html.tmpl", }, Mfs: ciigoFS, Address: ":8080", @@ -55,7 +55,7 @@ func doEmbed() { opts = ciigo.EmbedOptions{ ConvertOptions: ciigo.ConvertOptions{ Root: "_example", - HtmlTemplate: "_example/html.tmpl", + HTMLTemplate: "_example/html.tmpl", }, EmbedOptions: memfs.EmbedOptions{ CommentHeader: `// SPDX-FileCopyrightText: 2019 Shulhan <ms@kilabit.info> diff --git a/cmd/ciigo/main.go b/cmd/ciigo/main.go index 8875fb8..c1c005f 100644 --- a/cmd/ciigo/main.go +++ b/cmd/ciigo/main.go @@ -70,7 +70,7 @@ func main() { command = strings.ToLower(flag.Arg(0)) convertOpts = ciigo.ConvertOptions{ Root: flag.Arg(1), - HtmlTemplate: *htmlTemplate, + HTMLTemplate: *htmlTemplate, Exclude: *exclude, } diff --git a/convert_options.go b/convert_options.go index d8c3cf0..13741ee 100644 --- a/convert_options.go +++ b/convert_options.go @@ -24,11 +24,11 @@ type ConvertOptions struct { // being scanned. Exclude string - // HtmlTemplate the HTML template to be used when converting markup + // HTMLTemplate the HTML template to be used when converting markup // file into HTML. // If empty it will default to use embedded HTML template. // See template_index_html.go for template format. - HtmlTemplate string + HTMLTemplate string excRE []*regexp.Regexp } @@ -53,5 +53,4 @@ func (opts *ConvertOptions) init() (err error) { defExcludes = append(defExcludes, opts.Exclude) } return nil - } diff --git a/converter.go b/converter.go index 2350b5d..da1aa8e 100644 --- a/converter.go +++ b/converter.go @@ -22,7 +22,7 @@ type Converter struct { tmpl *template.Template tmplSearch *template.Template - // htmlTemplateModtime modification time for HtmlTemplate. + // htmlTemplateModtime modification time for HTMLTemplate. htmlTemplateModtime time.Time htmlTemplate string // Path to HTML template in storage. @@ -94,7 +94,7 @@ func (converter *Converter) convertFileMarkups(fileMarkups map[string]*FileMarku for _, fmarkup = range fileMarkups { skip = true if !isForce { - htmlInfo, _ = os.Stat(fmarkup.pathHtml) + htmlInfo, _ = os.Stat(fmarkup.pathHTML) if htmlInfo == nil { // HTML file may not exist. skip = false @@ -111,7 +111,7 @@ func (converter *Converter) convertFileMarkups(fileMarkups map[string]*FileMarku } } - err = converter.ToHtmlFile(fmarkup) + err = converter.ToHTMLFile(fmarkup) if err != nil { log.Printf(`%s: %s`, logp, err) } else { @@ -128,30 +128,30 @@ func (converter *Converter) htmlTemplateUseInternal() (err error) { return nil } -// SetHtmlTemplateFile set the HTML template from file. -func (converter *Converter) SetHtmlTemplateFile(pathHtmlTemplate string) (err error) { - converter.tmpl, err = template.ParseFiles(pathHtmlTemplate) +// SetHTMLTemplateFile set the HTML template from file. +func (converter *Converter) SetHTMLTemplateFile(pathHTMLTemplate string) (err error) { + converter.tmpl, err = template.ParseFiles(pathHTMLTemplate) if err != nil { return err } - converter.htmlTemplate = pathHtmlTemplate + converter.htmlTemplate = pathHTMLTemplate return nil } -// ToHtmlFile convert the AsciiDoc file to HTML. -func (converter *Converter) ToHtmlFile(fmarkup *FileMarkup) (err error) { +// ToHTMLFile convert the AsciiDoc file to HTML. +func (converter *Converter) ToHTMLFile(fmarkup *FileMarkup) (err error) { var ( - logp = `ToHtmlFile` + logp = `ToHTMLFile` - fhtml *fileHtml + fhtml *fileHTML f *os.File ) switch fmarkup.kind { case markupKindAdoc: - fhtml, err = converter.adocToHtml(fmarkup) + fhtml, err = converter.adocToHTML(fmarkup) case markupKindMarkdown: - fhtml, err = converter.markdownToHtml(fmarkup) + fhtml, err = converter.markdownToHTML(fmarkup) } if err != nil { return fmt.Errorf(`%s: %w`, logp, err) @@ -159,7 +159,7 @@ func (converter *Converter) ToHtmlFile(fmarkup *FileMarkup) (err error) { fhtml.Body = template.HTML(fhtml.rawBody.String()) - f, err = os.Create(fmarkup.pathHtml) + f, err = os.Create(fmarkup.pathHTML) if err != nil { return fmt.Errorf(`%s: %w`, logp, err) } @@ -177,9 +177,9 @@ func (converter *Converter) ToHtmlFile(fmarkup *FileMarkup) (err error) { return nil } -func (converter *Converter) adocToHtml(fmarkup *FileMarkup) (fhtml *fileHtml, err error) { +func (converter *Converter) adocToHTML(fmarkup *FileMarkup) (fhtml *fileHTML, err error) { var ( - logp = `adocToHtml` + logp = `adocToHTML` doc *asciidoctor.Document ) @@ -188,7 +188,7 @@ func (converter *Converter) adocToHtml(fmarkup *FileMarkup) (fhtml *fileHtml, er return nil, fmt.Errorf(`%s: %w`, logp, err) } - fhtml = newFileHtml() + fhtml = newFileHTML() err = doc.ToHTMLBody(&fhtml.rawBody) if err != nil { @@ -200,9 +200,9 @@ func (converter *Converter) adocToHtml(fmarkup *FileMarkup) (fhtml *fileHtml, er return fhtml, nil } -func (converter *Converter) markdownToHtml(fmarkup *FileMarkup) (fhtml *fileHtml, err error) { +func (converter *Converter) markdownToHTML(fmarkup *FileMarkup) (fhtml *fileHTML, err error) { var ( - logp = `markdownToHtml` + logp = `markdownToHTML` mdg = goldmark.New( goldmark.WithExtensions( meta.Meta, @@ -218,7 +218,7 @@ func (converter *Converter) markdownToHtml(fmarkup *FileMarkup) (fhtml *fileHtml return nil, fmt.Errorf(`%s: %w`, logp, err) } - fhtml = newFileHtml() + fhtml = newFileHTML() parserCtx = parser.NewContext() err = mdg.Convert(in, &fhtml.rawBody, parser.WithContext(parserCtx)) diff --git a/embedded_css.go b/embedded_css.go index c2ec078..bacbfc1 100644 --- a/embedded_css.go +++ b/embedded_css.go @@ -12,7 +12,7 @@ func embeddedCSS() *template.CSS { return _embeddedCSS } - var css template.CSS = template.CSS(` + var css = template.CSS(` body { margin: 0; font-family: 'Go', Arial, sans-serif; diff --git a/file_markup.go b/file_markup.go index bca9be2..b2d051f 100644 --- a/file_markup.go +++ b/file_markup.go @@ -22,7 +22,7 @@ type FileMarkup struct { basePath string // Full path to file without markup extension. path string // Full path to markup file. - pathHtml string // path to HTML file. + pathHTML string // path to HTML file. kind int } @@ -55,7 +55,7 @@ func NewFileMarkup(filePath string, fi os.FileInfo) (fmarkup *FileMarkup, err er kind: markupKind(ext), } - fmarkup.pathHtml = fmarkup.basePath + `.html` + fmarkup.pathHTML = fmarkup.basePath + `.html` return fmarkup, nil } diff --git a/filehtml.go b/filehtml.go index 235329e..0f69f74 100644 --- a/filehtml.go +++ b/filehtml.go @@ -16,8 +16,8 @@ const ( metadataTitle = `title` ) -// fileHtml represent an HTML metadata for header and its body. -type fileHtml struct { +// fileHTML represent an HTML metadata for header and its body. +type fileHTML struct { Title string EmbeddedCSS *template.CSS Styles []string @@ -27,14 +27,14 @@ type fileHtml struct { rawBody strings.Builder } -func newFileHtml() (fhtml *fileHtml) { - fhtml = &fileHtml{ +func newFileHTML() (fhtml *fileHTML) { + fhtml = &fileHTML{ Metadata: map[string]string{}, } return fhtml } -func (fhtml *fileHtml) unpackAdocMetadata(doc *asciidoctor.Document) { +func (fhtml *fileHTML) unpackAdocMetadata(doc *asciidoctor.Document) { var ( k string v string @@ -61,7 +61,7 @@ func (fhtml *fileHtml) unpackAdocMetadata(doc *asciidoctor.Document) { } } -func (fhtml *fileHtml) unpackMarkdownMetadata(metadata map[string]any) { +func (fhtml *fileHTML) unpackMarkdownMetadata(metadata map[string]any) { var ( key string val any @@ -35,7 +35,7 @@ func newServer(opts *ServeOptions) (srv *server, err error) { httpdOpts *libhttp.ServerOptions epInSearch *libhttp.Endpoint - pathHtmlTemplate string + pathHTMLTemplate string ) if opts.Mfs == nil { @@ -78,10 +78,10 @@ func newServer(opts *ServeOptions) (srv *server, err error) { } if opts.IsDevelopment { - pathHtmlTemplate = opts.HtmlTemplate + pathHTMLTemplate = opts.HTMLTemplate } - srv.converter, err = NewConverter(pathHtmlTemplate) + srv.converter, err = NewConverter(pathHTMLTemplate) if err != nil { return nil, fmt.Errorf(`%s: %w`, logp, err) } @@ -140,7 +140,7 @@ func (srv *server) onSearch(epr *libhttp.EndpointRequest) (resBody []byte, err e var ( logp = `onSearch` - fhtml *fileHtml + fhtml *fileHTML buf bytes.Buffer q string results []memfs.SearchResult @@ -154,7 +154,7 @@ func (srv *server) onSearch(epr *libhttp.EndpointRequest) (resBody []byte, err e return nil, fmt.Errorf(`%s: %w`, logp, err) } - fhtml = &fileHtml{ + fhtml = &fileHTML{ Body: template.HTML(buf.String()), } @@ -40,7 +40,7 @@ type watcher struct { // | // +-- watchFileMarkup --> UPDATE --> Converter.convertFileMarkups() // | -// +-- watchHtmlTemplate +--> DELETE --> Converter.htmlTemplateUseInternal() +// +-- watchHTMLTemplate +--> DELETE --> Converter.htmlTemplateUseInternal() // | // +--> UPDATE --> Converter.convertFileMarkups() func newWatcher(converter *Converter, convertOpts *ConvertOptions) (w *watcher, err error) { @@ -95,7 +95,7 @@ func (w *watcher) start() (err error) { if err != nil { return fmt.Errorf(`start: %w`, err) } - go w.watchHtmlTemplate() + go w.watchHTMLTemplate() } return nil } @@ -166,7 +166,7 @@ func (w *watcher) watchFileMarkup() { } } - err = w.converter.ToHtmlFile(fmarkup) + err = w.converter.ToHTMLFile(fmarkup) if err != nil { log.Printf(`%s: %s`, logp, err) } @@ -175,11 +175,11 @@ func (w *watcher) watchFileMarkup() { } } -// watchHtmlTemplate reload the HTML template and re-convert all markup +// watchHTMLTemplate reload the HTML template and re-convert all markup // files. -func (w *watcher) watchHtmlTemplate() { +func (w *watcher) watchHTMLTemplate() { var ( - logp = `watchHtmlTemplate` + logp = `watchHTMLTemplate` ns memfs.NodeState err error @@ -192,7 +192,7 @@ func (w *watcher) watchHtmlTemplate() { err = w.converter.htmlTemplateUseInternal() } else { log.Printf(`%s: recompiling HTML template %q ...`, logp, ns.Node.SysPath) - err = w.converter.SetHtmlTemplateFile(w.converter.htmlTemplate) + err = w.converter.SetHTMLTemplateFile(w.converter.htmlTemplate) } if err != nil { log.Printf(`%s: %s`, logp, err) diff --git a/watcher_test.go b/watcher_test.go index 7aa7d22..7937973 100644 --- a/watcher_test.go +++ b/watcher_test.go @@ -84,7 +84,7 @@ func TestWatcher(t *testing.T) { func testAdocCreate(t *testing.T, testWatcher *watcher, tdata *test.Data, pathFile string) { var ( - expBody []byte = tdata.Input[`create.adoc`] + expBody = tdata.Input[`create.adoc`] got *FileMarkup err error @@ -104,7 +104,7 @@ func testAdocCreate(t *testing.T, testWatcher *watcher, tdata *test.Data, pathFi test.Assert(t, `New adoc file created`, pathFile, got.path) - gotBody, err = os.ReadFile(got.pathHtml) + gotBody, err = os.ReadFile(got.pathHTML) if err != nil { t.Fatal(err) } @@ -137,7 +137,7 @@ func testAdocUpdate(t *testing.T, testWatcher *watcher, tdata *test.Data, pathFi test.Assert(t, `adoc file updated`, pathFile, got.path) - gotBody, err = os.ReadFile(got.pathHtml) + gotBody, err = os.ReadFile(got.pathHTML) if err != nil { t.Fatal(err) } @@ -191,7 +191,7 @@ func testMarkdownCreate(t *testing.T, testWatcher *watcher, tdata *test.Data, pa test.Assert(t, `New md file created`, pathFileMarkdown, got.path) - gotBody, err = os.ReadFile(got.pathHtml) + gotBody, err = os.ReadFile(got.pathHTML) if err != nil { t.Fatal(err) } @@ -224,7 +224,7 @@ func testMarkdownUpdate(t *testing.T, testWatcher *watcher, tdata *test.Data, pa test.Assert(t, `changes path`, pathFileMarkdown, got.path) - gotBody, err = os.ReadFile(got.pathHtml) + gotBody, err = os.ReadFile(got.pathHTML) if err != nil { t.Fatal(err) } |
