lynnesbian/fif
2
1
Fork 0
Code Releases Activity

changelog "refactor"

Browse source
This commit is contained in:
Lynne Megido 2021-09-23 00:49:27 +10:00
parent 30c7da077a
commit 4a54511833
Signed by: lynnesbian
GPG key ID: F0A184B5213D9F90
1 changed files with 114 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

205
CHANGELOG.md
View file

@ -1,113 +1,124 @@
# Changelog # Changelog
Dates are given in YYYY-MM-DD format. Dates are given in YYYY-MM-DD format - for example, the 15th of October 2021 is written as 2021-10-15.
## v0.3 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
### v0.3.7 (2021-MM-DD) [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
#### Other
## Unreleased
### Other
- Refactoring - split fif into main.rs and lib.rs, moved file-related functionality (directory scanning, etc.) into - Refactoring - split fif into main.rs and lib.rs, moved file-related functionality (directory scanning, etc.) into
files module, removed string module, etc. files module, removed string module, etc.
- Changelog "refactoring":
- Based on the somewhat popular [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) guide, splitting the previous
"Features" heading into "Added" and "Changed" sections, renaming "Bugfixes" to "Fixed", and removing the
headings that (pointlessly?) previously divided the changelog into v0.3, v0.2, and v0.1
- A few minor grammar tweaks and reorganisations
### v0.3.6 (2021-08-16) ## v0.3.6 - 2021-08-16
#### Other ### Other
- Fixed another major dependency issue - [`clap`] version 3 beta 2 pulls in `clap_derive` version 3 beta **4**, causing - Fixed another major dependency issue - [`clap`] version 3 beta **2** pulls in `clap_derive` version 3 beta **4**,
fif to fail to build unless you use `--locked`. `Cargo.toml` now explicitly depends on `clap_derive` v3b2, which should causing fif to fail to build unless you use `--locked`. `Cargo.toml` now explicitly depends on `clap_derive` v3b2,
fix this in (hopefully) all cases... which should fix this in (hopefully) all cases...
- Added an explicit dependency on `bitflags` 1.2.1, as 1.3+ requires Rust >= 1.46 - Added an explicit dependency on `bitflags` 1.2.1, as 1.3+ requires Rust >= 1.46
### v0.3.5 (2021-08-16) [YANKED] ## v0.3.5 - 2021-08-16 [YANKED]
#### Other ### Other
- Updated `Cargo.toml` to pin [`clap`] to version 3 beta 2 - previously, version 3 beta 4 was considered compatible and - Updated `Cargo.toml` to pin [`clap`] to version 3 beta 2 - previously, version 3 beta 4 was considered compatible and
would be used if you ran `cargo install fif` instead of `cargo install --locked fif`, however, fif does *not* work with would be used if you ran `cargo install fif` instead of `cargo install --locked fif`, however, fif does *not* work with
this version of `clap`, which caused the build to fail. Also, `clap` 3 beta 4 depends on Rust >= 1.54, breaking our MSRV this version of `clap`, which caused the build to fail. Also, `clap` 3 beta 4 depends on Rust >= 1.54, breaking our MSRV
- Fixed a few other `Cargo.toml` dependency versions that were causing issues when building on MSRV - Fixed a few other `Cargo.toml` dependency versions that were causing issues when building on MSRV
### v0.3.4 (2021-08-07) ## v0.3.4 - 2021-08-07
#### Features ### Added
- Added `-I`/`--ignore-unknown-exts` flag for ignoring files with unknown extensions - for example, if fif doesn't know - `-I`/`--ignore-unknown-exts` flag for ignoring files with unknown extensions - for example, if fif doesn't know
what a ".fake" file is, setting this flag will prevent it from renaming "photo.fake" to "photo.jpg". This is useful what a ".fake" file is, setting this flag will prevent it from renaming "photo.fake" to "photo.jpg". This is useful
for avoiding the case where fif incorrectly mislabels an obscure format it isn't aware of as something else. for avoiding the case where fif incorrectly mislabels an obscure format it isn't aware of as something else.
#### Other ### Other
- Refactored `formats.rs` - Refactored `formats.rs`
- More accurate dependency versions in `Cargo.toml` to ensure that the MSRV stays supported - More accurate dependency versions in `Cargo.toml` to ensure that the MSRV stays supported
- Sister project (?) [`new-mime-guess`] is now v3.0.0, updated to 2018 edition Rust, and with some new file and MIME - Sister project (?) [`new-mime-guess`] is now v3.0.0, updated to 2018 edition Rust, and with some new file and MIME
types added types added
### v0.3.3 (2021-07-07) ## v0.3.3 - 2021-07-07
#### Features ### Added
- Added `--canonical-paths` flag for outputting canonical paths in output - for example, - `--canonical-paths` flag for outputting canonical paths in output - for example,
`mv /home/lynne/file.jpg /home/lynne/file.mp3` instead of the default `mv file.jpg file.mp3` `mv /home/lynne/file.jpg /home/lynne/file.mp3` instead of the default `mv file.jpg file.mp3`
#### Other ### Other
- The `FIF_LOG` environment variable can now be used to set log level, in addition to `RUST_LOG` - The `FIF_LOG` environment variable can now be used to set log level, in addition to `RUST_LOG`
- Log output now uses abbreviated level names: For example, `[D] Message` instead of `[DEBUG] Message` - Log output now uses abbreviated level names: For example, `[D] Message` instead of `[DEBUG] Message`
### v0.3.2 (2021-06-14) ## v0.3.2 - 2021-06-14
#### Bugfixes ### Changed
- Fixed PowerShell output regression introduced in v0.2.13, whoops
#### Other
- Nicer version output: `fif -V` reports "fif v0.3.2" (instead of just "fif 0.3.2" without the "v"), and `fif --version` - Nicer version output: `fif -V` reports "fif v0.3.2" (instead of just "fif 0.3.2" without the "v"), and `fif --version`
reports `fif v0.3.2 (XDG-Mime backend)`, or whatever backend you're using reports `fif v0.3.2 (XDG-Mime backend)`, or whatever backend you're using
- fif's trace output now includes its version, backend, operating system, and architecture - fif's trace output now includes its version, backend, operating system, and architecture
### Fixed
- Fixed PowerShell output regression introduced in v0.2.13, whoops
### Other
- Block compilation if both the `xdg-mime-backend` and `infer-backend` - Block compilation if both the `xdg-mime-backend` and `infer-backend`
[features](https://gitlab.com/Lynnesbian/fif/-/wikis/Cargo-Features) are enabled [features](https://gitlab.com/Lynnesbian/fif/-/wikis/Cargo-Features) are enabled
### v0.3.1 (2021-06-07) ## v0.3.1 - 2021-06-07
#### Features ### Added
- Added JSON output support via `-o json` - JSON output support via `-o json`
- Added plaintext output support via `-o text` - Plaintext output support via `-o text`
#### Other ### Changed
- `videos` is now an alias for `video` - `videos` is now an alias for `video`
### Other
- More extensive README documentation - More extensive README documentation
### v0.3.0 (2021-04-28) ## v0.3.0 - 2021-04-28
#### Features ### Added
- Added `-x`/`--exclude` flag for excluding file extensions (overrides `-e` or `-E` - `-E images -x jpg` scans all image - `-x`/`--exclude` flag for excluding file extensions (overrides `-e` or `-E` - `-E images -x jpg` scans all image
files, except ".jpg" files) files, except ".jpg" files)
- Added `-X`/`--exclude-set` flag for excluding sets of files, with the same syntax and sets as `-E` - `-X`/`--exclude-set` flag for excluding sets of files, with the same syntax and sets as `-E`
- `-q`/`--quiet` flag for reducing output verbosity
### Changed
- The `videos` extension set has been renamed to `video`, in line with `audio`. `fif --help` has actually mistakenly
referred to the set as `video` since v0.2.12! 0uo
- In addition to supplying included extensions as a comma separated list (like `-e jpg,png`), it is now possible to - In addition to supplying included extensions as a comma separated list (like `-e jpg,png`), it is now possible to
supply them through multiple uses of the `-e` flag (like `-e jpg -e png`). This also applies to `-x` supply them through multiple uses of the `-e` flag (like `-e jpg -e png`). This also applies to `-x`
- `-e` and `-E` no longer conflict with each other, and can now be used together. For example, `-E images -e mp3` - `-e` and `-E` no longer conflict with each other, and can now be used together. For example, `-E images -e mp3`
will scan all images *and* all MP3 files will scan all images *and* all MP3 files
- It is now possible to specify multiple extension sets at once: `-E images,system` will scan all images and archives - It is now possible to specify multiple extension sets at once: `-E images,system` will scan all images and archives
- fif's output now includes the directory it was run from - fif's output now includes the directory it was run from
- Added `-q`/`--quiet` flag for reducing output verbosity - Changed default verbosity to `info`
#### Bugfixes ### Fixed
- Resolved some discrepancies between `application/xml` and `text/xml` - Resolved some discrepancies between `application/xml` and `text/xml`
#### Other ### Other
- Published my fork of ['mime_guess'] as ['new_mime_guess'], allowing it to be used properly with - Published my fork of ['mime_guess'] as ['new_mime_guess'], allowing it to be used properly with
[crates.io](https://crates.io) [crates.io](https://crates.io)
- The `videos` extension set has been renamed to `video`, in line with `audio`. `fif --help` has actually mistakenly
referred to the set as `video` since v0.2.12! 0uo
- CI has been vastly improved - CI has been vastly improved
- Changed default verbosity to `info`
## v0.2 ## v0.2
### v0.2.13 (2021-04-26) ### v0.2.13 (2021-04-26)
#### Features ### Added
- Added `-v`/`--verbose` flag for setting verbosity without using `RUST_LOG` - `-v`/`--verbose` flag for setting verbosity without using `RUST_LOG`
- Added system extension set (`.dll`, `.so`, `.exe`...) - System extension set (`.dll`, `.so`, `.exe`...)
- [`infer`] backend now supports Ren'Py archive (`.rpa`) files
### Changed
- Output is now sorted: Files that couldn't be read, then files with no known mimetype, then files with no known - Output is now sorted: Files that couldn't be read, then files with no known mimetype, then files with no known
extensions, then files with the wrong extension extensions, then files with the wrong extension
#### Bugfixes - Added Apple iWork document formats to Documents extension set (`.pages`, `.key`, `.numbers`)
### Fixed
- Fixed some bad formatting in PowerShell output - Fixed some bad formatting in PowerShell output
- Always quote file paths in output, even when not necessary - This makes output more portable and less likely to break - Always quote file paths in output, even when not necessary - This makes output more portable and less likely to break
in future, or if [`snailquote`] misses something in future, or if [`snailquote`] misses something
#### Other ### Other
- Added Apple iWork document formats to documents extension set
- Cleaned up and properly documented tests - Cleaned up and properly documented tests
- Renamed `Script` (in `formats.rs`) to `Shell`, in line with renaming in `parameters.rs` - Renamed `Script` (in `formats.rs`) to `Shell`, in line with renaming in `parameters.rs`
- Added .rpa (Ren'Py archive) support to infer backend
- [`xdg-mime`] no longer uses git version - [`xdg-mime`] no longer uses git version
- Output `\r\n` on Windows - Output `\r\n` on Windows
- Use a macro to generate `Writable` arrays, making the code a little cleaner and nicer to write - Use a macro to generate `Writable` arrays, making the code a little cleaner and nicer to write
### v0.2.12 (2021-04-14) ### v0.2.12 (2021-04-14)
#### Features ### Added
- Added Text extension set - Text extension set
- Better documentation for command line arguments - Better documentation for command line arguments
#### Bugfixes ### Fixed
- Fixed a very minor output bug relating to scanning symlinked directories - Fixed a very minor output bug relating to scanning symlinked directories
- Better detection for pre-OOXML Office files - Better detection for pre-OOXML Office files
#### Other ### Other
- Much better README.md - Much better README.md
- Added more stuff to test.py - Added more stuff to test.py
- PKGBUILD for Arch-based distros - PKGBUILD for Arch-based distros
@ -115,103 +126,115 @@ this version of `clap`, which caused the build to fail. Also, `clap` 3 beta 4 de
- Doubled BUF_SIZE - Doubled BUF_SIZE
### v0.2.11 (2021-04-04) ### v0.2.11 (2021-04-04)
#### Features ### Added
- fif can now traverse symlinks with the `-f`/`--follow-symlinks` flag - fif can now traverse symlinks with the `-f`/`--follow-symlinks` flag
### Changed
- Better mime type detection:
- Consider "some/x-thing" and "some/thing" to be identical
- Use a patched version of mime_guess (which took a while to make 0u0;) with many more extension/type mappings
- Extensions are no longer mandatory - running fif without `-e` or `-E` will scan all files, regardless of extension - Extensions are no longer mandatory - running fif without `-e` or `-E` will scan all files, regardless of extension
(files without extensions are still skipped unless the -S flag is used) (files without extensions are still skipped unless the -S flag is used)
#### Bugfixes ### Fixed
- Fixed compilation on big endian 32-bit architectures (see - Fixed compilation on big endian 32-bit architectures (see
[here](https://github.com/bodil/smartstring/blob/v0.2.7/src/config.rs#L102-L104) for why that was a problem in the [here](https://github.com/bodil/smartstring/blob/v0.2.7/src/config.rs#L102-L104) for why that was a problem in the
first place) first place)
- Fixed broken tests for the [`infer`] backend - Fixed broken tests for the [`infer`] backend
#### Other
- Better mime type detection:
- Consider "some/x-thing" and "some/thing" to be identical
- Use a patched version of mime_guess (which took a while to make 0u0;) with many more extension/type mappings
### v0.2.10 (2021-03-26) ### v0.2.10 (2021-03-26)
### Added
- PowerShell support! - PowerShell support!
### v0.2.9 (2021-03-17) ## v0.2.9 - 2021-03-17
### Other
- Replaced a bunch of `PathBuf`s with `Path`s, which should reduce memory usage - Replaced a bunch of `PathBuf`s with `Path`s, which should reduce memory usage
- Formatting improvements - Formatting improvements
### v0.2.8 (2021-03-03) ## v0.2.8 - 2021-03-03
#### Features ### Added
- Added much more information - author, copyright, etc. - to `--help`/`-h` output - Much more information to help output: author, copyright, etc.
- Scan files without extensions with `-S` (by default, such files are ignored) - Scan files without extensions with `-S` (by default, such files are ignored)
#### Bugfixes ### Fixed
- Using `-s` to skip hidden files no longer skips all files if the root directory itself is hidden - Using `-s` to skip hidden files no longer skips all files if the root directory itself is hidden
#### Other ### Other
- The `ScanError` enum now contains a `PathBuf` - Errors now return `ScanError` rather than `(ScanError, PathBuf)` - The `ScanError` enum now contains a `PathBuf` - Errors now return `ScanError` rather than `(ScanError, PathBuf)`
- Renamed modules in accordance with [Rust's API guidelines](https://rust-lang.github.io/api-guidelines/naming.html) - Renamed modules in accordance with [Rust's API guidelines](https://rust-lang.github.io/api-guidelines/naming.html)
### v0.2.7 (2021-03-01) ## v0.2.7 - 2021-03-01
- Default to `WARN`-level logging if `RUST_LOG` isn't set ### Added
- Added a drone CI config
- Added `test.py` for automated building and testing against Rust stable, beta, nightly, and the MSRV specified in
`Cargo.toml`
- Added a test for argument parsing
- Documentation! And lots of it! 0u0 - Documentation! And lots of it! 0u0
- Added a test for argument parsing
### Changed
- Default to `WARN`-level logging if `RUST_LOG` isn't set
### v0.2.6 (2021-02-28) ### Other
- Added tests! - Drone CI config
- `test.py` for automated building and testing against Rust stable, beta, nightly, and the MSRV specified in
`Cargo.toml`
## v0.2.6 - 2021-02-28
### Added
- Tests!
### Changed
- Default to [`xdg-mime`] on all Unixy platforms, not just Linux - this also includes the various *BSDs (I've tested - Default to [`xdg-mime`] on all Unixy platforms, not just Linux - this also includes the various *BSDs (I've tested
FreeBSD), macOS (haven't tested, but I have a very old MacBook running Leopard that has `file` preinstalled, so it FreeBSD), macOS (haven't tested, but I have a very old MacBook running Leopard that has `file` preinstalled, so it
*should* work fine), Redox OS (haven't tested), etc. *should* work fine), Redox OS (haven't tested), etc.
### v0.2.5 (2021-02-27) ## v0.2.5 - 2021-02-27
### Other
- Use [`xdg-mime`] by default on Linux, [`infer`] elsewhere - Use [`xdg-mime`] by default on Linux, [`infer`] elsewhere
### v0.2.4 (2021-02-22) ## v0.2.4 - 2021-02-22
### Added
- Proper(ish) XML document support - Proper(ish) XML document support
- Display version in help output - Display version in help output
### v0.2.3+hotfix (2021-02-22) ### v0.2.3+hotfix (2021-02-22)
### Added
- A quick hack to fix broken/non-existent support for XML document files - `docx`, `odt`, etc. - A quick hack to fix broken/non-existent support for XML document files - `docx`, `odt`, etc.
### v0.2.3 (2021-02-22) ## v0.2.3 - 2021-02-22
#### Features ### Added
- Automatically disable [`xdg-mime`] backend on Windows - Automatically disable [`xdg-mime`] backend on Windows
- Exit codes - Exit codes
- Improved error handling - Improved error handling
- Retrieve extension sets from [`mime_guess`] rather than hardcoding them - Retrieve extension sets from [`mime_guess`] rather than hardcoding them
#### Bugfixes ### Changed
- Improved SVG detection
#### Other
- Switched back from `printf` to `echo` in shell output - Switched back from `printf` to `echo` in shell output
### Fixed
- Improved SVG detection
### Other
- More frequent and detailed comments - More frequent and detailed comments
- Refactored `formats.rs` - Refactored `formats.rs`
- Exclude certain files and directories from the crate - Exclude certain files and directories from the crate
### v0.2.2 (2021-02-20) ## v0.2.2 - 2021-02-20
### Added
- Windows support - Windows support
### v0.2.1 (2021-02-18) ## v0.2.1 - 2021-02-18
#### Features ### Added
- Added extension sets -- you can now use, for example, `-E images` to check files with known image extensions - Extension sets -- you can now use, for example, `-E images` to check files with known image extensions
- Shell script output now uses `printf` instead of `echo` - Shell script output now uses `printf` instead of `echo`
- Added [`infer`] backend, configurable with [Cargo features](https://gitlab.com/Lynnesbian/fif/-/wikis/Cargo-Features) - [`infer`] backend, configurable with [Cargo features](https://gitlab.com/Lynnesbian/fif/-/wikis/Cargo-Features)
#### Bugfixes ### Fixed
- Fixed broken singlethreaded support - Fixed broken singlethreaded support
#### Other ### Other
- Use a global backend instance instead of passing `&db` around constantly - Use a global backend instance instead of passing `&db` around constantly
- Use `rustfmt` 0u0 - Use `rustfmt` 0u0
### v0.2.0 (2021-02-15) ## v0.2.0 - 2021-02-15
#### Features ### Added
- Output a script rather than a list of misnamed files - Output a script rather than a list of misnamed files
- Parallel file scanning - Parallel file scanning
- Added logging support - Logging support
#### Bugfixes ### Fixed
- Handle filenames with invalid UTF-8 - Handle filenames with invalid UTF-8
#### Other ### Other
- Added license - Now licensed (under GPLv3)
- Replaced [`structopt`] with [`clap`] 3 (beta) - Replaced [`structopt`] with [`clap`] 3 (beta)
- Specify 1.43.0 as minimum supported Rust version - Specify 1.43.0 as minimum supported Rust version
## v0.1 ## v0.1.0 - 2021-02-04
### v0.1.0 (2021-02-04)
Initial commit! Initial commit!
- Only one backend - [`xdg-mime`] - Only one backend - [`xdg-mime`]
- No output formats - just prints a list of files to be renamed - No output formats - just prints a list of files to be renamed