update font rules, indention, faces and readme

Author: craynot

.gitignore

@@ -1,4 +1,8 @@
 *.elc
 php-ts-mode-autoloads.el
+php-ts-mode-pkg.el
 /.eask
 /dist
+# emacs tmp files
+*~
+*#

README.md

@@ -16,6 +16,25 @@ If you haven't installed Tree-sitter yet, please read [How to Get Started with T
 
 [How to Get Started with Tree-Sitter - Mastering Emacs]: https://www.masteringemacs.org/article/how-to-get-started-tree-sitter
 
+Package can be installed by running the following command.
+
+```
+M-x package-vc-install [RET] https://github.com/emacs-php/php-ts-mode
+```
+
+### Configuration
+
+Example configuration that you can put in your `.emacs` file
+
+```
+;; Enable variables highlighting
+(customize-set-variable 'treesit-font-lock-level 4)
+
+(add-hook 'php-ts-mode-hook (lambda ()
+			      ;; Use spaces for indent
+			      (setq-local indent-tabs-mode nil)))
+```
+
 ### Grammer installation
 
 If you don't already have `php-ts-mode` installed, please evaluate the Lisp code below.
@@ -36,7 +55,7 @@ In `php-ts-mode`, syntax elements are classified as follows.
  * **Level 1**: `comment` `definition` `preprocessor`
  * **Level 2**: `keyword` `string` `type`
  * **Level 3**: `function` `constant` `label`
- * **Level 4**: `bracket` `delimiter` `operator` `variables`
+ * **Level 4**: `bracket` `delimiter` `operator` `variables` `this`
 
 By default, up to **Level 3** will be highlighted.
 

php-ts-face.el

@@ -0,0 +1,44 @@
+;;; php-ts-face.el --- Face definitions for PHP script  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023  Friends of Emacs-PHP development
+
+;; Author: USAMI Kenta <[email protected]>
+;; Created: 5 May 2019
+;; Version: 1.25.0
+;; Keywords: faces, php
+;; Homepage: https://github.com/emacs-php/php-mode
+;; License: GPL-3.0-or-later
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Face definitions for PHP script.
+
+;;; Code:
+
+;;;###autoload
+
+(defface php-this '((t (:inherit php-constant)))
+  "PHP Mode face used to highlight $this variables."
+  :group 'php-faces
+  :tag "PHP $this")
+
+(defface php-this-sigil '((t (:inherit php-constant)))
+  "PHP Mode face used to highlight sigils($) of $this variable."
+  :group 'php-faces
+  :tag "PHP $this Sigil")
+
+(provide 'php-ts-face)
+;;; php-ts-face.el ends here

php-ts-mode.el

@@ -36,6 +36,7 @@
 (require 'c-ts-common)
 (require 'php nil t)
 (require 'php-face nil t)
+(require 'php-ts-face nil t)
 
 (declare-function php-base-mode "ext:php")
 (declare-function treesit-parser-create "treesit.c")
@@ -77,6 +78,7 @@
        ;; "compound_statement" contains the body of many statements.
        ;; For example function_definition, foreach_statement, etc.
        ((parent-is "compound_statement") parent-bol ,offset)
+       ((parent-is "method_declaration") parent-bol 0)
        ((parent-is "array_creation_expression") parent-bol ,offset)
        ((parent-is "base_clause") parent-bol ,offset)
        ((parent-is "class_interface_clause") parent-bol ,offset)
@@ -145,7 +147,8 @@ see https://www.php.net/manual/language.constants.predefined.php")
       (named_type (name) @php-type)
       (named_type (qualified_name) @php-type)
       (namespace_use_clause)
-      (namespace_name (name))]
+      (namespace_name (name))
+      (optional_type "?" @php-type)]
      @php-type
      (class_interface_clause (name) @php-class)
      (class_constant_access_expression
@@ -176,7 +179,8 @@ see https://www.php.net/manual/language.constants.predefined.php")
      (trait_declaration
       name: (name) @php-class)
      (enum_case
-      name: (name) @php-class))
+      name: (name) @php-class)
+     (base_clause (name) @php-class))
 
    :language 'php
    :feature 'function
@@ -207,15 +211,17 @@ see https://www.php.net/manual/language.constants.predefined.php")
 
      ;; ((name) @constructor
      ;;  (:match ,(rx-to-string '(: bos (in "A-Z")))))
-
-     ;; (variable_name (name) @php-$this
-     ;;  (:match ,(rx bos "this" eos)
-     ;;          @php-$this))
      (member_access_expression name: (name) @php-property-name)
      ;;(variable_name (name) @font-lock-variable-name-face)
      (variable_name (name) @php-variable-name)
      (variable_name "$" @php-variable-sigil))
 
+   :language 'php
+   :feature 'this
+   :override t
+   `((variable_name "$" @php-this-sigil (name) @php-this
+		    (:match ,(rx bos "this" eos) @php-this)))
+
    :language 'php
    :feature 'comment
    `(((comment) @font-lock-doc-face
@@ -226,7 +232,7 @@ see https://www.php.net/manual/language.constants.predefined.php")
    :language 'php
    :feature 'string
    `([(string)
-      (string_value)
+      (string_content)
       (encapsed_string)
       (heredoc)
       (heredoc_body)
@@ -347,7 +353,7 @@ Currently there are `php-mode' and `php-ts-mode'."
               '((comment definition preprocessor)
                 (keyword string type)
                 (function constant label)
-                (bracket delimiter operator variables)))
+                (bracket delimiter operator variables this)))
 
   ;; Imenu.
   (setq-local treesit-simple-imenu-settings