From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Simon Pugnet <simon@polaris64.net>
Newsgroups: gmane.emacs.devel
Subject: Tree sitter: issue embedding HTML, CSS, JavaScript within a new
 php-ts-mode
Date: Thu, 09 Feb 2023 12:45:19 +0000
Message-ID: <87o7q3ngu8.fsf@polaris64.net>
Mime-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-=";
 micalg=pgp-sha256; protocol="application/pgp-signature"
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="32079"; mail-complaints-to="usenet@ciao.gmane.io"
To: Emacs developers <emacs-devel@gnu.org>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Feb 09 14:50:38 2023
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Envelope-to: ged-emacs-devel@m.gmane-mx.org
Original-Received: from lists.gnu.org ([209.51.188.17])
	by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1pQ7Js-00085S-Rh
	for ged-emacs-devel@m.gmane-mx.org; Thu, 09 Feb 2023 14:50:37 +0100
Original-Received: from localhost ([::1] helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces@gnu.org>)
	id 1pQ7JF-00086n-Tp; Thu, 09 Feb 2023 08:49:57 -0500
Original-Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <simon@polaris64.net>)
 id 1pQ6NT-0006wT-W4
 for emacs-devel@gnu.org; Thu, 09 Feb 2023 07:50:16 -0500
Original-Received: from mout-p-102.mailbox.org ([80.241.56.152])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_CHACHA20_POLY1305:256)
 (Exim 4.90_1) (envelope-from <simon@polaris64.net>)
 id 1pQ6NR-0001yt-KL
 for emacs-devel@gnu.org; Thu, 09 Feb 2023 07:50:15 -0500
Original-Received: from smtp102.mailbox.org (smtp102.mailbox.org
 [IPv6:2001:67c:2050:b231:465::102])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest
 SHA256) (No client certificate requested)
 by mout-p-102.mailbox.org (Postfix) with ESMTPS id 4PCGt90Hx1z9sWp
 for <emacs-devel@gnu.org>; Thu,  9 Feb 2023 13:50:09 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=polaris64.net;
 s=MBO0001; t=1675947009;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:mime-version:mime-version:content-type:content-type;
 bh=F11GoER3/hBbvizDT/q139IONttKfFzMH8gyHj46pnA=;
 b=xWGBZK4/ECn8fm039Fng3TTPsN+kn0McUBW3l070MPqqV99eM9qPV7FuljTxxz1qq/4H/X
 5BG9X64Xo2pEpcraY8U3xEppPtaWsMCTPqoGW/EVtGn+ZmneK6wz9OLBPm49X7reWPgeG/
 GYt48GSHIg1Qb0JqaZoNGThNigmrDDtlCKGxpvqVUhXmrETFenvn1AcZu0IHtfYWii/aJW
 +hVEAqm/xjf2Ho/q9mKS2wrmflnut6tPSNIv2QG32jojFU2h4tl+u1XKen7tcHdu5Rt4CC
 MrZpRIr6hOTp3MRs7YK5jS+kzOpyg858fJmYdV3TWGoqcXrMse8NrS4Wvx6QMw==
X-Rspamd-Queue-Id: 4PCGt90Hx1z9sWp
Received-SPF: pass client-ip=80.241.56.152; envelope-from=simon@polaris64.net;
 helo=mout-p-102.mailbox.org
X-Spam_score_int: -27
X-Spam_score: -2.8
X-Spam_bar: --
X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Mailman-Approved-At: Thu, 09 Feb 2023 08:49:56 -0500
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Emacs development discussions." <emacs-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=subscribe>
Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org
Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org
Xref: news.gmane.io gmane.emacs.devel:303078
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/303078>

--=-=-=
Content-Type: text/plain; format=flowed

Dear Emacs maintainers,

I have recently started work on a PHP tree sitter major mode. Things 
are going well so far, however I'm having trouble with embedding 
multiple languages in the PHP buffer.

In case you're not familiar with PHP, here's a quick example (I'm 
using org-mode mark-up in this message which hopefully will help): -

#+begin_src php
  <html lang="en-gb">
    <head>
      <style type="text/css">
       body {
         background: url("/background.png");
         color: #ff0000;
       }
      </style>
    </head>

    <body>
      <?php
      $a = [1, 2, "3", 4.5];
      if (is_array($a)) {
        echo "$a is an array";
      } else {
        echo "$a is not an array";
      }
      ?>

      <div id="my-div">
        <h1>This is a test</h1>
      </div>

      <script type="text/javascript">
       const div = document.getElementById('my-div');
       // This is a JS comment
       /* This too */
       console.log("my-div is:", div);
      </script>

      <?php // Some more PHP here ?>

    </body>
  </html>
