Pretty print journal entries #692

alichtman · 2019-10-25T05:09:14Z

Changes appearance of all jrnl viewing commands, such as $ jrnl --short and
$ jrnl -n {NUM}.

Changes appearance of all jrnl viewing commands, such as $ jrnl --short and $ jrnl -n {NUM}. Fix #508

alichtman · 2019-10-25T05:19:16Z

This feature has some slight bugs that I'm still working out.

~~I'm not sure where the extra newline between the title and the body is coming from. I sort of want to consider this a feature and not a bug. I like the way it looks, actually.~~ Edit: Fixed

A bunch of feature tests are failing because the output is being produced with certain ANSI escape characters and the expected output doesn't contain them. Not sure exactly how to fix this one yet, but I've been playing around with some stuff in the features files. For example, Edit: Fixed

 Scenario: --short displays the short version of entries (only the title)  # features/core.feature:54
    Given we use the config "basic.yaml"                                    # features/steps/core.py:66 0.000s
    When we run "jrnl -on 2013-06-10 --short"                               # features/steps/core.py:90 0.004s
    Then the output should be "2013-06-10 15:40 Life is good."              # features/steps/core.py:169 0.000s
      Assertion Failed: ['2013-06-10 15:40 Life is good.', '\x1b[91m2013-06-10 15:40\x1b[0m \x1b[1mLife is good.\x1b[0m']
      Captured stdout:
      2013-06-10 15:40 Life is good.

alichtman · 2019-10-26T00:31:15Z

~~The last failing test case is exporting with custom templates. This is also failing for me locally on master (but not on Travis) so it's possible that it's not my PR causing this.~~

Yep, just forgot to commit the file that contained the new dependency.

This seems ready to be merged to me, unless you have anything you'd like changed.

pspeter · 2019-11-01T18:22:20Z

I'm not the biggest fan of the color choices to be honest. Why not let the user define the colors (separately for date, title and body) in the config?

alichtman · 2019-11-03T15:43:16Z

Why not let the user define the colors (separately for date, title and body) in the config?

Good call. Do you think it's better to have them set colors like red, blue, green, ... or ANSI escapes?

pspeter · 2019-11-03T15:47:33Z

Definitely colors. Not sure what the ideal way to map them to escapes is though. We may want to look into moving away from using the raw escapes all together and towards a package like colorama.

features/steps/core.py

- Replaced raw escapes with colorama - Added colors key to config - Add checks for validity of color values

alichtman · 2019-11-06T00:46:05Z

I should add two tests:

Identifying invalid color configs
Upgrading the config from no colors -> colors

(Done)

- Identifying invalid color configs - Upgrading config from no colors -> colors

jrnl/util.py

alichtman · 2019-11-06T01:56:11Z

@wren I believe this is ready for review.

wren · 2019-11-06T05:32:26Z

@alichtman Great! I'll review this weekend.

One thing from first glance, though: Is there an option to disable color? I know a lot of people pipe output to various scripts, and the escape sequences can complicate that.

alichtman · 2019-11-06T16:43:29Z

Yep, I can add that.

jrnl/util.py

jrnl/install.py

alichtman · 2019-11-06T18:19:32Z

I've found one bug in the config updating algorithm that will need to be addressed. It only looks at top-level keys, and not nested keys.

https://stackoverflow.com/a/27266178

A solution like this will be needed if the subkeys of colors will ever be updated...

I'll open a separate issue. (#714)

alichtman · 2019-11-06T18:31:32Z

So here's an interesting bug...

I understand why the body drops all colorama formatting after the tag (due to the colorama.Style.RESET_ALL in colorize()), but I can't figure out why the title doesn't have the same problem. I've pushed the most recent version if you'd like to play around with it, @peter-schmidbauer.

EDIT: It seems to break like I was expecting it to in PyCharm, just not in iTerm2.

Seems like in order to fix this, we'd need to do the tag parsing before the colorization, which would mean either doing it all in the entry.pprint() method or returning an unmerged entry to the journal.pprint() method. As it is now, there's no way to determine whether or not the tag is in the title or the body.

pspeter · 2019-11-06T20:13:40Z

By the way, I think stripping the color from all outputs during tests is not ideal. I'd instead have all previous tests use no color, and add a new configuration with colors and some more specific tests. It's a new feature and deserves its own tests imho.

alichtman · 2019-11-06T20:14:52Z

I tried for a few hours to figure out how to get behave to work with ANSI escapes and made no progress. I agree with you, but I don't think it's possible.

wren · 2019-11-12T05:33:09Z

