New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code folder uses sub-optimal conventions and processes #824

Closed

glennsarti opened this issue Dec 14, 2018 · 0 comments

Labels

Area-Folding Issue-Enhancement

Contributor

glennsarti commented Dec 14, 2018

The syntax aware code folder was initially adapted from the Typescript version. However when porting to C# the behaviour was correct but the implementation was slow and created many objects.

This ticket tracks the effort to speed up the code folding provider.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

66db01e

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

174f0cb

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti mentioned this issue

(GH-824)(GH-812) Improve code folding speed #825

Merged

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

97d0129

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

fd881f7

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

fc65ffe

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

9e1b625

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

ce3b9bf

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

SydneyhSmith added Area-Folding Issue-Enhancement labels

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

055d728

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

ec9b51a

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

1f4696f

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

64fb15b

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

e487d6b

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

beb81d2

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

a3f4495

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

7f9972d

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

b2df541

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

5d8916c

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

fd89b7a

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor the FoldingReference arrays and lists int…

63a8a7c

…o it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing.  This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class.  This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server.  This reduces the number of array enumerations to one.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

ca50b3c

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

0da7198

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) Refactor Token Folding Operations

607274b

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists.  This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue


          (PowerShellGH-824) More strict block comment folding detection

4ce90d9

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

TylerLeonhardt closed this as completed in #825

TylerLeonhardt pushed a commit that referenced this issue


          (GH-824)(GH-812) Improve code folding speed (#825)

81b3cee

* (maint) Add tests for code folding for PowerShell classes

Previously there were no tests for PowerShell classes. This commit adds a simple
test for this scenario to ensure future changes do not break folding.

* (GH-824) Refactor the FoldingReference arrays and lists into it's own class

Previously the folding provider created many intermediate arrays and lists and
required post-processing. This commit changes the behaviour to use an
accumlator patter with an extended Dictionary class. This new class adds a
`SafeAdd` method to add FoldingRanges, which then has the logic to determine if
the range should indeed be added, for example, passing nulls or pre-existing
larger ranges.

By passing around this list using ByReference we can avoid creating many objects
which are just then thrown away.

This commit also moves the ShowLastLine code from the FoldingProvider into the
Language Server. This reduces the number of array enumerations to one.

* (GH-824) Refactor Token Folding Operations

Previously each token type detection was separated into discrete blocks
to make reading the code easier. However this meant there were many
enumerations of the Tokens array as well as passing around intermediate
arrays/lists. This commit takes the individual methods and overlaps them
to reduce the number of enumerations and regular expression matching to
a minimum.

Note that there are considerable code comments here due to the code now
being more complex on initial review.

* (GH-812) Update folder for DSC style scripts

Previously the code folding was not tested against DSC configuration scripts.
This commit adds tests for a sample DSC script to ensure the folding occurs at the correct
places

* (GH-824) More strict block comment folding detection

Previously the folder would search for the region markers without case sensitivity.
This commit modifies the regular expressions to be more strict on the what
is a region marker and adds a negative test to ensure that regions that are not
cased correctly are not folded .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment