ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-09 09:49:10 +02:00
Code Issues Projects Releases Packages Wiki Activity
576 commits 9 branches 20 tags 4 MiB
Commit graph

248 commits

Author SHA1 Message Date
Niklas Mohrin
37b0dee39f
 		Support XDG directory spec on macOS by switching app_dirs2 to etcetera (#467) 
Closes #311

Similar to how `bat` does it, we now have a global struct which holds
all the queried system directories. We prefer the XDG directories, but
use the "native" directories as a fallback. This should ensure that when
MacOs users upgrade from an older version, their existing config and
cache are still used. After deleting the old directories, the new ones
should be used by tealdeer automatically.
 2026-08-06 00:37:37 +02:00
Niklas Mohrin
28ed785001
 		Fix 1.97 clippy lints 2026-07-26 23:52:43 +02:00
Nikolaos Karaolidis
f8a2003bc2
 		Add updates.warn_cache_age config option (#492) 
This is useful when the cache is managed externally, e.g. provisioned
from a Nix store path or by a package manager, where the directory's
mtime doesn't reflect the cache's real age, causing a spurious warning
on every invocation. Today the only way to silence it is `--quiet`,
which must be passed every call and hides all other output too.
 2026-07-07 14:24:06 +02:00
xtqqczze
d0108b23e4
 		Fix clippy lints on all targets (#481) 2026-05-07 15:07:27 +02:00
Ellis Clayton
1252261d66
 		Support tilde (~) expansion on config paths (#476) 
Allows directories in the configuration file (cache & custom pages) to
be relative to the user's home directory by expanding the common `~`
path prefix notation. Works for the current user only (`~diferentUser/`
syntax is not supported, and will cause an error if attempted).

Works for Linux/Unix (via `HOME` env var) and Windows (via `USERPROFILE`
env var).

Examples (assuming a user called "foo" on a Linux system):

```
~/my/custom-pages # /home/foo/custom-pages
~ # /home/foo
~bar/cache # error
```
 2026-05-03 21:47:29 +02:00
Niklas Mohrin
24e7f383b8
 		Fix Rust 1.95 clippy lints 2026-04-17 22:08:42 +02:00
Niklas Mohrin
6c65c8f71c
 		Fix off-boundary string access in formatter (#474) 
Closes #473

This regression was introduced in
593e9309b9 (#414) and leads to a panic
when trying to display pages where characters line up like in the issue
or the test. I checked other places and found that a similar panic could
occur when parsing language strings, so I added code to ignore them
instead.

- Add regression test
- Fix prefix check
- Skip non-ASCII locales
 2026-04-17 22:01:45 +02:00
Pavel Timofeev
b8f7c0cc2d
 		Add display.indent config option (#471) 
Fixes #394.
 2026-04-17 21:59:34 +02:00
Pavel Timofeev
b19517097a
 		Add builtin tldr tealdeer page (#472) 
Fixes #218.
 2026-04-14 00:31:31 +02:00
Niklas Mohrin
47a936e736
 		Suggest trying different TLS backend when update fails (#465) 
Closes #453

- Add note about changing tls_backend setting
- impl Display for TlsBackend
- Remove trailing slash in default archive source to make URL in error
look nicer
 2026-02-21 00:32:23 +01:00
Niklas Mohrin
593e9309b9
 		Placeholder escaping (#414) 
Closes #402

This adds special handling for escaped placeholders as required by the
client spec. The added tests include examples from current pages that
rely on this behavior.

The text replacements use `str::replace` which constructs a new
allocated `String`. I considered using a custom `replace_inplace` method
on `&mut str` (which works if the replacement string is at most as long
as the pattern to be replaced), but decided against it because I think
that the performance improvement is not significant enough to justify
adding `unsafe` code. It is also possible to avoid `unsafe` by
re-checking UTF-8 validity after all modifications, but the code still
felt a bit out of place for tealdeer. We can always add these
optimizations later if we want to.
 2026-02-20 23:44:36 +01:00
Niklas Mohrin
49626977ff
 		Run cargo +nightly clippy --fix and formatting (#442) 2025-10-03 22:44:39 +02:00
Niklas Mohrin
911508ce33
 		Add search.platforms config option and search all platforms by default (#435) 2025-10-03 20:15:34 +02:00
hex1c
5b306756af
 		Add display.show_title option to display command titles in output (#439) 2025-10-03 19:53:25 +02:00
Niklas Mohrin
c741146db5
 		Add updates.download_languages setting 2025-09-22 00:00:09 +02:00
Niklas Mohrin
a74b7120bd
 		Add search.languages setting 2025-09-21 23:59:50 +02:00
Niklas Mohrin
3fa96a5bb2
 		Add test config::test::language::with_encoding 2025-09-21 23:59:13 +02:00
Niklas Mohrin
7e014093cf
 		Move existing tests from config module into test submodule 2025-09-21 23:59:13 +02:00
Niklas Mohrin
94f9030d36
 		Move Language related functionality into config module 2025-09-21 23:59:05 +02:00
Niklas Mohrin
630b7f4423
 		Allow references in Config (#429) 
For #251, I want to use the `Language<'_>` type inside `Config`. The languages will either refer to values read from the config file, or to static strings from `get_languages_from_env`, so just using `Language<'static>` is not an option.

Instead, some input for the `Config` needs to be persisted in the main function for the duration of the program so that the config can reference it. At first I was hoping that this input would be the `contents` string from `RawConfig::load`, but as it turns out you cannot (in general) deserialize strings from toml without having to alter them, for example when they contain escapes like `\n`. Thus, the toml parser seemingly doesn't even try and just throws an error when deserializing into a borrowed string (even if it could in theory just return the correct substring from the input). Given that `RawConfig` should stay static then, the raw config itself is the next best thing to keep alive and have the config reference into.

While this change might seem a bit drastic for little benefit, I am actually pretty happy with it because I want to unify the configuration anyways at some point so that the CLI arguments, environment variables, and the config file are merged at the beginning of the program and then only a single config is used for the everything (no more `enable_styles` everywhere!). At this time, the `Config` would have references into `Cli` anyways, and having the `ConfigLoader` as an entity for this merging also seems natural.
 2025-08-05 23:46:49 +02:00
Niklas Mohrin
1e87db7ab7
 		Cache rewrite (#416) 2025-08-01 16:03:01 +02:00
Niklas Mohrin
d1be7d6bb9
 		Introduce Language struct (#425) 
* Remove unneeded Clone bound on Dedup
* Introduce Language struct to represent language strings
* Move language directory name logic into own method on Language type
 2025-06-06 23:25:30 +02:00
MHS-0
9bb95ad11d
 		Add an option to specify a custom config file to be used (#422) 
Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
 2025-05-31 21:43:39 +02:00
Erick Guan
3d8d488f66
 		Replace reqwest with ureq (#417) 
ureq is a blocking HTTP client. ureq is simpler than reqwest. This
brings:
- smaller binary size
- cleaner configuration interfaces
 2025-03-09 22:06:47 +01:00
Niklas Mohrin
009af7063f
 		Move most of main to try_main (#400) 
Currently, `main` uses `print_error` and `process::exit` in several
places. These could be unified by propagating errors via `Result`s.
There is one place left that manually calls `print_error`, because the
error should be followed by help instructions printed without any
highlighting.
 2025-02-26 23:04:41 +01:00
lyj
55f401df30
 		Add args: --edit-page and --edit-patch (#388) 
Fix https://github.com/tealdeer-rs/tealdeer/issues/383

Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
 2025-02-26 22:03:18 +01:00
Erick Guan
09ef7f534e
 		Allow configuring TLS backend (#386) 2025-02-26 00:27:44 +01:00
Predrag Minic
120e2a92c2
 		Add configuration option for archive_source (#337) 
This allows for specifying a custom archive URL as an alternative approach to Custom Pages.

Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
 2025-01-12 12:24:02 +01:00
Christoph Loy
b9f116d629
 		Add common platform to CLI (#401) 2025-01-12 11:50:32 +01:00
Matěj Kafka
00c7778125
 		Resolve paths in config [directories] relative to the config directory (#395) 2025-01-05 00:17:44 +01:00
Niklas Mohrin
ee5418b5a8
 		Run cargo clippy --fix (Rust 1.83) (#397) 2025-01-01 19:07:40 +01:00
Blair Noctis
fb7492b0b5
 		Upgrade yansi: 0.5.1 -> 1.0.1 (#389) 
- Adapt to `thing.paint(style)` API; was `style.paint(thing)`
- Remove `yansi::Paint::enable_windows_ascii()` in style usage decision;
  removed in yansi commit b186eb5bfb, which introduced "automatic"
  support for Windows: "If support is not available, styling is disabled
  and no styling sequences are emitted", fitting the `Auto` option
- Respect `--color=always` even if we know it won't work

---------

Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
 2024-11-14 16:07:30 +01:00
Niklas Mohrin
ec2daa495c
 		Replace atty with std::io::IsTerminal (#380) 2024-10-02 20:32:17 +00:00
Danilo Bargen
fc6d644152
 		Update all URLs to point to new GitHub organization (#379) 
See https://github.com/tealdeer-rs/tealdeer/issues/376 for details.
 2024-09-30 11:27:19 +02:00
Danilo Bargen
7c245040b9
 		Command line help: Add hint about platform overrides (#375) 
- Rename PLATFORMS to PLATFORM
- Add hint about specifying platform multiple times
 2024-08-13 00:14:19 +02:00
Danilo Bargen
f3d74850a8
 		Make clippy happy (#373) 2024-08-06 21:46:40 +00:00
Danilo Bargen
64f3fbbbc6 Apply clippy suggestions 2024-06-17 00:35:04 +02:00
Danilo Bargen
de1684edb6 Update to clap v4 2024-06-17 00:35:04 +02:00
K.B.Dharun Krishna
ee6d2418f1
 		Add BSD platform support and update workflows (#354) 2024-04-10 16:05:51 +02:00
Zacchary Dempsey-Plante
17c08f0261
 		Change custom page files to use a .md extension (#322) 
* Change custom page files to use a `.md` extension.
* Add a breaking change warning to the documentation for the usage of custom pages.
* Add a temporary check for old custom pages to assist in the migration to the new naming convention.

Co-authored-by: Danilo Bargen <mail@dbrgn.ch>
 2024-02-15 19:27:56 +00:00
JJ Style
9e1489bbc5
 		Allow querying multiple platforms (#300) 2023-08-27 21:52:20 +00:00
qknogxxb
8c6754ae78
 		Line iterator: Improve test functions (#316) 2023-07-05 23:33:39 +02:00
Danilo Bargen
94d56c01a7
 		Allow building with native-tls (#303) 
Right now we only support building with Rustls. However, there are quite
a few architectures that aren't yet supported by "ring" (the crypto
library used by Rustls), for example MIPS, PowerPC or SPARC.

To offer an alternative, I added the "native-tls" feature that can be
used instead of "native-roots". When used, the native TLS stack is used
instead of Rustls (i.e. SChannel on Windows, Secure Transport on macOS
and OpenSSL otherwise).
 2023-02-14 18:21:07 +01:00
qknogxxb
72362769de
 		Line iterator: Drop empty line without allocating (#314) 
Co-authored-by: Niklas Mohrin <dev@niklasmohrin.de>
 2023-02-12 17:45:53 +00:00
tveness
76d9d0bbda
 		Obey 1.67 clippy lints (#313) 2023-02-07 21:56:41 +01:00
Danilo Bargen
ab5148f237
 		Fix path source for custom pages dir (#297) 2022-10-22 22:00:29 +02:00
Danilo Bargen
2ebf86b265 Remove deprecated -m/--markdown command 2022-10-01 23:54:37 +02:00
Danilo Bargen
efe1b57696 Remove deprecated -o/--os command 2022-10-01 23:53:32 +02:00
Danilo Bargen
0c93a4cfe9 Remove deprecated --config-path command 2022-10-01 23:52:03 +02:00
Danilo Bargen
c44faf2b09 Lazy creation of cache directory 2022-10-01 12:18:44 +02:00