format: fix indentation for hotkeys {:: and }:: #12

FuPeiJiang · 2020-12-04T22:17:48Z

having {:: or }:: as hotkey breaks the indentation...
you can reproduce issue with \format_test_cases\{} match testing.ahk

3 commits from fade2gray (Nov 13, 2020) https://github.com/fade2gray/vscode-autohotkey-plus-plus/tree/master grammar: createEditorListenr->createEditorListener

please do not use regex when not necessary added purity_greedy in codeUtil.ts

mark-wiemer

Although I'm not super familiar with formattingProvider.ts yet, I'm comfortable merging to dev once you make the requested changes. The "If you like" comments are bonus points 😄

.vscode/settings.json

format_test_cases/{} match testing.ahk

package.json

mark-wiemer · 2020-12-13T20:21:28Z

src/provider/formattingProvider.ts

@@ -55,7 +55,8 @@ export class FormatProvider implements vscode.DocumentFormattingEditProvider {
                }
                continue;
            }
-            const purityText = CodeUtil.purity(originText.toLowerCase());
+            const purityText = CodeUtil.purity_greedy(originText.toLowerCase());
+            // console.log(purityText)


Remove this commented out console log

mark-wiemer · 2020-12-13T20:22:02Z

src/provider/formattingProvider.ts

            if (purityText.match(/\b(return)\b/i) && tagDeep === deep) {
-                tagDeep == 0;
+                tagDeep == 0; //this does nothing


If this line does nothing, then remove it. If we cannot verify whether it does anything, we should leave it in with a // TODO: does this do anything? comment

mark-wiemer · 2020-12-13T20:55:51Z

src/common/codeUtil.ts

+    public static purity_greedy(origin: string): string {
+        if (!origin) return '';
+        // TODO: untest
+        return origin
+            .replace(/;.+/, '')
+            .replace(/".*?"/g, '')
+            .replace(/\{.*\}/g, '')
+            .replace(/ +/g, ' ')
+            .replace(/\bgui\b.*/gi, '')
+            .replace(/\b(msgbox)\b.+?%/gi, '$1');
+    }
+
+    public static purity(origin: string, greedy: boolean = false): string {


No need to make this a new function, just remove the unused greedy parameter from purity instead and call that. I see you also remove some unnecessary ? matchers, feel free to remove those from the original purity as well.

I added that greedy parameter, and decided against it, because this is called EVERY line, and if statement is expensive,

what would be cool would be to replace purity with purity_greedy everywhere, but idk if it's a breaking change

I forgot to remove that unused parameter

It shouldn't be a breaking change. What is the difference between purity_greedy and purity? I see none. Just use purity since we now have two functions doing the same thing.

it really isn't clear. it doesn't even show it.
line 12
.replace(/\{.*\}/g, '')
line 24
.replace(/\{.*?\}/g, '')

I noticed that. Removing the ? from the regex does make it appear simpler, but they have the same functionality. Since the ? follows a *, it never does anything. The * following the . captures 0 or more instances of any char and the ? captures 0 or 1 instance(s) of any char. With or without the ?, the regex captures 0 or more instances of any char.

If I'm wrong, please provide a counterexample. For simplicity, consider be*?d and note that it captures:

bd

bed

beed

Now consider be*d. It captures the exact same things.

I recommend you go ahead and replace all *? with * for simplicity. I can manually test the functionalities that depend on purity if you don't feel comfortable doing it. I still don't see any cause for having both purity_greedy and purity since they do the same thing.

regex lesson: normally ? means 0 or 1 instance(s), but when ? is placed after *, it transforms the * into lazy, because * is greedy by Default

you can use https://regexr.com/ or https://regex101.com/ to help understand regex.

counterexample (use one of the 2 websites), the RegExp is code and line below RegExp is the text string:
\{.*\}
fwefwefwef{very greedy } more cake}wefwefwefwef

\{.*?\}
fwefwefwef{nope, I've had enough } more cake}wefwefwefwef

I will have to find and understand the other use cases

Gotcha. Then of course don't change the regex! I will say, this PR is a bit stale. I am looking into fixing the last January bug now (#18), hopefully I will learn a bit about the formatter

src/provider/formattingProvider.ts

mark-wiemer · 2020-12-13T21:12:06Z

src/provider/formattingProvider.ts

-                deep -= temp;
-                if (temp > 0) {
-                    notDeep = false;
+            if (purityText.includes("}")) {


Wrap strings in single quotes, not double quotes, throughout.

e.g. if (purityText.includes('}')) {

suggestion: add eslint to devDependencies and in .vscode/settings.json

"editor.codeActionsOnSave": { "source.fixAll.eslint": true },

Sure, we can do that in another PR. ESLint is on the backlog. For now, would you mind changing them manually? If not, I suppose I can still merge the PR.

mark-wiemer · 2020-12-13T22:16:39Z

src/common/codeUtil.ts

+            .replace(/\b(msgbox)\b.+?%/gi, '$1');
+    }
+
+    public static purity(origin: string, greedy: boolean = false): string {
        if (!origin) return '';
        // TODO: untest


If you'd like, I'd appreciate removing this comment, I don't know what it means.

mark-wiemer · 2020-12-13T22:20:15Z

src/provider/formattingProvider.ts

                }
+                notDeep = false;
            }

            if (oneCommandCode && purityText.match(/{/) != null) {


If you'd like, you can remove this use of regex: ... && purityText.includes('{')) {

FuPeiJiang · 2020-12-15T21:34:42Z

I can remove "unwanted" stuff.
But, I want to keep some "unwanted" stuff in my personal branch, (for example, closure compiler.ahk)

I don't want to remove my stuff EVERY TIME I want to merge here.
I need a way to make a branch, based off my personal branch, but subtracted from the "unwanted" stuff
so the unwanted stuff will be automatically removed every time I "subtract-merge" into the pull request branch

the unwanted stuff can even be lines, or EVEN words, in file
so, not restricted to file subtraction.

Is there already a way to do this ?
if no, I will try to make something

mark-wiemer · 2020-12-16T03:38:47Z

RE removing unwanted stuff: there's always a way! Git is pretty good with ignoring entire files, as I'm sure you know. Just add something to the .gitignore. You can also look up "git update-index --assume-unchanged".

What things are you talking about, specifically? I think we can figure out a way to manage this better when I know the specifics. Please open a new discussion so we can discuss this further, I don't want to clutter the PR thread with a general discussion

mark-wiemer · 2021-01-03T17:46:56Z

Hi @FuPeiJiang, would you mind making these changes? I would love to finally merge this

mark-wiemer · 2021-03-03T05:43:40Z

@FuPeiJiang any plans to update this PR?

mark-wiemer · 2022-03-30T07:23:23Z

Closing as stale, @FuPeiJiang you're welcome to re-investigate this issue and open another PR.

FuPeiJiang added 3 commits December 4, 2020 16:56

package.json: enum all 4 AutoHotkey.exe path (for easy toggle)

285f426

3 commits from fade2gray (Nov 13, 2020) https://github.com/fade2gray/vscode-autohotkey-plus-plus/tree/master grammar: createEditorListenr->createEditorListener

format: indentation for hotkeys {:: and }::

38bdb81

please do not use regex when not necessary added purity_greedy in codeUtil.ts

\format_test_cases\{} match testing.ahk

8ed4c22

mark-wiemer self-requested a review December 13, 2020 19:30

mark-wiemer self-assigned this Dec 13, 2020

mark-wiemer changed the base branch from master to dev December 13, 2020 22:15

mark-wiemer requested changes Dec 13, 2020

View reviewed changes

mark-wiemer closed this Mar 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

format: fix indentation for hotkeys {:: and }:: #12

format: fix indentation for hotkeys {:: and }:: #12

FuPeiJiang commented Dec 4, 2020 •

edited

Loading

mark-wiemer left a comment

mark-wiemer Dec 13, 2020

mark-wiemer Dec 13, 2020

mark-wiemer Dec 13, 2020

FuPeiJiang Jan 3, 2021

mark-wiemer Jan 3, 2021

FuPeiJiang Jan 4, 2021

mark-wiemer Jan 5, 2021

mark-wiemer Jan 5, 2021 •

edited

Loading

FuPeiJiang Jan 5, 2021

mark-wiemer Jan 30, 2021

mark-wiemer Dec 13, 2020

FuPeiJiang Jan 3, 2021

mark-wiemer Jan 3, 2021

mark-wiemer Dec 13, 2020

mark-wiemer Dec 13, 2020

FuPeiJiang commented Dec 15, 2020

mark-wiemer commented Dec 16, 2020

mark-wiemer commented Jan 3, 2021

mark-wiemer commented Mar 3, 2021

mark-wiemer commented Mar 30, 2022

format: fix indentation for hotkeys {:: and }:: #12

format: fix indentation for hotkeys {:: and }:: #12

Conversation

FuPeiJiang commented Dec 4, 2020 • edited Loading

mark-wiemer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mark-wiemer Jan 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FuPeiJiang commented Dec 15, 2020

mark-wiemer commented Dec 16, 2020

mark-wiemer commented Jan 3, 2021

mark-wiemer commented Mar 3, 2021

mark-wiemer commented Mar 30, 2022

FuPeiJiang commented Dec 4, 2020 •

edited

Loading

mark-wiemer Jan 5, 2021 •

edited

Loading