Merge pull request #28 from nickng/nickng-prettyprint-keyorder

Add support to specify key order in prettybib in config file

Author: nickng

.github/workflows/test.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.16.x, 1.17.x]
+        go-version: [1.22.x]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:

cmd/prettybib/filter.toml

@@ -1,8 +1,9 @@
 # Default filter config
 
 [bibtype.inproceedings]
-required = [ "author", "booktitle", "title", "year", "publisher", "series", "volume" ]
-remove   = [ "address", "doi", "editor", "file", "isbn", "url" ]
+required     = [ "author", "booktitle", "title", "year", "publisher", "series", "volume" ]
+remove       = [ "address", "doi", "editor", "file", "isbn", "url" ]
+fields_order = ["year", "author", "title"]
 
 [bibtype.article]
 required = [ "author", "journal", "title", "year" ]

cmd/prettybib/main.go

@@ -4,6 +4,7 @@ package main
 import (
 	"flag"
 	"fmt"
+	"io"
 	"log"
 	"os"
 
@@ -23,8 +24,9 @@ var (
 // Config holds a configuration for filtering rules.
 type Config struct {
 	BibType map[string]struct {
-		Required []string
-		Remove   []string
+		Required    []string
+		Remove      []string
+		FieldsOrder []string `toml:"fields_order"`
 	}
 }
 
@@ -55,14 +57,18 @@ func main() {
 	if err != nil {
 		log.Fatal(err)
 	}
+	keyOrderByType := make(map[string][]string)
 	if *config != "" {
 		var conf Config
 		if _, err := toml.DecodeFile(*config, &conf); err != nil {
 			log.Fatalf("Cannot read config: %s", err)
 		}
 		filter(parsed, &conf)
+		for name, bt := range conf.BibType {
+			keyOrderByType[name] = bt.FieldsOrder
+		}
 	}
-	fmt.Fprintf(writer, parsed.PrettyString())
+	prettyPrintOverridingOrder(writer, parsed, keyOrderByType)
 }
 
 func filter(bib *bibtex.BibTex, conf *Config) {
@@ -81,3 +87,13 @@ func filter(bib *bibtex.BibTex, conf *Config) {
 		}
 	}
 }
+
+func prettyPrintOverridingOrder(w io.Writer, parsed *bibtex.BibTex, keyOrderByType map[string][]string) {
+	for _, entry := range parsed.Entries {
+		var opts []bibtex.PrettyStringOpt
+		if order, specified := keyOrderByType[entry.Type]; specified {
+			opts = append(opts, bibtex.WithKeyOrder(order))
+		}
+		fmt.Fprintf(w, entry.PrettyString(opts...))
+	}
+}

go.mod

@@ -1,5 +1,5 @@
 module github.com/nickng/bibtex
 
-go 1.18
+go 1.22
 
 require github.com/BurntSushi/toml v0.3.1