Skip to content

Latest commit

 

History

History
188 lines (129 loc) · 6.76 KB

CHANGELOG.md

File metadata and controls

188 lines (129 loc) · 6.76 KB
Raw

Changelog

v1.3.1

  • add --quiet and --no-backup CLI options

v1.3.0

  • Duplicate checking now checks whole title rather than just the first 50 characters.

v1.3.1

  • #12 Added --quiet and --no-backup

v1.4.0

  • #13 Allow multiple files on CLI. This will output multiple tidied files (ie this does not combine them) e.g. bibtex-tidy file1.bib file2.bib
  • #14 Add .pre-commit-hooks.yaml
  • #15 Add option for trailing commas
  • #16 Option to remove empty fields
  • Add --no-lowercase option to prevent bibtex-tidy from changing case of field names and entry types

v1.4.1

No changes, aside from correcting version number at top of bibtex-tidy.js

v1.4.2

  • #17 Restore --help option
  • Support for older browsers and node versions

v1.5.0

  • Breaking change: paragraphs within field values will now be preserved
  • #18 --enclosing-braces option added to preserve case when compiling BibTeX
  • #19 --wrap option added for wrapping long values

v1.6.0

  • #20 added --max-authors option for truncating long list of authors

v1.6.1

  • Improve CLI help text for --max-authors

v1.7.0

  • #23 #28 Prevent adding enclosing brace on each tidy
  • --remove-dupe-fields / removeDuplicateFields option added
  • Better generation of CLI command in Web UI
  • Improved man page
  • Handle CRLF/CR line endings
  • Handle empty entry key
  • Handling empty entries

v1.7.1

  • Add --version CLI option

v1.8.0

  • Better handling of invalid CLI params
  • New higher performance bibtex parser
  • Better handling of comments
  • #38 Fix "-" in input args not being interpreted as stdin
  • #41 Set minimum node 12
  • #51 Remove invalid windows filename chars
  • #47 Fix parsing for concatenate after literal
  • Retain whitespace in quoted values
  • #47 Do not trim braced values if concatenated
  • #32 Sort month and numeric values
  • #27 Do not escape math expressions
  • #44 Option to generate standardised keys

v1.8.1

No changes, aside from correcting version number at top of bibtex-tidy.js

v1.8.2

Add type definitions

v1.8.3

No changes, aside from correcting version number at top of bibtex-tidy.js

v1.8.4

Remove npm prepare script

v1.8.5

  • New release process, including tagging releases (#75)

v1.9.0

Features:

  • Bibtex keys can now be generated according to a JabRef template, such as [auth:lower][year]. See https://docs.jabref.org/setup/citationkeypatterns. Currently bibtex-tidy only supports a few markers and modifiers (see generateKeys.ts) (#179)
  • Add --blank-lines option to separate entries with a blank line (#245)
  • Docker configuration added (#371)
  • The web UI will now persist the user's bibtex-tidy configuration in the URL (#344)
  • The web UI has a new look and feel based on material v3. This includes larger text, more space between interactive elements, higher contrast colours, and better consistency across browsers and OS's.
  • Add copy button to web UI (#177)
  • Add removeBraces to remove all braces from specified fields (#33)

Bug fixes:

  • Convert invalid key characters to _ when generating keys (#304)
  • More permitted characters in citation key, including parentheses, which were triggering a parser error (#358).
  • Support escaping quotes in quoted value, which were triggering a parser error (#98)
  • Fix extra empty line when wrapping long word (#141)
  • Fix bug where enclosing-braces would destroy commands (#127)

Other enhancements:

  • Support removing ALLCAPS while keeping volume fields as they are (#49)
  • UI rewritten in Svelte. This shouldn't change end user experience but will make maintenance much easier.
  • Entries with similar author and title will not be marked as duplicates if the number field is different (#364).
  • DUPLICATE_ENTRY now has a 'rule' property (can be key, doi, citation, or abstract). Note: This includes the removal of DUPLICATE_KEY warning. Look for DUPLICATE_ENTRY with rule: "key " instead.
  • Make duplicate key check case insensitive to match bibtex implementation

v1.10.0

Preview CLI changes: bibtex-tidy v2 will introduce a breaking change to the CLI to enable working with stdio and prevent inadvertently overwriting files. This change can be enabled now by providing the --v2 option.

In v2, input files will no longer be modified by default. Instead, you will need to specify --modify/-m option to overwrite the file, or --output/-o to output to a different file.

If an input or output file is not provided, bibtex-tidy will read the standard input or write to standard output, respectively. The following are all equivalent:

  • bibtex file1.bib -o file2.bib
  • bibtex file1.bib > file2.bib
  • bibtex < file1.bib > file2.bib
  • cat file1.bib | bibtex | tee file2.bib

See the table below for how v2 compares to v1:

Description v1 v2 (use --v2 for now)
Tidy and overwrite a file bibtex file.bib bibtex file.bib -m
Tidy and output to a different file cat file1.bib | bibtex - > file2.bib bibtex file1.bib -o file2.bib
Tidy stdin and output to file foo | bibtex - > file.bib foo | bibtex -o file.bib
Tidy file and output to stdout cat file.bib | bibtex - | bar bibtex file.bib | bar
Tidy stdin and output to stdout foo | bibtex - | bar foo | bibtex | bar

Providing multiple input files will only work in --modify/-m mode.

v1.10.1

  • Fix options parsing when reading stdin

v1.11.0

  • Fix latex parser not escaping command mode on whitespace (#406)
  • Allow sorting by 'special' entry type (#405)
  • Added option to convert all months to three letter abbreviations (#351)
  • Update node version in docker container ot prevent build error
  • Fix --sort-fields CLI command in web UI (#404)

v1.12.0

  • Fix double braces adding closing braces (#410)
  • Upgrade dependencies
  • Accessibility tweaks

v1.13.0

  • Parse authors when checking entry similarity (#424)
  • Fix font encoding
  • Release v1.12.0
  • Linting
  • Add fonts to repo instead of downloading on each build
  • Prettier
  • Fix double braces adding closing braces (#410)
  • Upgrade dependencies
  • upgrade ts & build
  • Upgrade deps
  • Accessibility tweak
  • Upgrade dependencies

v1.14

  • Support filenames with spaces (#416, #428)
  • Do not flatten braces which contain commands (#407, #423)
  • Do not encode special characters in verbatim fields like url (#415)
  • Pre-commit hook changed to script so that dev dependencies are not required (#427)
  • Fix math escaping (#430)
  • Upgrade dependencies