mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
c8ce65046d
helpers/general.go:448:1: comment on exported function DiffStrings should be of the form "DiffStrings ..." helpers/hugo.go:42:6: exported type HugoVersionString should have comment or be unexported helpers/hugo.go:48:1: exported method HugoVersion.Version should have comment or be unexported helpers/hugo.go:56:1: comment on exported method HugoVersionString.Compare should be of the form "Compare ..." helpers/hugo.go:62:1: comment on exported method HugoVersionString.Eq should be of the form "Eq ..." helpers/path.go:548:1: comment on exported function OpenFilesForWriting should be of the form "OpenFilesForWriting ..." helpers/processing_stats.go:24:6: exported type ProcessingStats should have comment or be unexported helpers/processing_stats.go:55:1: exported function NewProcessingStats should have comment or be unexported helpers/processing_stats.go:59:1: exported method ProcessingStats.Incr should have comment or be unexported helpers/processing_stats.go:63:1: exported method ProcessingStats.Add should have comment or be unexported helpers/processing_stats.go:67:1: exported method ProcessingStats.Table should have comment or be unexported helpers/processing_stats.go:83:1: exported function ProcessingStatsTable should have comment or be unexported
123 lines
2.9 KiB
Go
123 lines
2.9 KiB
Go
// Copyright 2017 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed 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 helpers
|
|
|
|
import (
|
|
"io"
|
|
"strconv"
|
|
"sync/atomic"
|
|
|
|
"github.com/olekukonko/tablewriter"
|
|
)
|
|
|
|
// ProcessingStats represents statistics about a site build.
|
|
type ProcessingStats struct {
|
|
Name string
|
|
|
|
Pages uint64
|
|
PaginatorPages uint64
|
|
Static uint64
|
|
ProcessedImages uint64
|
|
Files uint64
|
|
Aliases uint64
|
|
Sitemaps uint64
|
|
Cleaned uint64
|
|
}
|
|
|
|
type processingStatsTitleVal struct {
|
|
name string
|
|
val uint64
|
|
}
|
|
|
|
func (s *ProcessingStats) toVals() []processingStatsTitleVal {
|
|
return []processingStatsTitleVal{
|
|
{"Pages", s.Pages},
|
|
{"Paginator pages", s.PaginatorPages},
|
|
{"Non-page files", s.Files},
|
|
{"Static files", s.Static},
|
|
{"Processed images", s.ProcessedImages},
|
|
{"Aliases", s.Aliases},
|
|
{"Sitemaps", s.Sitemaps},
|
|
{"Cleaned", s.Cleaned},
|
|
}
|
|
}
|
|
|
|
// NewProcessingStats returns a new ProcessingStats instance.
|
|
func NewProcessingStats(name string) *ProcessingStats {
|
|
return &ProcessingStats{Name: name}
|
|
}
|
|
|
|
// Incr increments a given counter.
|
|
func (s *ProcessingStats) Incr(counter *uint64) {
|
|
atomic.AddUint64(counter, 1)
|
|
}
|
|
|
|
// Add adds an amount to a given counter.
|
|
func (s *ProcessingStats) Add(counter *uint64, amount int) {
|
|
atomic.AddUint64(counter, uint64(amount))
|
|
}
|
|
|
|
// Table writes a table-formatted representation of the stats in a
|
|
// ProcessingStats instance to w.
|
|
func (s *ProcessingStats) Table(w io.Writer) {
|
|
titleVals := s.toVals()
|
|
data := make([][]string, len(titleVals))
|
|
for i, tv := range titleVals {
|
|
data[i] = []string{tv.name, strconv.Itoa(int(tv.val))}
|
|
}
|
|
|
|
table := tablewriter.NewWriter(w)
|
|
|
|
table.AppendBulk(data)
|
|
table.SetHeader([]string{"", s.Name})
|
|
table.SetBorder(false)
|
|
table.Render()
|
|
|
|
}
|
|
|
|
// ProcessingStatsTable writes a table-formatted representation of stats to w.
|
|
func ProcessingStatsTable(w io.Writer, stats ...*ProcessingStats) {
|
|
names := make([]string, len(stats)+1)
|
|
|
|
var data [][]string
|
|
|
|
for i := 0; i < len(stats); i++ {
|
|
stat := stats[i]
|
|
names[i+1] = stat.Name
|
|
|
|
titleVals := stat.toVals()
|
|
|
|
if i == 0 {
|
|
data = make([][]string, len(titleVals))
|
|
}
|
|
|
|
for j, tv := range titleVals {
|
|
if i == 0 {
|
|
data[j] = []string{tv.name, strconv.Itoa(int(tv.val))}
|
|
} else {
|
|
data[j] = append(data[j], strconv.Itoa(int(tv.val)))
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
table := tablewriter.NewWriter(w)
|
|
|
|
table.AppendBulk(data)
|
|
table.SetHeader(names)
|
|
table.SetBorder(false)
|
|
table.Render()
|
|
|
|
}
|