Hey, we just merged a bunch of stuff into master. This just needs a quick rebase on the new master, but then should be ready to go. Thanks, and sorry!

alichtman · 2019-11-12T05:41:16Z

Disclaimer: I did that merge in the GitHub UI. I'm pretty sure it's done correctly but we shall see...

Yup, all tests pass. Good to go here.

alichtman · 2019-11-12T21:49:49Z

Resolved merge conflict in poetry.lock.

alichtman · 2019-11-15T09:02:57Z

@wren Any update on this?

wren · 2019-11-15T16:59:33Z

@alichtman I have a full jrnl work day scheduled for Saturday, so I'll be able to go fully through this then. Lots a big one, so I want to make sure to put it through its paces.

pspeter

Be careful when merging stuff!

jrnl/util.py

jrnl/Entry.py

features/steps/core.py

wren · 2019-11-17T04:42:33Z

This is looking good so far. I didn't quite get this one finished, but I'll wrap up on Monday night. Thanks for your patience!

wren

Looks great! Thank you for all the work!

* Pretty print journal entry titles and dates. Changes appearance of all jrnl viewing commands, such as $ jrnl --short and $ jrnl -n {NUM}. Fix #508 * Removed extra newline at end of title * Use ansiwrap to properly wrap strings with ANSI escapes * Add ansiwrap to pyproject.toml * Allow configuration of colors - Replaced raw escapes with colorama - Added colors key to config - Add checks for validity of color values * Add color configuration documentation * Fix broken tests due to config change * Add tests for colors in configs - Identifying invalid color configs - Upgrading config from no colors -> colors * Add colorama dependency for all platforms * Allow users to disable colorization of output * Update poetry.lock * Add tag and body color customization options * Fix colorization of tags in title and body * Updated tests to use no color by default * Change pass to continue in verify_config() * Better style in Entry.py * Reduce code duplication for tag highlighting - Breaks "unreadable date" regression test for unknown reason * Properly colorize tags and print body * Reformatting and clean up * Replace list comprehension with generator * Handle invalid colors by not using a color * Process ANSI escapes properly with behave * Fixed the 'spaces after tags directly next to punctuation' bug Broke processing of tags next to any punctuation at all * Closer to working tag colorization but not perfect * Add tests printing for multiline journals Fix #717 * Correctly indent first line of multiline entry * Add test for multiline entries with tags * Remove redundant UNICODE flag * Progress towards proper tag colorization and body formatting * Fix newline colorization bug Debug code left intact since there are more bugs to fix :/ * And now the space just ends up before the tag instead of after it * Fix assertion syntax warning * Moved tag test to tagging.feature file * Strip out debug code and clean up * Bold datetimes in title * Bold all titles Fix #720 * Remove PY2 and PY3 constants * Fix regression in features/steps/core.py * Fix tag_regex * Remove redundant re.UNICODE flag * Remove extraneous code

lock · 2020-05-20T23:41:10Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Pretty print journal entry titles and dates.

e7da8c1

Changes appearance of all jrnl viewing commands, such as $ jrnl --short and $ jrnl -n {NUM}. Fix #508

alichtman changed the title ~~Pretty print journal entry titles and dates.~~ Pretty print journal entry titles and dates Oct 25, 2019

alichtman added 2 commits October 26, 2019 00:26

Removed extra newline at end of title

1d4bbea

Use ansiwrap to properly wrap strings with ANSI escapes

b4bfc2c

Add ansiwrap to pyproject.toml

75a8249

alichtman commented Nov 5, 2019

View reviewed changes

features/steps/core.py Outdated Show resolved Hide resolved

alichtman added 2 commits November 6, 2019 01:05

Allow configuration of colors

01db72b

- Replaced raw escapes with colorama - Added colors key to config - Add checks for validity of color values

Add color configuration documentation

b2d3fc8

alichtman added 3 commits November 6, 2019 01:51

Fix broken tests due to config change

8053d25

Add tests for colors in configs

eb1ed3c

- Identifying invalid color configs - Upgrading config from no colors -> colors

Add colorama dependency for all platforms

1a0847b

alichtman commented Nov 6, 2019

View reviewed changes

jrnl/util.py Outdated Show resolved Hide resolved

wren added the enhancement New feature or request label Nov 6, 2019

alichtman added 2 commits November 6, 2019 18:25

Allow users to disable colorization of output

a23a818

Update poetry.lock

c63c999

pspeter suggested changes Nov 6, 2019

View reviewed changes

jrnl/util.py Outdated Show resolved Hide resolved

jrnl/util.py Outdated Show resolved Hide resolved

