Merge pull request #724 from emacs-php/remove-link-face-in-phpdoc

zonuexe · web-flow · commit 59f0ed3b33de · 2023-01-02T02:53:54.000+09:00
Remove `'link` face in PHPDoc
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -28,7 +28,7 @@ jobs:
     steps:
     - uses: actions/setup-python@v2
       with:
-        python-version: '3.6'
+        python-version: '3.11'
         architecture: 'x64'
     - uses: purcell/setup-emacs@master
       with:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,14 @@
 
 All notable changes of the PHP Mode 1.19.1 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
-<!-- ## Unreleased -->
+## Unreleased
+
+### Removed
+
+ * No longer highlights `'link` in PHPDoc ([#724])
+   * Please use `goto-address-prog-mode` minor mode
+
+[#724]: https://github.com/emacs-php/php-mode/pull/724
 
 ## [1.24.2] - 2022-11-13
 
diff --git a/lisp/php-mode.el b/lisp/php-mode.el
@@ -1371,8 +1371,6 @@ for \\[find-tag] (which see)."
               (regexp-opt php-phpdoc-type-names 'words)
               "\\)")
      1 font-lock-type-face prepend nil)
-    ("https?://[^\n\t ]+"
-     0 'link prepend nil)
     ("^\\(?:/\\*\\)?\\(?:\\s \\|\\*\\)*\\(@[[:alpha:]][-[:alpha:]\\]*\\)" ; "@foo ..." markup.
      1 'php-doc-annotation-tag prepend nil)))
 
diff --git a/tests/7.4/arrow-function.php.faces b/tests/7.4/arrow-function.php.faces
@@ -1,13 +1,9 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * GitHub-Issue: " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/506" link font-lock-doc-face)
- ("\n *\n * " . font-lock-doc-face)
+ ("/**\n * GitHub-Issue: https://github.com/emacs-php/php-mode/issues/506\n *\n * " . font-lock-doc-face)
  ("@see" php-doc-annotation-tag font-lock-doc-face)
- (" " . font-lock-doc-face)
- ("https://wiki.php.net/rfc/arrow_functions_v2" link font-lock-doc-face)
- ("\n */" . font-lock-doc-face)
+ (" https://wiki.php.net/rfc/arrow_functions_v2\n */" . font-lock-doc-face)
  ("\n\n")
  ("$" . php-variable-sigil)
  ("fn1" . php-variable-name)
diff --git a/tests/issue-136.php.faces b/tests/issue-136.php.faces
@@ -11,9 +11,7 @@
  ("@author" php-doc-annotation-tag font-lock-doc-face)
  ("    USAMI Kenta <tadsan@pixiv.com>\n * " . font-lock-doc-face)
  ("@link" php-doc-annotation-tag font-lock-doc-face)
- ("      " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode" link font-lock-doc-face)
- ("\n * " . font-lock-doc-face)
+ ("      https://github.com/emacs-php/php-mode\n * " . font-lock-doc-face)
  ("@package" php-doc-annotation-tag font-lock-doc-face)
  ("   " . font-lock-doc-face)
  ("Emacs\\PHPMode" php-string font-lock-doc-face)
diff --git a/tests/issue-197.php.faces b/tests/issue-197.php.faces
@@ -1,9 +1,7 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * GitHub Issue:    " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/197" link font-lock-doc-face)
- ("\n *\n * Test that member highlighting goes before highlighting of cc-mode\n * types\n */" . font-lock-doc-face)
+ ("/**\n * GitHub Issue:    https://github.com/emacs-php/php-mode/issues/197\n *\n * Test that member highlighting goes before highlighting of cc-mode\n * types\n */" . font-lock-doc-face)
  ("\n")
  ("$" . php-variable-sigil)
  ("test" . php-variable-name)
diff --git a/tests/issue-201.php.faces b/tests/issue-201.php.faces
@@ -1,9 +1,7 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * GitHub Issue:    " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/201" link font-lock-doc-face)
- ("\n *\n * Test highighting of " . font-lock-doc-face)
+ ("/**\n * GitHub Issue:    https://github.com/emacs-php/php-mode/issues/201\n *\n * Test highighting of " . font-lock-doc-face)
  ("$" php-doc-$this-sigil php-doc-variable-sigil font-lock-doc-face)
  ("this" php-doc-$this php-variable-name font-lock-doc-face)
  ("\n */" . font-lock-doc-face)
diff --git a/tests/issue-305.php.faces b/tests/issue-305.php.faces
@@ -1,9 +1,7 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * GitHub Issue:    " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/305" link font-lock-doc-face)
- ("\n *\n * Test highighting of " . font-lock-doc-face)
+ ("/**\n * GitHub Issue:    https://github.com/emacs-php/php-mode/issues/305\n *\n * Test highighting of " . font-lock-doc-face)
  ("$" php-doc-variable-sigil font-lock-doc-face)
  ("this_foo" php-variable-name font-lock-doc-face)
  (", " . font-lock-doc-face)
diff --git a/tests/issue-439.php.faces b/tests/issue-439.php.faces
@@ -1,9 +1,7 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * GitHub Issue:  " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/439" link font-lock-doc-face)
- ("\n */" . font-lock-doc-face)
+ ("/**\n * GitHub Issue:  https://github.com/emacs-php/php-mode/issues/439\n */" . font-lock-doc-face)
  ("\n\n")
  ("$" . php-variable-sigil)
  ("a" . php-variable-name)
diff --git a/tests/issue-443.php.27.faces b/tests/issue-443.php.27.faces
@@ -8,9 +8,7 @@
  ("1); ")
  ("?>" . php-php-tag)
  ("\n")
- ("/** GitHub Issue: " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/443" link font-lock-doc-face)
- (" */" . font-lock-doc-face)
+ ("/** GitHub Issue: https://github.com/emacs-php/php-mode/issues/443 */" . font-lock-doc-face)
  ("\n")
  ("<?xml" . php-php-tag)
  (" version")
diff --git a/tests/issue-443.php.faces b/tests/issue-443.php.faces
@@ -8,9 +8,7 @@
  ("1); ")
  ("?>" . php-php-tag)
  ("\n")
- ("/** GitHub Issue: " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/443" link font-lock-doc-face)
- (" */" . font-lock-doc-face)
+ ("/** GitHub Issue: https://github.com/emacs-php/php-mode/issues/443 */" . font-lock-doc-face)
  ("\n")
  ("<?xml" . php-php-tag)
  (" version")
diff --git a/tests/lang/doc-comment/comments.php.24.faces b/tests/lang/doc-comment/comments.php.24.faces
@@ -11,9 +11,7 @@
  ("@author" php-doc-annotation-tag font-lock-doc-face)
  ("    USAMI Kenta <tadsan@pixiv.com>\n * " . font-lock-doc-face)
  ("@link" php-doc-annotation-tag font-lock-doc-face)
- ("      " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode" link font-lock-doc-face)
- ("\n * " . font-lock-doc-face)
+ ("      https://github.com/emacs-php/php-mode\n * " . font-lock-doc-face)
  ("@package" php-doc-annotation-tag font-lock-doc-face)
  ("   " . font-lock-doc-face)
  ("Emacs\\PHPMode" php-string font-lock-doc-face)
diff --git a/tests/lang/doc-comment/comments.php.27.faces b/tests/lang/doc-comment/comments.php.27.faces
@@ -11,9 +11,7 @@
  ("@author" php-doc-annotation-tag font-lock-doc-face)
  ("    USAMI Kenta <tadsan@pixiv.com>\n * " . font-lock-doc-face)
  ("@link" php-doc-annotation-tag font-lock-doc-face)
- ("      " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode" link font-lock-doc-face)
- ("\n * " . font-lock-doc-face)
+ ("      https://github.com/emacs-php/php-mode\n * " . font-lock-doc-face)
  ("@package" php-doc-annotation-tag font-lock-doc-face)
  ("   " . font-lock-doc-face)
  ("Emacs\\PHPMode" php-string font-lock-doc-face)
diff --git a/tests/lang/doc-comment/comments.php.faces b/tests/lang/doc-comment/comments.php.faces
@@ -11,9 +11,7 @@
  ("@author" php-doc-annotation-tag font-lock-doc-face)
  ("    USAMI Kenta <tadsan@pixiv.com>\n * " . font-lock-doc-face)
  ("@link" php-doc-annotation-tag font-lock-doc-face)
- ("      " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode" link font-lock-doc-face)
- ("\n * " . font-lock-doc-face)
+ ("      https://github.com/emacs-php/php-mode\n * " . font-lock-doc-face)
  ("@package" php-doc-annotation-tag font-lock-doc-face)
  ("   " . font-lock-doc-face)
  ("Emacs\\PHPMode" php-string font-lock-doc-face)
diff --git a/tests/lang/doc-comment/issue-8.php.faces b/tests/lang/doc-comment/issue-8.php.faces
@@ -1,9 +1,7 @@
 ;; -*- mode: emacs-lisp -*-
 (("<?php" . php-php-tag)
  ("\n\n")
- ("/**\n * Github Issue:    " . font-lock-doc-face)
- ("https://github.com/emacs-php/php-mode/issues/8" link font-lock-doc-face)
- ("\n *\n * The code below contains annotations in the comments which begin\n * with the '@' character.  The highlighting for these annotations\n * should be different from that used for comments.  At the very least\n * php-mode should highlight the part up to the first backslash.\n */" . font-lock-doc-face)
+ ("/**\n * Github Issue:    https://github.com/emacs-php/php-mode/issues/8\n *\n * The code below contains annotations in the comments which begin\n * with the '@' character.  The highlighting for these annotations\n * should be different from that used for comments.  At the very least\n * php-mode should highlight the part up to the first backslash.\n */" . font-lock-doc-face)
  ("\n\n")
  ("/**\n * " . font-lock-doc-face)
  ("@ORM\\Entity" php-doc-annotation-tag font-lock-doc-face)
diff --git a/tests/lang/doc-comment/return-type.php.faces b/tests/lang/doc-comment/return-type.php.faces
@@ -3,9 +3,7 @@
  ("\n\n")
  ("/**\n * Test for type annotation in doc comment\n *\n * The specification is defined in PSR-5 (draft) Appendix A. Types.\n * This implementation contains unstandardized specification.\n *\n * " . font-lock-doc-face)
  ("@see" php-doc-annotation-tag font-lock-doc-face)
- (" " . font-lock-doc-face)
- ("https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types" link font-lock-doc-face)
- ("\n */" . font-lock-doc-face)
+ (" https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types\n */" . font-lock-doc-face)
  ("\n\n")
  ("// " . font-lock-comment-delimiter-face)
  ("Test for premitive type (int)\n" . font-lock-comment-face)