#+end_src

As you can see, PHP code is usually encapsulated within a HTML 
document, with PHP code enclosed within ~<?php ... ?>~ blocks.

The first block of HTML from the beginning of the buffer to the first 
~<?php~ is enclosed within a ~(program (text))~ node. The second 
(after ~?>~ and before the second ~<?php~) is enclosed within a 
~(text_interpolation (text))~ node. I have therefore defined the 
following ~treesit-range-settings~ in my major mode: -

#+begin_src emacs-lisp
  (setq-local treesit-range-settings
              (treesit-range-rules
               :embed 'html
               :host 'php
               '((program (text) @capture)
                 (text_interpolation (text) @capture))))
#+end_src

This seems to work however when I evaluate ~(treesit-language-at 
(point))~ anywhere in this buffer I get ='html= in response. This is 
of course expected within a HTML region, but not within a PHP region. 
Despite this, the font-locking I have defined for PHP appears to work 
correctly. I have also defined a custom face and applied it via 
font-locking to the above two nodes to confirm that those regions are 
indeed enclosed as expected and they are.

My hope eventually is to use the following ~treesit-range-settings~: -

#+begin_src emacs-lisp
  (setq-local treesit-range-settings
                  (treesit-range-rules
                   :embed 'html
                   :host 'php
                   '((program (text) @capture)
                     (text_interpolation (text) @capture))

                   :embed 'css
                   :host 'html
                   '((style_element (raw_text) @capture))

                   :embed 'typescript
                   :host 'html
                   '((script_element (raw_text) @capture))))
#+end_src

As well as defining these rules, I require =css-mode= and 
=typescript-ts-mode= and append their own font-locking rules to my 
own. My hope is that this will allow CSS and JavaScript embedded 
within HTML regions to be font-locked according to those separate 
major modes too. This appears to work for simple files but does not 
work reliably for more complex files. Also when using the above I get 
='typescript= whenever I evaluate ~(treesit-language-at (point))~. I'm 
not sure if this is just a bug with the language grammars that I'm 
using or if perhaps because I'm not using the treesit library 
correctly. Because of the issue with ~treesit-language-at~ above I'm 
concerned that it's the latter.

So my questions are: -

1. Based on my rules for embedding ='html= within ='php= above, should 
I expect ~(treesit-language-at (point))~ to return ='php= when the 
point is within a PHP region?
2. Is my goal of embedding HTML within PHP, then embedding CSS and 
JavaScript/TypeScript within HTML feasible and if so am I going about 
this in the right way?

Thank you in advance for your help and thank you for all of your work 
on Emacs and the tree sitter integration.

Kind regards,

-- 
Simon Pugnet
https://www.polaris64.net/

--=-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQJIBAEBCAAyFiEEO/eF3hYsAMj7Tab9uhNZqCwLPvkFAmPk6/8UHHNpbW9uQHBv
bGFyaXM2NC5uZXQACgkQuhNZqCwLPvldeA/+I4KX4ejuwsiS1HSESPHVTRGLg9tL
lVkQpVoM2AXGuFHhQ7f9ILBHR+/w1t+dtVlJYTKi/alZL4wfHk04s+gnW7Sr2LS4
MJMP31Ujof9s+XOYxhIjcNg4LmMw8K87QQ5kgySJbnKw5PrRW/Oar2All7a/n10u
jufBW9eYQSY2jZX6vkjjbhCFe71Yk1y1K98dPNseOB/a2YhJzd3Ho+8QlilkzOQq
nVZRp7HMzgyfQzotfbM9EO2FdWVzEvk/BZaTZLiRxMjGi+c9Fkht9aDRcldCyk3q
xvyok7CBTbdtSQjo+EM0fJ/Ep3RVPOiAzT7qQPTZ2kn3olQT3or53DQhrW9vF6ox
XrtLAi//IZC36BXJF1aPZlYOJVCmL613tg6LOvM5jfhSgfGqIPHFHyupbYwm12WK
GGYTPRbGvLml8AZpw08bXa0lI5whxTSkHcBHmb61c5jmQM9XswpJEJCHeM5H7fyK
ySSlPO9me2sIaitA2nWc0gFnAe7K8kQ1+iIx3eNsi/2FIn8pIPrjh2l1kAPL/5di
3A5nX3PpnV2BdWayQGVhxMH9QgWkkOdhtugJmQTH432pWlkAyyHUaIKUoa+J8YGd
82M8O3kmJQ7BOfUO9c393SUwTH/jRki4xTMtKbVmrteifeeE5+aFlBuPkLh3bnRo
+Xm8BMuIFZOWV/Q=
=QMyD
-----END PGP SIGNATURE-----
--=-=-=--