jrnl/install.py Outdated Show resolved Hide resolved

Add tag and body color customization options

4b934e3

Merge branch 'master' into pretty-print-entries

712b471

alichtman changed the title ~~Pretty print journal entry titles and dates~~ Pretty print journal entries Nov 12, 2019

Merge branch 'master' into pretty-print-entries

6ad5188

pspeter suggested changes Nov 16, 2019

View reviewed changes

jrnl/util.py Outdated Show resolved Hide resolved

jrnl/Entry.py Outdated Show resolved Hide resolved

features/steps/core.py Outdated Show resolved Hide resolved

alichtman added 5 commits November 17, 2019 00:49

Remove PY2 and PY3 constants

09802cc

Fix regression in features/steps/core.py

8c9b040

Fix tag_regex

f2bf1ff

Remove redundant re.UNICODE flag

edb0d8e

Remove extraneous code

566ab5c

alichtman mentioned this pull request Nov 18, 2019

Markdown-like Syntax highlighting (italics and bold) #746

Closed

wren changed the base branch from master to v2.2 November 19, 2019 03:52

wren approved these changes Nov 19, 2019

View reviewed changes

wren merged commit 9ca09c5 into jrnl-org:v2.2 Nov 19, 2019

alichtman deleted the pretty-print-entries branch November 19, 2019 12:22

alichtman mentioned this pull request Nov 20, 2019

Fix pyproject.toml #753

Closed

alichtman restored the pretty-print-entries branch November 20, 2019 15:17

alichtman deleted the pretty-print-entries branch November 20, 2019 15:21

wren removed this from the v2.2 milestone Jan 26, 2020

lock bot added the 🔒 Outdated label May 20, 2020

lock bot locked as resolved and limited conversation to collaborators May 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pretty print journal entries #692

Pretty print journal entries #692

alichtman commented Oct 25, 2019 •

edited

Loading

alichtman commented Oct 25, 2019 •

edited

Loading

alichtman commented Oct 26, 2019 •

edited

Loading

pspeter commented Nov 1, 2019

alichtman commented Nov 3, 2019

pspeter commented Nov 3, 2019 •

edited

Loading

alichtman commented Nov 6, 2019 •

edited

Loading

alichtman commented Nov 6, 2019

wren commented Nov 6, 2019

alichtman commented Nov 6, 2019

alichtman commented Nov 6, 2019 •

edited

Loading

alichtman commented Nov 6, 2019 •

edited

Loading

pspeter commented Nov 6, 2019

alichtman commented Nov 6, 2019

wren commented Nov 12, 2019

alichtman commented Nov 12, 2019 •

edited

Loading

alichtman commented Nov 12, 2019 •

edited

Loading

alichtman commented Nov 15, 2019

wren commented Nov 15, 2019

pspeter left a comment

wren commented Nov 17, 2019

wren left a comment

lock bot commented May 20, 2020

Pretty print journal entries #692

Pretty print journal entries #692

Conversation

alichtman commented Oct 25, 2019 • edited Loading

alichtman commented Oct 25, 2019 • edited Loading

alichtman commented Oct 26, 2019 • edited Loading

pspeter commented Nov 1, 2019

alichtman commented Nov 3, 2019

pspeter commented Nov 3, 2019 • edited Loading

alichtman commented Nov 6, 2019 • edited Loading

alichtman commented Nov 6, 2019

wren commented Nov 6, 2019

alichtman commented Nov 6, 2019

alichtman commented Nov 6, 2019 • edited Loading

alichtman commented Nov 6, 2019 • edited Loading

pspeter commented Nov 6, 2019

alichtman commented Nov 6, 2019

wren commented Nov 12, 2019

alichtman commented Nov 12, 2019 • edited Loading

alichtman commented Nov 12, 2019 • edited Loading

alichtman commented Nov 15, 2019

wren commented Nov 15, 2019

pspeter left a comment

Choose a reason for hiding this comment

wren commented Nov 17, 2019

wren left a comment

Choose a reason for hiding this comment

lock bot commented May 20, 2020

alichtman commented Oct 25, 2019 •

edited

Loading

alichtman commented Oct 25, 2019 •

edited

Loading

alichtman commented Oct 26, 2019 •

edited

Loading

pspeter commented Nov 3, 2019 •

edited

Loading

alichtman commented Nov 6, 2019 •

edited

Loading

alichtman commented Nov 6, 2019 •

edited

Loading

alichtman commented Nov 6, 2019 •

edited

Loading

alichtman commented Nov 12, 2019 •

edited

Loading

alichtman commented Nov 12, 2019 •

edited

Loading