cmark files and multiline fragments #74

drahnr · 2020-07-16T11:07:23Z

What does this PR accomplish?

Does all handling of multiline literals, except for displaying, which must be handled in a separate PR.

Closes #37 which requires proper handling of chunks with multiline fragments

Changes proposed by this PR:

Calculate a full span for common mark files and the associated mapped range.
Extract spans from multiline fragments.
feather_up! for testability

To fully function, requres impl of #25 to not assert. Closes #14

Ref #25

drahnr · 2020-07-16T11:09:03Z

@zhiburt e535f38 is the relevant part for #37 - I was not aware things would explode afterwards at multiple code segments, I am sorry having you sent there.

KuabeM · 2020-07-17T06:35:25Z

src/action/interactive.rs

@@ -403,11 +403,14 @@ impl UserPicked {
            }

            let event = match crossterm::event::read()
+                .map(move |event| {
+                    drop(guard);


KuabeM · 2020-07-17T06:38:28Z

src/action/interactive.rs

@@ -435,7 +437,6 @@ impl UserPicked {
                }
            }

-            drop(guard);


That drop() is unnecessary because drop for ScopedRaw in line 424 is called when it goes out of scope and now it's ensured that all earlier guards are properly dropped right? Just for my understanding :)

I am not sure if the current approach is sane, there seem to be a few artificats in the cli, cursor showing and lines being off by one, just because we leave raw mode, so this might have to be reverted eventually.

KuabeM · 2020-07-17T06:39:10Z

src/documentation/chunk.rs

-            .skip_while(|(sub, _span)| sub.end <= start)
-            .take_while(|(sub, _span)| end <= sub.end)
+            .skip_while(|(fragment_range, _span)| fragment_range.end <= start)
+            .take_while(|(fragment_range, _span)| end <= fragment_range.end)


I like the new variable names 👍

what does fragment_range means here? if I may ask

I think it's best explained in the module docs https://github.com/drahnr/cargo-spellcheck/pull/74/files/27c8c0f661e02c310dfa14a9d6475b73f1312cd2#diff-5fe541b5263f70cb56752ad21183cdddR1-R13 if not that must be expanded.

src/documentation/chunk.rs

src/documentation/mod.rs

Co-authored-by: Korbinian Maier <[email protected]>

Note that the root cause for dbg!(suggestion) has yet to be investigated.

Ref #25

src/documentation/chunk.rs

laysauchoa · 2020-07-17T16:12:37Z

src/documentation/chunk.rs

-                        return None;
-                    }
+            .filter_map(|(fragment_range, fragment_span)| {
+                // trim range so we only capture the relevant part


what is considered an irrelevant part?

It's not about irrelevant, it's a coverage problem of the given input range on the set of fragmented ranges. Note the fragmentation is caused by clustering of multiple literals. A fragment is a mere description of a range/span couple concept of a chunk.

src/span.rs

laysauchoa

Short question: does this PR helps to fix chunk for single lines? or helps me here: #65?

drahnr · 2020-07-17T16:51:22Z

Short question: does this PR helps to fix chunk for single lines? or helps me here: #65?

No, this prepares all systems except for suggestion or chunk display impl for multiline fragments. So this does not interfere with or fix #65

Co-authored-by: Laysa Uchoa <[email protected]>

src/documentation/chunk.rs

drahnr · 2020-07-17T17:42:36Z

Short question: does this PR helps to fix chunk for single lines? or helps me here: #65?

No, this prepares all systems except for suggestion or chunk display impl for multiline fragments. So this does not interfere with or fix #65

@laysauchoa the above is intentional to avoid you having to deal with merge conflicts, the display is going to be a separate PR once #74 and #65 are in master.

This reverts commit 2e727e5.

…rogram

Most tests and the manual spans calculated expect that.

The extracted rules are a best effort based on trial and error, far from perfect.

drahnr added 4 commits July 16, 2020 10:47

refactor/terminal: raw mode guard drop code simplification

2e727e5

fix/warning: add allow unused in a few spots

aef15df

fix/commonmark: allow common mark input

e535f38

To fully function, requres impl of #25 to not assert. Closes #14

feat/multiline: initial handling of multiline literals

1e548ab

Ref #25

drahnr added enhancement 🦚 New feature or request heavy-duty 🚜 Big features not easy to implement labels Jul 16, 2020

drahnr self-assigned this Jul 16, 2020

drahnr requested a review from KuabeM July 16, 2020 11:09

drahnr added 4 commits July 16, 2020 13:34

fix/multiline: better test macros and helpers

0a8715a

fix/multiline: more test infra fixes for multiline handling

bdcb4b9

refactor/chunk: find_spans

dd594af

fix/multiline: find_spans again

d1c1eb5

KuabeM reviewed Jul 17, 2020

View reviewed changes

drahnr and others added 5 commits July 17, 2020 09:52

docs/fix: fragment explanation

abc591d

Co-authored-by: Korbinian Maier <[email protected]>

fix/test: avoid dbg!(suggestion) and a few slips of pens

74ddae5

Note that the root cause for dbg!(suggestion) has yet to be investigated.

fix/chunk: single character tokens must also have a span length of 1

e4b9115

fix/span: assure the correct range is asserted

110f81b

feat/test: verify suggestion is dbg printable

15ae31e

drahnr force-pushed the bernhard-cmark-files branch from 9d0ee93 to 01aefc2 Compare July 17, 2020 13:38

fix/multiline: span, chunk, and tests are now multiline ready

b8012a3

Ref #25

drahnr force-pushed the bernhard-cmark-files branch from 01aefc2 to b8012a3 Compare July 17, 2020 13:48

chore: cargo fmt + cargo fix

27c8c0f

drahnr requested a review from KuabeM July 17, 2020 15:31

KuabeM reviewed Jul 17, 2020

View reviewed changes

src/documentation/chunk.rs Show resolved Hide resolved

src/documentation/chunk.rs Outdated Show resolved Hide resolved

laysauchoa reviewed Jul 17, 2020

View reviewed changes

src/span.rs Outdated Show resolved Hide resolved

laysauchoa reviewed Jul 17, 2020

View reviewed changes

docs/spelling: dev comment

c5dd04c

Co-authored-by: Laysa Uchoa <[email protected]>

drahnr commented Jul 17, 2020

View reviewed changes

src/documentation/chunk.rs Outdated Show resolved Hide resolved

drahnr commented Jul 17, 2020

View reviewed changes

src/documentation/chunk.rs Outdated Show resolved Hide resolved

drahnr added 2 commits July 17, 2020 19:19

fix/log: warn -> trace

ca1a9d8

chore/cleanup: remove commented dbg! helpers

147dcdd

drahnr added 5 commits July 20, 2020 12:11

Revert "refactor/terminal: raw mode guard drop code simplification"

28bf82e

This reverts commit 2e727e5.

fix/ci: exit code must be zero now unless there was an error in the p…

9194444

…rogram

fix/test: failed span calc for indented lines

736554f

fix/test: adjust spans properly

f27ea72

feat/test: allow prefix syntax for chyrp_up with @

bfc516c

drahnr mentioned this pull request Jul 23, 2020

cache line ranges of chunks for fast lookup #75

Open

drahnr added 6 commits July 23, 2020 11:49

refactor/literal: Err(anyhow!(...)) becomes bail!(...)

c974458

fix/literal: improve the detection & span adjustments of /// comments

a6b6a71

fix/fluff: if no indentation str is given, use ""

01a3387

Most tests and the manual spans calculated expect that.

refactor/*: Err(anyhow!(...)) becomes bail!(...)

51b1360

chore: cargo fmt + cargo fix

22e304f

fix/literal: extract the spans properly

342eb39

The extracted rules are a best effort based on trial and error, far from perfect.

drahnr force-pushed the bernhard-cmark-files branch from 82494df to 342eb39 Compare July 23, 2020 13:59

chore: use vs cargo fix

ca8d386

drahnr requested a review from KuabeM July 23, 2020 14:13

drahnr merged commit 85d5b34 into master Jul 23, 2020

drahnr deleted the bernhard-cmark-files branch July 23, 2020 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmark files and multiline fragments #74

cmark files and multiline fragments #74

drahnr commented Jul 16, 2020

drahnr commented Jul 16, 2020

KuabeM Jul 17, 2020

KuabeM Jul 17, 2020

drahnr Jul 17, 2020

KuabeM Jul 17, 2020

laysauchoa Jul 17, 2020

drahnr Jul 17, 2020 •

edited

Loading

laysauchoa Jul 17, 2020

drahnr Jul 17, 2020

laysauchoa left a comment

drahnr commented Jul 17, 2020

drahnr commented Jul 17, 2020

cmark files and multiline fragments #74

cmark files and multiline fragments #74

Conversation

drahnr commented Jul 16, 2020

What does this PR accomplish?

Changes proposed by this PR:

drahnr commented Jul 16, 2020

KuabeM Jul 17, 2020

Choose a reason for hiding this comment

KuabeM Jul 17, 2020

Choose a reason for hiding this comment

drahnr Jul 17, 2020

Choose a reason for hiding this comment

KuabeM Jul 17, 2020

Choose a reason for hiding this comment

laysauchoa Jul 17, 2020

Choose a reason for hiding this comment

drahnr Jul 17, 2020 • edited Loading

Choose a reason for hiding this comment

laysauchoa Jul 17, 2020

Choose a reason for hiding this comment

drahnr Jul 17, 2020

Choose a reason for hiding this comment

laysauchoa left a comment

Choose a reason for hiding this comment

drahnr commented Jul 17, 2020

drahnr commented Jul 17, 2020

drahnr Jul 17, 2020 •

edited

Loading