Allow code-folding for selected text in editor #11538

thehogfather · 2015-08-03T21:20:34Z

This is a small addition to the code folding extension that makes any selected text in the editor foldable (provided the number of lines selected is more than the minimum fold size set in the preference).

The feature can be enabled by setting the preference value "code-folding.makeSelectionFoldable": true

cc @abose

…brackets editor

…folding-unit-tests # By Marcel Gerber (5) and others # Via Arun Bose (2) and others * 'master' of https://github.com/adobe/brackets: Actually pass the right value to substr Update strings.js Correct URL Update Lodash -> 3.10.0 Make use of new Lodash features Adjust code for Lodash 3.x Update Lodash -> 3.6.0

…selected

…king that preference values work as expected

…folding-unit-tests # By Marcel Gerber # Via Marcel Gerber (1) and Prashanth Nethi (1) * 'master' of https://github.com/adobe/brackets: Highlight .xsd files as XML

…ected * commit '1e09fb219224cd80137a8bd1f0cb8326c6814010': Highlight .xsd files as XML

nethip · 2015-08-04T07:44:10Z

@thehogfather Wow! That was quick. Thanks for this PR!.

marcelgerber · 2015-08-04T10:31:27Z

src/extensions/default/CodeFolding/Prefs.js

@@ -35,7 +36,9 @@ define(function (require, exports, module) {
                           {name: HIDE_FOLD_BUTTONS, description: Strings.DESCRIPTION_CODE_FOLDING_HIDE_UNTIL_MOUSEOVER});
    prefs.definePreference("maxFoldLevel", "number", 2,
                           {name: MAX_FOLD_LEVEL, description: Strings.DESCRIPTION_CODE_FOLDING_MAX_FOLD_LEVEL});
-
+    prefs.definePreference("makeSelectionsFoldable", "boolean", true,
+                           {name: MAKE_SELECTIONS_FOLDABLE, description: MAKE_SELECTIONS_FOLDABLE});


Use Strings.* instead for the description so it's translateable.

@marcelgerber sure thing! I shall update.

abose · 2015-08-04T10:47:03Z

Thanks @thehogfather for the PR.

…ections foldable. Minor modification to CodeMirror helper fold.auto - a range is now only returned if the number of lines spanned by the range is at least the minimum fold size set in the prefs. This has implications for global helpers.

thehogfather · 2015-08-05T23:51:00Z

BTW this is still a work in progress. Amongst other things, I need to sort out issues around restoring folds based on selections. Shall update in the next few days. Case 2 below is of particular interest:

User selects text, folds it, closes the file. When user reopens the file (without modification) the folded selected text region is restored.
User selects text, folds it, closes the file. File is modified outside the context of brackets (e.g., git). User opens the file. What is a reasonable expectation here?

abose · 2015-08-06T04:28:43Z

@thehogfather I have added a review only tag to the title of the PR, please remove it when you feel this pr is ready to be merged!

petetnt · 2015-08-07T05:44:06Z

@thehogfather I wrestled with a case similar to 2. with my brackets-persistent-history extension, where I wanted to persist the editing history between project changes and outside changes. My original idea was to invalidate the editing history on the changed part by diffing the files (similar to how you could invalidate / uncollapse changed lines) but in the end I went for a simpler solution where I add another history-step to compensate between the state in the cache and the new changes from outside of Brackets.

However the case here is slightly different so it's hard to say what the reasonable expectation would be: overall I wouldn't want Brackets to uncollapse any folds unless absolutely necessary (ie. the folded content has been modified in a way that it doesn't exist (start/end has been removed/modified) anymore), but then again how would you notice that something has changed inside a collapsed fold? One idea would be showing the change in the collapse marker but that's kinda out there too.

function that updates foldcache now also accounts for selection folds

…selected

thehogfather · 2015-08-08T22:27:04Z

@petetnt quite!
The case here is also interesting because there really isn't a way to "validate" selection-based folds - any selection is valid - unlike how modifications to a file can render brace-based folds invalid. At the moment what the extension does is to use the starting line of each collapsed region to calculate the 'intended' collapsed region when the file is reopened. If the file has not changed then there is no problem. If the file has changed, then the fold might be invalidated if the start and end lines of the new and cached ranges don't match.

For now I've kept it simple. Selection folds will be restored if and only if they exist in the saved fold preferences and are reported as selection by the ViewStateManager.

It might be worth thinking about rendering selection folds ever-so-slightly differently from other types of folds in the gutter.

…folding-unit-tests

…apsed region.

* fold-selected: fix for the creation of multiple fold range widgets for a single collapsed region. updated logic for restoring line folds to account for selection folds function that updates foldcache now also accounts for selection folds Added nls Strings description for code-folding feature for making selections foldable. Minor modification to CodeMirror helper fold.auto - a range is now only returned if the number of lines spanned by the range is at least the minimum fold size set in the prefs. This has implications for global helpers. Added feature to enable code folding for arbitrary selections in the brackets editor

* code-folding-unit-tests: documented and refactored restoreLineFolds function added test for clearing correctness of clearing fold marks in editor added test cases including enabling and disabling extension, and checking that preference values work as expected Basic unit tests for code-folding extension

This reverts commit eb419aa.

thehogfather · 2015-08-12T01:10:05Z

@abose I think this is ready to merge.

nethip · 2015-09-09T14:10:27Z

@abose I think we should target this for 1.5

Allow code-folding for selected text in editor

abose · 2015-09-11T13:55:41Z

It working well in all cases i tested. External modification is always a grey area, But no data is getting corrupted / opening up the folds on external modification seeems to be reasonable- which is how it is working now mostly.
All unit/integration/main view tests Passing.

Thanks for this feature @thehogfather 👍
Merging.

Maetzzen · 2015-10-16T10:34:06Z

Im really happy about this new feature in version 1.5.
But could one tell me if there is a possibility to save this options?

If i restart my brackets, my html files are folded out and i have to manually fold in the stuff i dont want to see again.
There is some content i dont have to see anymore and it would be more clearly if they are folded in.

Greetings Maetzzen

ezequias · 2015-10-16T18:54:59Z

Could someone tell me if the collapsed text is correctly iconified on my image (that ugly crossed square)?

thehogfather · 2015-10-16T20:15:03Z

@ezequias that is correct and would be and issue to raise with the theming provider you are using. @Maetzzen the fold states should persist when you close and reopen brackets. Can you report what operating system you are running?

Maetzzen · 2015-10-16T20:35:28Z

My bracket runs on Windows 8.0

ezequias · 2015-10-16T20:38:50Z

Thanks @thehogfather It's Monokai dark soda.

thehogfather · 2015-10-16T22:24:12Z

@Maetzzen can you confirm if there is any difference if you select a different file in your workspace before closing brackets. So fold some regions in your html file as you did before then switch to a different file and then close and reopen brackets.

Now check if the folds in your html file are restored or not.

Maetzzen · 2015-10-16T23:00:33Z

@thehogfather
It doesnt matter which kind of file i select.
The files and their segments are minimized as long i keep the brackets opened.
But whenever i close and reopen brackets the segments arent minimized anymore.
In my html element i have a lot of content safed in different tables. And i minimize them to keep an overview but if i reopen brackets the adjustment is resetted. I hope you understand what i mean ^_^'

thehogfather · 2015-10-16T23:06:58Z

Yeah I understand. But I have a theory about why you are experiencing the issue. To disprove or support my theory your project needs to have multiple files. And you need to change the active editor after you've folded a code region. Hence why I asked that you select a different file (before closing brackets and after folding some regions in an intended file).

I could reproduce the issue only if I opened brackets, worked on only a single file and then closed brackets. Hope you understand what I'm trying to say.

petetnt · 2015-10-17T08:34:18Z

@ezequias' issue is reported here: rainje/Monokai-Dark-Soda/issues/6, there's a suggested workaround mentioned too.

thehogfather · 2015-10-17T10:49:45Z

btw @Maetzzen this issue is related to #11775 so perhaps lets carry on discussions there.

Cheers

ezequias · 2015-10-20T22:04:01Z

Thanks @petetnt but I didn't find the monokai main.css but only monokai.css and it does not have the mentioned text.

rainje · 2015-11-04T02:45:04Z

@ezequias Did you update the theme to 1.0.9 ? It should be fixed. Tell me if it isn't.

ezequias · 2015-11-07T14:14:38Z

@rainje yes. Now looks better but I would use a minus sign with the same color of the plus sign to make it perfect. Anyway now is way better than before. Thanks for caring about me.

Pandahisham · 2016-01-22T06:39:21Z

@thehogfather for later verisons please consider a "fold all other" / "focus mode" option , it's great when writing blogs or similar stuff

thehogfather added 7 commits July 31, 2015 00:21

Added feature to enable code folding for arbitrary selections in the …

75b3ace

…brackets editor

Basic unit tests for code-folding extension

798c8d0

Merge branch 'master' of https://github.com/adobe/brackets into fold-…

411ee7c

…selected

added test cases including enabling and disabling extension, and chec…

3523389

…king that preference values work as expected

Merge branch 'master' of https://github.com/adobe/brackets into code-…

574279a

…folding-unit-tests # By Marcel Gerber # Via Marcel Gerber (1) and Prashanth Nethi (1) * 'master' of https://github.com/adobe/brackets: Highlight .xsd files as XML

Merge commit '1e09fb219224cd80137a8bd1f0cb8326c6814010' into fold-sel…

f601475

…ected * commit '1e09fb219224cd80137a8bd1f0cb8326c6814010': Highlight .xsd files as XML

marcelgerber reviewed Aug 4, 2015
View reviewed changes

thehogfather added 2 commits August 5, 2015 16:27

added test for clearing correctness of clearing fold marks in editor

ab8039f

abose changed the title ~~Allows code-folding for selected text in editor~~ [review only] Allows code-folding for selected text in editor Aug 6, 2015

marcelgerber changed the title ~~[review only] Allows code-folding for selected text in editor~~ [Review Only] Allow code-folding for selected text in editor Aug 6, 2015

thehogfather added 2 commits August 8, 2015 17:55

updated logic for restoring line folds to account for selection folds

25ae796

function that updates foldcache now also accounts for selection folds

Merge branch 'master' of https://github.com/adobe/brackets into fold-…

2e0adde

…selected

thehogfather added 5 commits August 8, 2015 18:34

Merge branch 'master' of https://github.com/adobe/brackets into code-…

8e9dbee

…folding-unit-tests

fix for the creation of multiple fold range widgets for a single coll…

853b5d1

…apsed region.

documented and refactored restoreLineFolds function

eb419aa

documented and refactored restoreLineFolds function

dd3be9f

thehogfather changed the title ~~[Review Only] Allow code-folding for selected text in editor~~ Allow code-folding for selected text in editor Aug 11, 2015

thehogfather added 4 commits August 11, 2015 19:05

fixed refresh rendering bug with selection based fold

0545f9d

Revert "documented and refactored restoreLineFolds function"

f1e4472

This reverts commit eb419aa.

removed unit test files

3603849

abose added this to the Release 1.5 milestone Aug 12, 2015

abose added the F Code Folding label Aug 12, 2015

abose added a commit that referenced this pull request Sep 11, 2015

Merge pull request #11538 from thehogfather/fold-selected

1ee6733

Allow code-folding for selected text in editor

abose merged commit 1ee6733 into adobe:master Sep 11, 2015

thehogfather deleted the fold-selected branch August 10, 2016 20:27

core-ai-bot mentioned this pull request Aug 30, 2021

[CLOSED] Allow code-folding for selected text in editor brackets-archive/bracketsIssues#10030

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow code-folding for selected text in editor #11538

Allow code-folding for selected text in editor #11538

thehogfather commented Aug 3, 2015

nethip commented Aug 4, 2015

marcelgerber Aug 4, 2015

thehogfather Aug 4, 2015

abose commented Aug 4, 2015

thehogfather commented Aug 5, 2015

abose commented Aug 6, 2015

petetnt commented Aug 7, 2015

thehogfather commented Aug 8, 2015

thehogfather commented Aug 12, 2015

nethip commented Sep 9, 2015

abose commented Sep 11, 2015

Maetzzen commented Oct 16, 2015

ezequias commented Oct 16, 2015

thehogfather commented Oct 16, 2015

Maetzzen commented Oct 16, 2015

ezequias commented Oct 16, 2015

thehogfather commented Oct 16, 2015

Maetzzen commented Oct 16, 2015

thehogfather commented Oct 16, 2015

petetnt commented Oct 17, 2015

thehogfather commented Oct 17, 2015

ezequias commented Oct 20, 2015

rainje commented Nov 4, 2015

ezequias commented Nov 7, 2015

Pandahisham commented Jan 22, 2016

Allow code-folding for selected text in editor #11538

Allow code-folding for selected text in editor #11538

Conversation

thehogfather commented Aug 3, 2015

nethip commented Aug 4, 2015

marcelgerber Aug 4, 2015

Choose a reason for hiding this comment

thehogfather Aug 4, 2015

Choose a reason for hiding this comment

abose commented Aug 4, 2015

thehogfather commented Aug 5, 2015

abose commented Aug 6, 2015

petetnt commented Aug 7, 2015

thehogfather commented Aug 8, 2015

thehogfather commented Aug 12, 2015

nethip commented Sep 9, 2015

abose commented Sep 11, 2015

Maetzzen commented Oct 16, 2015

ezequias commented Oct 16, 2015

thehogfather commented Oct 16, 2015

Maetzzen commented Oct 16, 2015

ezequias commented Oct 16, 2015

thehogfather commented Oct 16, 2015

Maetzzen commented Oct 16, 2015

thehogfather commented Oct 16, 2015

petetnt commented Oct 17, 2015

thehogfather commented Oct 17, 2015

ezequias commented Oct 20, 2015

rainje commented Nov 4, 2015

ezequias commented Nov 7, 2015

Pandahisham commented Jan 22, 2016