include php blade plugin in php cluster #7618

haidubogdan · 2024-07-29T04:39:29Z

Laravel is one of the most used frameworks in php, yet it still doesn't have support in Netbeans. (#7531 , #7231).
Mostly the main missing support is for blade templates syntax.

I've started to work on a plugin https://github.com/haidubogdan/netbeans-php-blade-plugin 3 years ago.
After using antlr as a lexer and parser, I found that scaling the plugin was much maintainable.
It's not the cleanest code, but I realized that I will always reach to the 99% finish status if I don't do the first pull request.

Most of the available features to be included are listed at https://github.com/haidubogdan/netbeans-php-blade-plugin.

syntax highlighting
blade syntax completion
declaration finder for specific blade template
....

And some are still missing

php embedded syntax validation
more advanced php syntax completion.

All feedbacks are welcome, I hope to reach nb 23 deployment :) .

TODO

Submit an ICLA (sent on 3 august)
Change to the full name in commits
Check the license of the image (no response received from Tailor [laravel], using personal icon)
Add unit tests
Write all features with screenshots

junichi11 · 2024-07-30T05:03:14Z

First of all, thank you for your contribution!

I hope to reach nb 23 deployment

Unfortunately, it's too late. The feature freeze date is July 26th.

Please write all features of this module with screenshots here as well. (not only the link)

Please add unit tests for features. e.g. code completion, indexer, navigator, parser, lexer, formatter etc. (also see: CslTestBase.java)

Did you submit an ICLA?

Probably, it takes a lot of time to review this.

php/php.blade/nbproject/project.xml

php/php.blade/src/org/netbeans/modules/php/blade/editor/BladeBracesMatcher.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/BladeDeclarationFinder.java

php/php.editor/nbproject/project.xml

php/php.blade/test/unit/src/org/netbeans/modules/php/blade/syntax/antlr4/BladeUtils.java

haidubogdan · 2024-07-30T05:25:38Z

Hi,
thank you for your feedback.
I will prepare the unit tests. ( I hope the base parser unit test classes will be available now that it's included in the IDE folder).
I didn't submit the ICLA. I will read about it.

php/php.blade/test/unit/src/org/netbeans/modules/php/blade/syntax/antlr4/BladeUtils.java

php/php.blade/src/org/netbeans/modules/php/blade/ui/options/BladeOptionsPanel.form

php/php.blade/src/org/netbeans/modules/php/blade/ui/options/BladeOptionsPanel.java

php/php.blade/src/org/netbeans/modules/php/blade/ui/options/BladeOptionsPanelController.java

php/php.blade/src/org/netbeans/modules/php/blade/ui/options/Bundle.properties

php/php.blade/test/unit/src/data/testfiles/coloring_lexer/issues/issue61/issue61.blade.php

...t/unit/src/org/netbeans/modules/php/blade/syntax/antlr4/BladeAntlrColoringLexerTestBase.java

junichi11 · 2024-07-31T00:38:40Z

How did you generate icons? (Are there icons based on something?)

https://github.com/apache/netbeans/pull/7618/files#diff-24c53d9c7defe885e1ee8adee9ff009c57d69e75621ad84625d8f9eaa8d7c9e1

php/php.blade/src/org/netbeans/modules/php/blade/editor/ResourceUtilities.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/EditorStringUtils.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/indexing/PhpIndexUtils.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/indexing/QueryUtils.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/BladeDeclarationFinder.java

junichi11 · 2024-08-27T00:52:06Z

php/php.blade/src/org/netbeans/modules/php/blade/resources/icons/icon.png

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionHandler.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionItem.java

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

junichi11 · 2024-08-27T03:16:58Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+    final CompletionRequest request;
+    protected final ElementHandle element;
+    final String previewValue;
+    protected Directive directive;


Are modifiers proper?

junichi11 · 2024-08-27T03:17:23Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+        formatter.appendHtml("<font>");
+        formatter.appendHtml("<b>");
+        formatter.appendText(previewValue);
+        formatter.appendHtml("</b>");
+        formatter.appendHtml("</font>");


// NOI18N

junichi11 · 2024-08-27T03:17:45Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+            }
+            if (file != null) {
+                formatter.reset();
+                formatter.appendText(" ");


// NOI18N

junichi11 · 2024-08-27T03:19:20Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+        @Override
+        public String getCustomInsertTemplate() {
+            if (namespace != null && namespace.length() > 0) {
+                return "\\" + namespace + "\\" + element.getName();


Can change these("\\") to constants?

junichi11 · 2024-08-27T03:20:48Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+
+        @Override
+        public String getRhsHtml(HtmlFormatter formatter) {
+            return "blade";


// NOI18N
the other strings as well

junichi11 · 2024-08-27T03:23:19Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+            if (this.getElement().getFileObject() != null) {
+                return this.getElement().getFileObject().getNameExt();
+            }
+            return "custom directive";


Please check whether we should consider i18n

junichi11 · 2024-08-27T03:27:04Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProvider.java

+ */
+@MimeRegistrations(value = {
+    @MimeRegistration(mimeType = "text/html", service = CompletionProvider.class),
+    @MimeRegistration(mimeType = "text/x-blade", service = CompletionProvider.class)


Suggested change

@MimeRegistration(mimeType = "text/x-blade", service = CompletionProvider.class)

@MimeRegistration(mimeType = BladeLanguage.MIME_TYPE, service = CompletionProvider.class)

junichi11 · 2024-08-27T03:28:39Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProvider.java

+                        }
+                        break;
+                    case HTML_COMPONENT_PREFIX:
+                        String compPrefix = currentToken.getText().length() > 3 ? StringUtils.kebabToCamel(currentToken.getText().substring(3)) : "";


What does 3 mean?
// NOI18N

junichi11 · 2024-08-27T03:29:13Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProvider.java

+            } finally {
+                long time = System.currentTimeMillis() - startTime;
+                if (time > 2000){
+                    LOGGER.log(Level.INFO, "Slow completion time detected. {0}ms", time);


// NOI18N

junichi11 · 2024-08-27T03:30:10Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProvider.java

+                if (customDirective.name.startsWith(prefix)) {
+                    resultSet.addItem(DirectiveCompletionBuilder.itemWithArg(
+                            startOffset, carretOffset, prefix, customDirective.name,
+                            "custom directive", doc, file));


// NOI18N

junichi11 · 2024-08-27T03:31:38Z

...p.blade/src/org/netbeans/modules/php/blade/editor/completion/BladePhpCompletionProvider.java

+ * @author bhaidu
+ */
+@MimeRegistrations(value = {
+    @MimeRegistration(mimeType = "text/x-php5", service = CompletionProvider.class, position = 102),


Suggested change

@MimeRegistration(mimeType = "text/x-php5", service = CompletionProvider.class, position = 102),

@MimeRegistration(mimeType = FileUtils.PHP_MIME_TYPE, service = CompletionProvider.class, position = 102),

junichi11 · 2024-08-27T03:32:14Z

...p.blade/src/org/netbeans/modules/php/blade/editor/completion/BladePhpCompletionProvider.java

+            doQuery(resultSet, doc, caretOffset);
+            long time = System.currentTimeMillis() - startTime;
+            if (time > 2000) {
+                LOGGER.log(Level.INFO, "Slow completion time detected. {0}ms", time);


// NOI18N
The other strings as well.

junichi11 · 2024-09-03T04:19:10Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/components/ComponentElement.java

+    public String name;
+    public String qualifiedClassName;
+
+    public Set<String> properties = new HashSet<>();


Please reconsider visibility.

this class isn't used anywhere atm, but this looks like a potential candidate for a record in case this should stay.

junichi11 · 2024-09-03T04:24:01Z

....blade/src/org/netbeans/modules/php/blade/editor/components/ComponentsCompletionService.java

+
+public class ComponentsCompletionService {
+
+    @CheckForNull


junichi11 · 2024-09-03T04:27:18Z

...blade/src/org/netbeans/modules/php/blade/editor/declaration/ComponentDeclarationService.java

+        return results;
+    }
+
+    public FileObject getComponentResourceFile(String componentId, String classQualifiedName, FileObject sourceFo) {


@ChekcForNull
// NOI18N

junichi11 · 2024-09-03T04:27:41Z

...blade/src/org/netbeans/modules/php/blade/editor/declaration/ComponentDeclarationService.java

+        return null;
+    }
+
+    public FileObject getLivewireComponentResourceFile(String componentId, FileObject sourceFo) {


@ChekcForNull
// NOI18N

junichi11 · 2024-09-03T04:37:33Z

Please check whether we should translate yourself once for strings of all files. (add // NOI18N or @Messages)
Please check whether annotations are needed. (e.g. @CheckForNull, @NullAllowed,...)

…mpletion handler, parse, blade typed text interceptor

…ests, added more lexer tests

mbien

don't forget to hook the tests into CI so that we can let it run over this PR - just in case there are any surprises.

would look like:

netbeans/.github/workflows/main.yml

Lines 2404 to 2405 in a5fa02d

    
           - name: php.latte 
        
             run: ant $OPTS -f php/php.latte test

and someone can trigger the workflow once done

mbien · 2024-09-13T23:26:54Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionItem.java

+            String template = getItemText() + "($$${arg})\n\n${selection}${cursor}\n" + getEndTag(); // NOI18N
+
+            switch (getName()) {
+                case BladeDirectivesUtils.DIRECTIVE_FOREACH ->
+                    template = getItemText() + "($$${array} as $$${item})\n${selection}${cursor}\n" + getEndTag(); // NOI18N
+            }
+
+            return template;


this would build the template string only once:

return switch (getName()) { case DIRECTIVE_FOREACH ... default ... };

mbien · 2024-09-13T23:28:11Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionItem.java

+            String template = getItemText() + "($$${arg})"; // NOI18N
+            switch (getName()) {
+                case BladeDirectivesUtils.DIRECTIVE_INCLUDE,
+                        BladeDirectivesUtils.DIRECTIVE_EXTENDS ->
+                    template = getItemText() + "('${path}')"; // NOI18N
+            }
+            return template;


same pattern here

mbien · 2024-09-13T23:34:24Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/cache/QueryCache.java

+        return this.cacheMap.keySet().parallelStream()
+                .filter(this::isExpired)
+                .collect(Collectors.toSet());


you sure parallelStream() is a good idea here? It always comes with setup and runtime overhead and all this stream does is to filter a set - so the parallel task itself is tiny.

I would only recommend using parallel streams if it is also demonstrated in a benchmark that they make a difference in that usecase.

mbien · 2024-09-13T23:42:13Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/completion/BladeCompletionProposal.java

+            String template = getName() + "($$${arg})\n    ${cursor}\n" + directive.endtag();
+
+            switch (getName()) {
+                case "@foreach": // NOI18N
+                    template = getName() + "($$${array} as $$${item})\n    ${selection}${cursor}\n" + directive.endtag();
+                    break;
+                case "@section": // NOI18N
+                case "@session": // NOI18N
+                    template = getName() + "('${id}')\n    ${cursor}\n" + directive.endtag();
+                    break;
+            }
+
+            return template;


same pattern here. The initial assignment can be moved into the default case.

mbien · 2024-09-13T23:55:02Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/components/ComponentElement.java

+    public String name;
+    public String qualifiedClassName;
+
+    public Set<String> properties = new HashSet<>();


this class isn't used anywhere atm, but this looks like a potential candidate for a record in case this should stay.

mbien · 2024-09-14T00:34:36Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/lexer/BladeLexerUtils.java

+    public static final List<Integer> TOKENS_WITH_IDENTIFIABLE_PARAM = Arrays.asList(new Integer[]{
+        D_EXTENDS, D_INCLUDE, D_INCLUDE_IF, D_INCLUDE_WHEN,
+        D_INCLUDE_UNLESS, D_EACH, D_SECTION, D_HAS_SECTION, D_SECTION_MISSING,
+        D_PUSH, D_PUSH_IF, D_PREPEND, D_USE, D_INJECT, D_ASSET_BUNDLER
+    });


List.of would make this immutable. Should this be a Set? (see next comment)

mbien · 2024-09-14T00:42:34Z

php/php.blade/src/org/netbeans/modules/php/blade/syntax/antlr4/v10/BladeAntlrUtils.java

+    public static Token findForward(Document doc, Token start,
+            List<String> stopTokenText, List<String> openTokensText) {


the find* methods in this utility call contains on lists. It could be worth checking if this could be sets instead or Collection, so that the caller can decide when to pass a List or a Set. (set will have the faster contains call)

mbien · 2024-09-14T00:44:55Z

...p.blade/src/org/netbeans/modules/php/blade/editor/completion/BladePhpCompletionProvider.java

+                List<Integer> tokensMatch = Arrays.asList(new Integer[]{
+                    D_EXTENDS, D_INCLUDE, D_SECTION, D_HAS_SECTION,
+                    D_INCLUDE_IF, D_INCLUDE_WHEN, D_INCLUDE_UNLESS, D_INCLUDE_FIRST,
+                    D_EACH, D_PUSH, D_PUSH_IF, D_PREPEND
+                });
+
+                List<Integer> tokensStop = Arrays.asList(new Integer[]{HTML, BL_COMMA, BL_PARAM_CONCAT_OPERATOR});


constants and Set.of()?

mbien · 2024-09-14T00:57:52Z

php/php.blade/src/org/netbeans/modules/php/blade/editor/ui/customizer/UiOptionsUtils.java

+        List<String> result = new ArrayList<>();
+        while (list.hasMoreElements()) {
+            result.add(list.nextElement());
+        }
+
+        return String.join("|", result);


->

return String.join("|", Collections.list(list));

mbien · 2024-09-14T01:31:09Z

php/php.blade/src/org/netbeans/modules/php/blade/syntax/antlr4/v10/BladeAntlrLexer.java

+	private static final String _serializedATNSegment0 =
+		"\u0004\u0000\u00ab\u0b4c\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff"+
+		"\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff"+
+		"\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff"+
+		"\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0006\uffff\uffff\u0002\u0000"+
+		"\u0007\u0000\u0002\u0001\u0007\u0001\u0002\u0002\u0007\u0002\u0002\u0003"+
+		"\u0007\u0003\u0002\u0004\u0007\u0004\u0002\u0005\u0007\u0005\u0002\u0006"+


regarding generated code. I believe we ended up agreeing to try to generate antlr outputs during build but don't commit it to the repo. The reason is because generated antlr code is not very "stable", it produces huge diffs when the version updates and those aren't reviewable anyway. (e.g the marked section)

The second reason would be antlr updates, this makes sure the code fits to the version if someone happens to update the antlr lib at some point.

example: #7189, #7186 etc

cc @neilcsmith-net @lkishalmi

ebarboni requested a review from junichi11 July 29, 2024 08:56

junichi11 added the PHP [ci] enable extra PHP tests (php/php.editor) label Jul 30, 2024

junichi11 requested a review from tmysik July 30, 2024 05:03

junichi11 added this to the NB24 milestone Jul 30, 2024