[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/typescript-mode fbaad515c9 132/222: Merge pull request #89
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/typescript-mode fbaad515c9 132/222: Merge pull request #89 from Ailrun/update-jsdoc-tests |
|
Date: |
Sun, 6 Feb 2022 16:59:26 -0500 (EST) |
branch: elpa/typescript-mode
commit fbaad515c90df0f5c3634c471034e3041a4a8cfc
Merge: 255f670a40 e15e2bfa1a
Author: Jostein Kjønigsen <jostein@kjonigsen.net>
Commit: GitHub <noreply@github.com>
Merge pull request #89 from Ailrun/update-jsdoc-tests
Update jsdoc tests (Please provide some review about structure)
---
Makefile | 7 +-
...de-tests.el => typescript-mode-general-tests.el | 58 +-
typescript-mode-jsdoc-tests.el | 3086 ++++++++++++++++++++
typescript-mode-test-utilities.el | 63 +
typescript-mode-tests.el | 640 +---
5 files changed, 3163 insertions(+), 691 deletions(-)
diff --git a/Makefile b/Makefile
index 2a3406c2db..35eda6a12b 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,10 @@
EMACS=$(shell which emacs) -Q -batch -L .
-ELS = typescript-mode.el typescript-mode-tests.el
+ELS = \
+ typescript-mode.el \
+ typescript-mode-test-utilities.el \
+ typescript-mode-general-tests.el \
+ typescript-mode-jsdoc-tests.el \
+ typescript-mode-tests.el
ELCS = $(ELS:.el=.elc)
clean:
diff --git a/typescript-mode-tests.el b/typescript-mode-general-tests.el
similarity index 92%
copy from typescript-mode-tests.el
copy to typescript-mode-general-tests.el
index 4cf37fd01e..cb89f8b986 100644
--- a/typescript-mode-tests.el
+++ b/typescript-mode-general-tests.el
@@ -1,14 +1,14 @@
-
-;;; typescript-mode-tests --- This file contains automated tests for
typescript-mode.el
+;;; typescript-mode-general-tests --- This file contains general tests for
typescript-mode.el
;;; Commentary:
-;; Run tests using (ert-run-tests-interactively t).
+;; To know how to run the tests, see typescript-mode-tests.el
;;; Code:
(require 'ert)
(require 'typescript-mode)
(require 'cl)
+(require 'typescript-mode-test-utilities)
(defun typescript-test-get-doc ()
(buffer-substring-no-properties (point-min) (point-max)))
@@ -204,58 +204,10 @@ a severity set to WARNING, no rule name."
(ert-deftest re-search-backwards-skips-multi-line-comments ()
(test-re-search "token" "let token; /* token in \nmulti-line token comment"
0))
-;; Adapted from jdee-mode's test suite.
-(defmacro test-with-temp-buffer (content &rest body)
- "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
- (declare (debug t)
- (indent 1))
- `(with-temp-buffer
- (insert ,content)
- (typescript-mode)
- (goto-char (point-min))
- ;; We need this so that tests that simulate user actions operate on the
right buffer.
- (switch-to-buffer (current-buffer))
- ,@body))
-
-(defmacro test-with-fontified-buffer (content &rest body)
- "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
- (declare (debug t)
- (indent 1))
- `(test-with-temp-buffer
- ,content
- (font-lock-fontify-buffer)
- ,@body))
-
-(defun get-face-at (loc)
- "Get the face at `LOC'. If it is not a number, then we `re-search-forward'
with `LOC'
-as the search pattern."
- (when (not (numberp loc))
- (save-excursion
- (re-search-forward loc)
- (setq loc (match-beginning 0))))
- (get-text-property loc 'face))
-
(setq font-lock-contents
" * @param {Something} bar A parameter. References [[moo]] and [[foo]].
* @param second May hold ``x`` or ``y``.")
-(defun font-lock-test (contents expected)
- "Perform a test on our template. `CONTENTS' is the string to
-put in the temporary buffer. `EXPECTED' is the expected
-results. It should be a list of (LOCATION . FACE) pairs, where
-LOCATION can be either a single location, or list of locations,
-that are all expected to have the same face."
- (test-with-fontified-buffer
- contents
- ;; Make sure our propertize function has been applied to the whole
- ;; buffer.
- (syntax-propertize (point-max))
- (dolist (spec expected)
- (if (listp (car spec))
- (dolist (source (car spec))
- (should (eq (get-face-at source) (cdr spec))))
- (should (eq (get-face-at (car spec)) (cdr spec)))))))
-
(ert-deftest font-lock/documentation-in-documentation-comments ()
"Documentation in documentation comments should be fontified as
documentation."
@@ -646,6 +598,6 @@ const b = 'not terminated bbb")))
(equal matched-file-name (match-string 1)))))))
-(provide 'typescript-mode-tests)
+(provide 'typescript-mode-general-tests)
-;;; typescript-mode-tests.el ends here
+;;; typescript-mode-general-tests.el ends here
diff --git a/typescript-mode-jsdoc-tests.el b/typescript-mode-jsdoc-tests.el
new file mode 100644
index 0000000000..367370e18d
--- /dev/null
+++ b/typescript-mode-jsdoc-tests.el
@@ -0,0 +1,3086 @@
+;;; typescript-mode-jsdoc-tests --- This file contains JSDoc related tests for
typescript-mode.el
+
+;;; Commentary:
+;; To understand the definition of JSDoc tag,
+;; see
https://github.com/jsdoc3/jsdoc/blob/b21427343c7294bbf1f14c718a390f3e955e37cb/lib/jsdoc/tag.js#L153-L195
+;; To know how to run the tests, see typescript-mode-tests.el
+
+;;; Code:
+
+(require 'ert)
+(require 'typescript-mode)
+(require 'typescript-mode-test-utilities)
+
+(defun jsdoc-multiline-test (jsdoc-lines specs)
+ "Perform a multi-line JSDoc test against specs.
+`JSDOC-LINES' are converted into a multi-line JS comment, and
+the comment is tested against `SPECS'.
+For more information about how to write `SPECS', see `font-lock-test'."
+ (let* ((unwrapped-comment-lines
+ (mapcar (lambda (line) (concat " * " line "\n")) jsdoc-lines))
+ (comment-lines
+ (append '("/**\n") unwrapped-comment-lines '(" */"))))
+ (font-lock-test
+ (apply #'concat comment-lines)
+ (cons
+ '(1 . font-lock-comment-delimiter-face)
+ specs))))
+
+;; Internal tags (or essential tags)
+;; See
https://github.com/jsdoc3/jsdoc/blob/b21427343c7294bbf1f14c718a390f3e955e37cb/lib/jsdoc/tag/dictionary/definitions.js#L222-L256
+
+(ert-deftest jsdoc/also-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @also tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@also"
+ )
+ '(
+ ;; ("@also$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/also-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @also tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@also extra text"
+ )
+ '(
+ ;; ("@also extra text" . typescript-jsdoc-tag)
+ ("extra text" . font-lock-comment-face)
+ ("text" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/also-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @also tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/description-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @description tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@description descriptionInSingleWord"
+ "@description description about something"
+ "@description"
+ "multi-line description about other things"
+ "@desc descInSingleWord"
+ "@desc desc about something"
+ "@desc"
+ "multi-line desc about other things"
+ )
+ '(
+ ("@description descriptionInSingleWord" . typescript-jsdoc-tag)
+ ("descriptionInSingleWord" . font-lock-comment-face)
+ ("@description description about something" . typescript-jsdoc-tag)
+ ("description about something" . font-lock-comment-face)
+ ("about something" . font-lock-comment-face)
+ ("something" . font-lock-comment-face)
+ ("@description$" . typescript-jsdoc-tag)
+ ("multi-line description about other things" . font-lock-comment-face)
+ ("@desc descInSingleWord" . typescript-jsdoc-tag)
+ ("descInSingleWord" . font-lock-comment-face)
+ ("@desc desc about something" . typescript-jsdoc-tag)
+ ("desc about something" . font-lock-comment-face)
+ ("about something" . font-lock-comment-face)
+ ("something" . font-lock-comment-face)
+ ("@desc$" . typescript-jsdoc-tag)
+ ("multi-line desc about other things" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/description-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @description tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@description {DescriptionType}"
+ "@desc {DescType}"
+ )
+ '(
+ ("@description {DescriptionType}" . typescript-jsdoc-tag)
+ ("{DescriptionType}" . font-lock-comment-face)
+ ("@desc {DescType}" . typescript-jsdoc-tag)
+ ("{DescType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/description-tag-in-multiline-doc-comment-with-invalid-cases
()
+ "Test for invalid usage of @description tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@description"
+ "@desc"
+ )
+ '(
+ ;; ("@description$" . font-lock-comment-face)
+ ;; ("@desc$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/kind-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @kind tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@kind class"
+ "@kind constant"
+ "@kind event"
+ "@kind external"
+ "@kind file"
+ "@kind function"
+ "@kind member"
+ "@kind mixin"
+ "@kind module"
+ "@kind namespace"
+ "@kind typedef"
+ )
+ '(
+ ("@kind class" . typescript-jsdoc-tag)
+ ("class" . typescript-jsdoc-value)
+ ("@kind constant" . typescript-jsdoc-tag)
+ ("constant" . typescript-jsdoc-value)
+ ("@kind event" . typescript-jsdoc-tag)
+ ("event" . typescript-jsdoc-value)
+ ("@kind external" . typescript-jsdoc-tag)
+ ("external" . typescript-jsdoc-value)
+ ("@kind file" . typescript-jsdoc-tag)
+ ("file" . typescript-jsdoc-value)
+ ("@kind function" . typescript-jsdoc-tag)
+ ("function" . typescript-jsdoc-value)
+ ("@kind member" . typescript-jsdoc-tag)
+ ("member" . typescript-jsdoc-value)
+ ("@kind mixin" . typescript-jsdoc-tag)
+ ("mixin" . typescript-jsdoc-value)
+ ("@kind module" . typescript-jsdoc-tag)
+ ("module" . typescript-jsdoc-value)
+ ("@kind namespace" . typescript-jsdoc-tag)
+ ("namespace" . typescript-jsdoc-value)
+ ("@kind typedef" . typescript-jsdoc-tag)
+ ("typedef" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/kind-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @kind tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@kind meaninglessKind"
+ "@kind {KindType}"
+ )
+ '(
+ ("@kind meaninglessKind" . typescript-jsdoc-tag)
+ ("meaninglessKind" . typescript-jsdoc-value)
+ ("@kind {KindType}" . typescript-jsdoc-tag)
+ ("{KindType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/kind-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @kind tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@kind"
+ )
+ '(
+ ("@kind$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/name-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @name tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@name someName"
+ )
+ '(
+ ("@name someName" . typescript-jsdoc-tag)
+ ("someName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/name-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @name tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@name {NameType}"
+ )
+ '(
+ ("@name {NameType}" . typescript-jsdoc-tag)
+ ("{NameType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/name-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @name tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@name"
+ )
+ '(
+ ("@name$" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/undocumented-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @undocumented tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@undocumented"
+ )
+ '(
+ ;; ("@undocumented" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/undocumented-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @undocumented tags and its
alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/undocumented-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @undocumented tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@undocumented invalidValue"
+ "@undocumented {InvalidType}"
+ )
+ '(
+ ("@undocumented invalidValue" . font-lock-comment-face)
+ ("invalidValue" . font-lock-comment-face)
+ ("@undocumented {InvalidType}" . font-lock-comment-face)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+;; Basic tags
+;; See
https://github.com/jsdoc3/jsdoc/blob/b21427343c7294bbf1f14c718a390f3e955e37cb/lib/jsdoc/tag/dictionary/definitions.js#L260-L858
+;; for details of following tag tests
+
+(ert-deftest jsdoc/abstract-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @abstract tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@abstract"
+ "@virtual"
+ )
+ '(
+ ("@abstract" . typescript-jsdoc-tag)
+ ("@virtual" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/abstract-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @abstract tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/abstract-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @abstract tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@abstract invalid extra value0"
+ "@abstract {InvalidType0}"
+ "@virtual invalid extra value1"
+ "@virtual {InvalidType1}"
+ )
+ '(
+ ("@abstract invalid extra value0" . typescript-jsdoc-tag)
+ ("invalid extra value0" . font-lock-comment-face)
+ ("extra value0" . font-lock-comment-face)
+ ("value0" . font-lock-comment-face)
+ ("@abstract {InvalidType0}" . typescript-jsdoc-tag)
+ ("{InvalidType0}" . font-lock-comment-face)
+ ("@virtual invalid extra value1" . typescript-jsdoc-tag)
+ ("invalid extra value1" . font-lock-comment-face)
+ ("extra value1" . font-lock-comment-face)
+ ("value1" . font-lock-comment-face)
+ ("@virtual {InvalidType1}" . typescript-jsdoc-tag)
+ ("{InvalidType1}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/access-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @access tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@access package"
+ "@access private"
+ "@access protected"
+ "@access public"
+ )
+ '(
+ ("@access package" . typescript-jsdoc-tag)
+ ("package" . typescript-jsdoc-value)
+ ("@access private" . typescript-jsdoc-tag)
+ ("private" . typescript-jsdoc-value)
+ ("@access protected" . typescript-jsdoc-tag)
+ ("protected" . typescript-jsdoc-value)
+ ("@access public" . typescript-jsdoc-tag)
+ ("public" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/access-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @access tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@access meaninglessAccess"
+ "@access {AccessType}"
+ )
+ '(
+ ("@access meaninglessAccess" . typescript-jsdoc-tag)
+ ("meaninglessAccess" . typescript-jsdoc-value)
+ ("@access {AccessType}" . typescript-jsdoc-tag)
+ ("{AccessType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/access-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @access tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@access"
+ )
+ '(
+ ("@access$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/alias-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @alias tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@alias exampleAlias0"
+ "@alias somenamespace.exampleAlias1"
+ )
+ '(
+ ("@alias exampleAlias0" . typescript-jsdoc-tag)
+ ("exampleAlias0" . typescript-jsdoc-value)
+ ("@alias somenamespace.exampleAlias1" . typescript-jsdoc-tag)
+ ("somenamespace.exampleAlias1" . typescript-jsdoc-value)
+ ("exampleAlias1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/alias-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @alias tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@alias multiple words"
+ "@alias {AliasType}"
+ )
+ '(
+ ("@alias multiple words" . typescript-jsdoc-tag)
+ ("multiple words" . typescript-jsdoc-value)
+ ;; ("words" . typescript-jsdoc-value)
+ ("@alias {AliasType}" . typescript-jsdoc-tag)
+ ("{AliasType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/alias-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @alias tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@alias"
+ )
+ '(
+ ("@alias$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/async-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @async tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@async"
+ )
+ '(
+ ("@async" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/async-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @async tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/async-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @async tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@async invalid extra value"
+ "@async {InvalidType}"
+ )
+ '(
+ ("@async invalid extra value" . typescript-jsdoc-tag)
+ ("invalid extra value" . font-lock-comment-face)
+ ("extra value" . font-lock-comment-face)
+ ("value" . font-lock-comment-face)
+ ("@async {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/augments-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @augments tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@augments ExampleAugmented0"
+ "@augments {ExampleAugmented1}"
+ "@extends ExampleExtended0"
+ "@extends {ExampleExtended1}"
+ )
+ '(
+ ("@augments ExampleAugmented0" . typescript-jsdoc-tag)
+ ("ExampleAugmented0" . typescript-jsdoc-value)
+ ("@augments {ExampleAugmented1}" . typescript-jsdoc-tag)
+ ;; ("{ExampleAugmented1}" . typescript-jsdoc-type)
+ ("@extends ExampleExtended0" . typescript-jsdoc-tag)
+ ("ExampleExtended0" . typescript-jsdoc-value)
+ ("@extends {ExampleExtended1}" . typescript-jsdoc-tag)
+ ;; ("{ExampleExtended1}" . typescript-jsdoc-type)
+ )))
+
+(ert-deftest jsdoc/async-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @async tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@augments {ExampleAugmented0} extra augments value"
+ "@extends {ExampleExtended0} extra extends value"
+ )
+ '(
+ ("@augments {ExampleAugmented0} extra augments value" .
typescript-jsdoc-tag)
+ ;; ("{ExampleAugmented0} extra augments value" . typescript-jsdoc-type)
+ ("extra augments value" . font-lock-comment-face)
+ ("augments value" . font-lock-comment-face)
+ ("value" . font-lock-comment-face)
+ ("@extends {ExampleExtended0} extra extends value" . typescript-jsdoc-tag)
+ ;; ("{ExampleExtended0} extra extends value" . typescript-jsdoc-type)
+ ("extra extends value" . font-lock-comment-face)
+ ("extends value" . font-lock-comment-face)
+ ("value" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/augments-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @augments tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@augments"
+ "@extends"
+ )
+ '(
+ ("@augments$" . font-lock-comment-face)
+ ;; ("@extends$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/author-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @author tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@author Exampleauthor"
+ "@author Exampleauthor Withfamilyname"
+ "@author Exampleauthor <example@author.email>"
+ )
+ '(
+ ("@author Exampleauthor$" . typescript-jsdoc-tag)
+ ;; ("Exampleauthor" . typescript-jsdoc-value)
+ ("@author Exampleauthor Withfamilyname" . typescript-jsdoc-tag)
+ ;; ("Exampleauthor Withfamilyname" . typescript-jsdoc-value)
+ ;; ("Withfamilyname" . typescript-jsdoc-value)
+ ("@author Exampleauthor <example@author.email>" . typescript-jsdoc-tag)
+ ;; ("Exampleauthor <example@author.email>" . typescript-jsdoc-value)
+ ;; ("<example@author.email>" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/author-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @author tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@author {AuthorType}"
+ )
+ '(
+ ("@author {AuthorType}" . typescript-jsdoc-tag)
+ ;; ("{AuthorType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/author-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @author tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@author"
+ )
+ '(
+ ;; ("@author$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/borrows-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @borrows tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@borrows something0"
+ "@borrows originalName as borrowedName"
+ )
+ '(
+ ("@borrows something0" . typescript-jsdoc-tag)
+ ("something0" . typescript-jsdoc-value)
+ ("@borrows originalName as borrowedName" . typescript-jsdoc-tag)
+ ("originalName as borrowedName" . typescript-jsdoc-value)
+ ;; ("as borrowedName" . typescript-jsdoc-value)
+ ;; ("borrowedName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/borrows-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @borrows tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@borrows meaningless multiple words"
+ "@borrows {BorrowType}"
+ )
+ '(
+ ("@borrows meaningless multiple words" . typescript-jsdoc-tag)
+ ("meaningless multiple words" . typescript-jsdoc-value)
+ ;; ("multiple words" . typescript-jsdoc-value)
+ ;; ("words" . typescript-jsdoc-value)
+ ("@borrows {BorrowType}" . typescript-jsdoc-tag)
+ ("{BorrowType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/borrows-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @borrows tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@borrows"
+ "@borrows {InvalidType}"
+ )
+ '(
+ ("@borrows$" . font-lock-comment-face)
+ ;; ("@borrows {InvalidType}" . font-lock-comment-face)
+ ;; ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/class-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @class tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ ;; See
https://github.com/jsdoc3/jsdoc/blob/b21427343c7294bbf1f14c718a390f3e955e37cb/lib/jsdoc/tag/dictionary/definitions.js#L318-L340
+ "@class"
+ "@class ExampleClass"
+ "@class Class tag for description0"
+ "@class"
+ "Class tag for description1"
+ "@constructor"
+ "@constructor ExampleClassConstructor"
+ ;; You cannot use @constructor to describe class
+ )
+ '(
+ ("@class$" . typescript-jsdoc-tag)
+ ("@class ExampleClass" . typescript-jsdoc-tag)
+ ;; ("ExampleClass" . typescript-jsdoc-value)
+ ("@class Class tag for description0" . typescript-jsdoc-tag)
+ ("Class tag for description0" . font-lock-comment-face)
+ ("tag for description0" . font-lock-comment-face)
+ ("for description0" . font-lock-comment-face)
+ ("description0" . font-lock-comment-face)
+ ("Class tag for description1" . font-lock-comment-face)
+ ("tag for description1" . font-lock-comment-face)
+ ("for description1" . font-lock-comment-face)
+ ("description1" . font-lock-comment-face)
+ ("@constructor" . typescript-jsdoc-tag)
+ ;; ("ExampleClassConstructor" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/class-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @class tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@class {ClassType}"
+ "@constructor {ConstructorType}"
+ )
+ '(
+ ("@class {ClassType}" . typescript-jsdoc-tag)
+ ;; ("{ClassType}" . typescript-jsdoc-value)
+ ("@constructor {ConstructorType}" . typescript-jsdoc-tag)
+ ;; ("{ConstructorType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/class-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @class tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/classdesc-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @classdesc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@classdesc"
+ "@classdesc This is class description0"
+ "@classdesc"
+ "This is class description1"
+ )
+ '(
+ ("@classdesc$" . typescript-jsdoc-tag)
+ ("@classdesc This is class description0" . typescript-jsdoc-tag)
+ ("This is class description0" . font-lock-comment-face)
+ ("is class description0" . font-lock-comment-face)
+ ("class description0" . font-lock-comment-face)
+ ("description0" . font-lock-comment-face)
+ ("This is class description1" . font-lock-comment-face)
+ ("is class description1" . font-lock-comment-face)
+ ("class description1" . font-lock-comment-face)
+ ("description1" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/classdesc-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @classdesc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@classdesc {ClassDescType}"
+ )
+ '(
+ ("@classdesc {ClassDescType}" . typescript-jsdoc-tag)
+ ("{ClassDescType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/classdesc-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @classdesc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/constant-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @constant tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@constant"
+ "@constant {ConstantType0}"
+ "@constant constantName0"
+ "@constant {ConstantType1} constantName1"
+ "@const"
+ "@const {ConstType0}"
+ "@const constName0"
+ "@const {ConstType1} constName1"
+ )
+ '(
+ ("@constant$" . typescript-jsdoc-tag)
+ ("@constant {ConstantType0}" . typescript-jsdoc-tag)
+ ;; ("{ConstantType0}" . typescript-jsdoc-type)
+ ("@constant constantName0" . typescript-jsdoc-tag)
+ ;; ("constantName0" . typescript-jsdoc-value)
+ ("@constant {ConstantType1} constantName1" . typescript-jsdoc-tag)
+ ;; ("{ConstantType1} constantName1" . typescript-jsdoc-type)
+ ;; ("constantName1" . typescript-jsdoc-value)
+ ("@const$" . typescript-jsdoc-tag)
+ ("@const {ConstType0}" . typescript-jsdoc-tag)
+ ;; ("{ConstType0}" . typescript-jsdoc-type)
+ ("@const constName0" . typescript-jsdoc-tag)
+ ;; ("constName0" . typescript-jsdoc-value)
+ ("@const {ConstType1} constName1" . typescript-jsdoc-tag)
+ ;; ("{ConstType1} constName1" . typescript-jsdoc-type)
+ ;; ("constName1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/constant-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @constant tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@constant extra value other than name for constant0"
+ "@const extra value other than name for const0"
+ )
+ '(
+ ("@constant extra value other than name for constant0" .
typescript-jsdoc-tag)
+ ;; ("extra value other than name for constant0" . typescript-jsdoc-value)
+ ("value other than name for constant0" . font-lock-comment-face)
+ ("other than name for constant0" . font-lock-comment-face)
+ ("than name for constant0" . font-lock-comment-face)
+ ("name for constant0" . font-lock-comment-face)
+ ("for constant0" . font-lock-comment-face)
+ ("constant0" . font-lock-comment-face)
+ ("@const extra value other than name for const0" . typescript-jsdoc-tag)
+ ;; ("extra value other than name for const0" . typescript-jsdoc-value)
+ ("value other than name for const0" . font-lock-comment-face)
+ ("other than name for const0" . font-lock-comment-face)
+ ("than name for const0" . font-lock-comment-face)
+ ("name for const0" . font-lock-comment-face)
+ ("for const0" . font-lock-comment-face)
+ ("const0" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/constant-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @constant tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/constructs-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @constructs tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@constructs"
+ "@constructs className"
+ "@constructs {@thisClass}"
+ )
+ '(
+ ("@constructs$" . typescript-jsdoc-tag)
+ ("@constructs className" . typescript-jsdoc-tag)
+ ;; ("className" . typescript-jsdoc-value)
+ ("@constructs {@thisClass}" . typescript-jsdoc-tag)
+ ;; ("{@thisClass}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/constructs-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @constructs tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@constructs className and extra description"
+ "@constructs {ClassType}"
+ )
+ '(
+ ("@constructs className and extra description" . typescript-jsdoc-tag)
+ ;; ("className and extra description" . typescript-jsdoc-value)
+ ("and extra description" . font-lock-comment-face)
+ ("extra description" . font-lock-comment-face)
+ ("description" . font-lock-comment-face)
+ ("@constructs {ClassType}" . typescript-jsdoc-tag)
+ ;; ("{ClassType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/constructs-tag-in-multiline-doc-comment-with-invalid-cases
()
+ "Test for invalid usage of @constructs tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/copyright-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @copyright tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@copyright Some copyright texts"
+ )
+ '(
+ ("@copyright Some copyright texts" . typescript-jsdoc-tag)
+ ("Some copyright texts" . font-lock-comment-face)
+ ("copyright texts" . font-lock-comment-face)
+ ("texts" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/copyright-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @copyright tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@copyright {InvalidType}"
+ )
+ '(
+ ("@copyright {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/copyright-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @copyright tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@copyright"
+ )
+ '(
+ ;; ("@copyright$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/default-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @default tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@default"
+ "@default 5"
+ "@default true"
+ "@defaultvalue"
+ "@defaultvalue null"
+ "@defaultvalue \"abc\""
+ )
+ '(
+ ("@default$" . typescript-jsdoc-tag)
+ ("@default 5" . typescript-jsdoc-tag)
+ ;; ("5" . typescript-jsdoc-value)
+ ("@default true" . typescript-jsdoc-tag)
+ ;; ("true" . typescript-jsdoc-value)
+ ("@defaultvalue$" . typescript-jsdoc-tag)
+ ("@defaultvalue null" . typescript-jsdoc-tag)
+ ;; ("null" . typescript-jsdoc-value)
+ ("@defaultvalue \"abc\"" . typescript-jsdoc-tag)
+ ;; ("\"abc\"" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/default-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @default tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@default multiple values for default0"
+ "@default {DefaultType}"
+ "@defaultvalue multiple values for defaultvalue0"
+ "@defaultvalue {DefaultValueType}"
+ )
+ '(
+ ("@default multiple values for default0" . typescript-jsdoc-tag)
+ ;; ("multiple values for default0" . typescript-jsdoc-value)
+ ;; ("values for default0" . typescript-jsdoc-value)
+ ;; ("for default0" . typescript-jsdoc-value)
+ ;; ("default0" . typescript-jsdoc-value)
+ ("@default {DefaultType}" . typescript-jsdoc-tag)
+ ;; ("{DefaultType}" . typescript-jsdoc-value)
+ ("@defaultvalue multiple values for defaultvalue0" . typescript-jsdoc-tag)
+ ;; ("multiple values for defaultvalue0" . typescript-jsdoc-value)
+ ;; ("values for defaultvalue0" . typescript-jsdoc-value)
+ ;; ("for defaultvalue0" . typescript-jsdoc-value)
+ ;; ("defaultvalue0" . typescript-jsdoc-value)
+ ("@defaultvalue {DefaultValueType}" . typescript-jsdoc-tag)
+ ;; ("{DefaultValueType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/default-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @default tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/deprecated-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @deprecated tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@deprecated"
+ "@deprecated Some explanations about deprecation"
+ )
+ '(
+ ("@deprecated$" . typescript-jsdoc-tag)
+ ("@deprecated Some explanations about deprecation" . typescript-jsdoc-tag)
+ ("Some explanations about deprecation" . font-lock-comment-face)
+ ("explanations about deprecation" . font-lock-comment-face)
+ ("about deprecation" . font-lock-comment-face)
+ ("deprecation" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/deprecated-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @deprecated tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@deprecated {DeprecatedType}"
+ )
+ '(
+ ("@deprecated {DeprecatedType}" . typescript-jsdoc-tag)
+ ("{DeprecatedType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/deprecated-tag-in-multiline-doc-comment-with-invalid-cases
()
+ "Test for invalid usage of @deprecated tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/enum-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @enum tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@enum"
+ "@enum {EnumItemType}"
+ )
+ '(
+ ("@enum$" . typescript-jsdoc-tag)
+ ("@enum {EnumItemType}" . typescript-jsdoc-tag)
+ ("{EnumItemType}" . typescript-jsdoc-type)
+ )))
+
+(ert-deftest jsdoc/enum-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @enum tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@enum meaningless description0"
+ "@enum {EnumItemType} meaningless description1"
+ )
+ '(
+ ("@enum meaningless description0" . typescript-jsdoc-tag)
+ ("meaningless description0" . font-lock-comment-face)
+ ("description0" . font-lock-comment-face)
+ ("@enum {EnumItemType} meaningless description1" . typescript-jsdoc-tag)
+ ("{EnumItemType} meaningless description1" . typescript-jsdoc-type)
+ ("meaningless description1" . font-lock-comment-face)
+ ("description1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/enum-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @enum tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/event-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @event tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@event"
+ "@event SomeClass#exampleEvent"
+ )
+ '(
+ ("@event$" . typescript-jsdoc-tag)
+ ("@event SomeClass#exampleEvent" . typescript-jsdoc-tag)
+ ;; ("SomeClass#exampleEvent" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/event-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @event tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@event justText"
+ "@event {EventType}"
+ )
+ '(
+ ("@event justText" . typescript-jsdoc-tag)
+ ;; ("justText" . typescript-jsdoc-value)
+ ("@event {EventType}" . typescript-jsdoc-tag)
+ ;; ("{EventType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/event-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @event tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/example-tag-in-multiline-doc-comment-with-meaninglful-cases
()
+ "Test for meaningful and valid usage of @example tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@example inlineExample with multiple terms0"
+ "@example"
+ "With multiline and multiple terms1"
+ )
+ '(
+ ("@example inlineExample with multiple terms" . typescript-jsdoc-tag)
+ ;; ("inlineExample with multiple terms" . typescript-jsdoc-value)
+ ;; ("with multiple terms" . typescript-jsdoc-value)
+ ;; ("multiple terms" . typescript-jsdoc-value)
+ ;; ("terms" . typescript-jsdoc-value)
+ ("@example$" . typescript-jsdoc-tag)
+ ;; ("With multiline and multiple terms1" . typescript-jsdoc-value)
+ ;; ("multiline and multiple terms1" . typescript-jsdoc-value)
+ ;; ("and multiple terms1" . typescript-jsdoc-value)
+ ;; ("multiple terms1" . typescript-jsdoc-value)
+ ;; ("terms1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/example-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @example tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/example-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @example tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@example"
+ )
+ '(
+ ;; ("@example$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/exports-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @exports tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@exports some/module"
+ )
+ '(
+ ("@exports some/module" . typescript-jsdoc-tag)
+ ;; ("some/module" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/exports-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @exports tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@exports justText"
+ "@exports {ExportType}"
+ )
+ '(
+ ("@exports justText" . typescript-jsdoc-tag)
+ ;; ("justText" . typescript-jsdoc-value)
+ ("@exports {ExportType}" . typescript-jsdoc-tag)
+ ;; ("{ExportType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/exports-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @exports tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@exports"
+ )
+ '(
+ ;; ("@exports$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/external-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @external tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@external"
+ "@external String"
+ "@external \"jQuery.fn\""
+ "@external {ExternalType0}"
+ "@external {ExternalType1} ExternalValue"
+ "@host"
+ "@host Boolean"
+ "@host \"jQuery.fn.pluginNamespace\""
+ "@host {HostType0}"
+ "@host {HostType1} HostValue"
+ )
+ '(
+ ;; ("@external$" . typescript-jsdoc-tag)
+ ("@external String" . typescript-jsdoc-tag)
+ ("String" . typescript-jsdoc-value)
+ ("@external \"jQuery.fn\"" . typescript-jsdoc-tag)
+ ("\"jQuery.fn\"" . typescript-jsdoc-value)
+ ("@external {ExternalType0}" . typescript-jsdoc-tag)
+ ;; ("{ExternalType0}" . typescript-jsdoc-type)
+ ("@external {ExternalType1} ExternalValue" . typescript-jsdoc-tag)
+ ;; ("{ExternalType1} ExternalValue" . typescript-jsdoc-type)
+ ;; ("ExternalValue" . typescript-jsdoc-value)
+ ;; ("@host$" . typescript-jsdoc-tag)
+ ("@host Boolean" . typescript-jsdoc-tag)
+ ("Boolean" . typescript-jsdoc-value)
+ ("@host \"jQuery.fn.pluginNamespace\"" . typescript-jsdoc-tag)
+ ("\"jQuery.fn.pluginNamespace\"" . typescript-jsdoc-value)
+ ("@host {HostType0}" . typescript-jsdoc-tag)
+ ;; ("{HostType0}" . typescript-jsdoc-type)
+ ("@host {HostType1} HostValue" . typescript-jsdoc-tag)
+ ;; ("{HostType1} HostValue" . typescript-jsdoc-type)
+ ;; ("HostValue" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/external-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @external tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@external multiple words0"
+ "@host multiple words1"
+ )
+ '(
+ ("@external multiple words0" . typescript-jsdoc-tag)
+ ("multiple words0" . typescript-jsdoc-value)
+ ;; ("words0" . typescript-jsdoc-value)
+ ("@host multiple words1" . typescript-jsdoc-tag)
+ ("multiple words1" . typescript-jsdoc-value)
+ ;; ("words1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/external-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @external tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@external"
+ )
+ '(
+ ;; ("@external$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/file-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @file tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@file"
+ "@file description for file0"
+ "@fileoverview"
+ "@fileoverview description for file1"
+ "@overview"
+ "@overview description for file2"
+ )
+ '(
+ ("@file$" . typescript-jsdoc-tag)
+ ("@file description for file0" . typescript-jsdoc-tag)
+ ("description for file0" . font-lock-comment-face)
+ ("for file0" . font-lock-comment-face)
+ ("file0" . font-lock-comment-face)
+ ("@fileoverview$" . typescript-jsdoc-tag)
+ ("@fileoverview description for file1" . typescript-jsdoc-tag)
+ ("description for file1" . font-lock-comment-face)
+ ("for file1" . font-lock-comment-face)
+ ("file1" . font-lock-comment-face)
+ ("@overview$" . typescript-jsdoc-tag)
+ ("@overview description for file2" . typescript-jsdoc-tag)
+ ("description for file2" . font-lock-comment-face)
+ ("for file2" . font-lock-comment-face)
+ ("file2" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/file-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @file tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@file {FileType}"
+ "@fileoverview {FileOverviewType}"
+ "@overview {OverviewType}"
+ )
+ '(
+ ("@file {FileType}" . typescript-jsdoc-tag)
+ ("{FileType}" . font-lock-comment-face)
+ ("@fileoverview {FileOverviewType}" . typescript-jsdoc-tag)
+ ("{FileOverviewType}" . font-lock-comment-face)
+ ("@overview {OverviewType}" . typescript-jsdoc-tag)
+ ("{OverviewType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/file-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @file tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/fires-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @fires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@fires SomeClass#eventName0"
+ "@emits SomeClass#eventName1"
+ )
+ '(
+ ("@fires SomeClass#eventName0" . typescript-jsdoc-tag)
+ ("SomeClass#eventName0" . typescript-jsdoc-value)
+ ("@emits SomeClass#eventName1" . typescript-jsdoc-tag)
+ ("SomeClass#eventName1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/fires-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @fires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@fires just text"
+ "@fires {FiresType}"
+ "@emits any text"
+ "@emits {EmitsType}"
+ )
+ '(
+ ("@fires just text" . typescript-jsdoc-tag)
+ ("just text" . typescript-jsdoc-value)
+ ("text" . font-lock-comment-face)
+ ("@fires {FiresType}" . typescript-jsdoc-tag)
+ ("{FiresType}" . typescript-jsdoc-value)
+ ("@emits any text" . typescript-jsdoc-tag)
+ ("any text" . typescript-jsdoc-value)
+ ("text" . font-lock-comment-face)
+ ("@emits {EmitsType}" . typescript-jsdoc-tag)
+ ("{EmitsType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/fires-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @fires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@fires"
+ "@emits"
+ )
+ '(
+ ("@fires$" . font-lock-comment-face)
+ ("@emits$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/function-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @function tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@function"
+ "@function functionName"
+ "@func"
+ "@func funcName"
+ "@method"
+ "@method methodName"
+ )
+ '(
+ ("@function$" . typescript-jsdoc-tag)
+ ("@function functionName" . typescript-jsdoc-tag)
+ ("functionName" . typescript-jsdoc-value)
+ ("@func$" . typescript-jsdoc-tag)
+ ("@func funcName" . typescript-jsdoc-tag)
+ ("funcName" . typescript-jsdoc-value)
+ ("@method$" . typescript-jsdoc-tag)
+ ("@method methodName" . typescript-jsdoc-tag)
+ ("methodName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/function-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @function tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@function multiple words for function0"
+ "@function {FunctionType}"
+ "@func multiple words for func0"
+ "@func {FuncType}"
+ "@method multiple words for method0"
+ "@method {MethodType}"
+ )
+ '(
+ ("@function multiple words for function0" . typescript-jsdoc-tag)
+ ("multiple words for function0" . typescript-jsdoc-value)
+ ("words for function0" . font-lock-comment-face)
+ ("for function0" . font-lock-comment-face)
+ ("function0" . font-lock-comment-face)
+ ("@function {FunctionType}" . typescript-jsdoc-tag)
+ ("{FunctionType}" . typescript-jsdoc-value)
+ ("@func multiple words for func0" . typescript-jsdoc-tag)
+ ("multiple words for func0" . typescript-jsdoc-value)
+ ("words for func0" . font-lock-comment-face)
+ ("for func0" . font-lock-comment-face)
+ ("func0" . font-lock-comment-face)
+ ("@func {FuncType}" . typescript-jsdoc-tag)
+ ("{FuncType}" . typescript-jsdoc-value)
+ ("@method multiple words for method0" . typescript-jsdoc-tag)
+ ("multiple words for method0" . typescript-jsdoc-value)
+ ("words for method0" . font-lock-comment-face)
+ ("for method0" . font-lock-comment-face)
+ ("method0" . font-lock-comment-face)
+ ("@method {MethodType}" . typescript-jsdoc-tag)
+ ("{MethodType}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/function-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @function tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/generator-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @generator tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@generator"
+ )
+ '(
+ ("@generator$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/generator-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @generator tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/generator-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @generator tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@generator invalid extra values"
+ "@generator {InvalidType}"
+ )
+ '(
+ ("@generator invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@generator {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/global-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @global tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@global"
+ )
+ '(
+ ("@global$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/global-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @global tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/global-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @global tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@global invalid extra values"
+ "@global {InvalidType}"
+ )
+ '(
+ ("@global invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@global {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/hideconstructor-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @hideconstructor tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@hideconstructor"
+ )
+ '(
+ ("@hideconstructor$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/hideconstructor-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @hideconstructor tags and its
alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/hideconstructor-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @hideconstructor tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@hideconstructor invalid extra values"
+ "@hideconstructor {InvalidType}"
+ )
+ '(
+ ("@hideconstructor invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@hideconstructor {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/ignore-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @ignore tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@ignore"
+ )
+ '(
+ ("@ignore$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/ignore-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @ignore tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/ignore-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @ignore tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@ignore invalid extra values"
+ "@ignore {InvalidType}"
+ )
+ '(
+ ("@ignore invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@ignore {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/implements-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @implements tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@implements SomeInterface"
+ "@implements {OtherInterface}"
+ )
+ '(
+ ("@implements SomeInterface" . typescript-jsdoc-tag)
+ ;; ("SomeInterface" . typescript-jsdoc-value)
+ ("@implements {OtherInterface}" . typescript-jsdoc-tag)
+ ("{OtherInterface}" . typescript-jsdoc-type)
+ )))
+
+(ert-deftest
jsdoc/implements-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @implements tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@implements {Interface0} Interface1"
+ )
+ '(
+ ("@implements {Interface0} Interface1" . typescript-jsdoc-tag)
+ ("{Interface0} Interface1" . typescript-jsdoc-type)
+ ("Interface1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/implements-tag-in-multiline-doc-comment-with-invalid-cases
()
+ "Test for invalid usage of @implements tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@implements"
+ )
+ '(
+ ;; ("@implements$" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/inheritdoc-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @inheritdoc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@inheritdoc"
+ )
+ '(
+ ("@inheritdoc$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/inheritdoc-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @inheritdoc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/inheritdoc-tag-in-multiline-doc-comment-with-invalid-cases
()
+ "Test for invalid usage of @inheritdoc tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@inheritdoc invalid extra values"
+ "@inheritdoc {InvalidType}"
+ )
+ '(
+ ("@inheritdoc invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@inheritdoc {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/inner-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @inner tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@inner"
+ )
+ '(
+ ("@inner$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/inner-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @inner tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@inner extra values"
+ "@inner {InnerType}"
+ )
+ '(
+ ("@inner extra values" . typescript-jsdoc-tag)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@inner {InnerType}" . typescript-jsdoc-tag)
+ ("{InnerType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/inner-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @inner tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/instance-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @instance tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@instance"
+ )
+ '(
+ ("@instance$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/instance-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @instance tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@instance extra values"
+ "@instance {InstanceType}"
+ )
+ '(
+ ("@instance extra values" . typescript-jsdoc-tag)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@instance {InstanceType}" . typescript-jsdoc-tag)
+ ("{InstanceType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/instance-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @instance tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/interface-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @interface tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@interface"
+ "@interface InterfaceName"
+ )
+ '(
+ ("@interface$" . typescript-jsdoc-tag)
+ ("@interface InterfaceName" . typescript-jsdoc-tag)
+ ;; ("InterfaceName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/interface-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @interface tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@interface extra values"
+ "@interface {InterfaceType0}"
+ "@interface {InterfaceType1} AndName"
+ )
+ '(
+ ("@interface extra values" . typescript-jsdoc-tag)
+ ;; ("extra values" . typescript-jsdoc-value)
+ ("values" . font-lock-comment-face)
+ ("@interface {InterfaceType0}" . typescript-jsdoc-tag)
+ ;; ("{InterfaceType0}" . typescript-jsdoc-value)
+ ("@interface {InterfaceType1} AndName" . typescript-jsdoc-tag)
+ ;; ("{InterfaceType1} AndName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/interface-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @interface tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/lends-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @lends tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@lends"
+ "@lends Something"
+ "@lends Something.deeper"
+ )
+ '(
+ ("@lends$" . typescript-jsdoc-tag)
+ ("@lends Something" . typescript-jsdoc-tag)
+ ;; ("Something" . typescript-jsdoc-value)
+ ("@lends Something.deeper" . typescript-jsdoc-tag)
+ ;; ("Something.deeper" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/lends-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @lends tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@lends {LendsType0}"
+ "@lends {LendsType1} With.some.path"
+ )
+ '(
+ ("@lends {LendsType0}" . typescript-jsdoc-tag)
+ ;; ("{LendsType0}" . nil)
+ ("@lends {LendsType1} With.some.path" . typescript-jsdoc-tag)
+ ;; ("{LendsType1} With.some.path" . nil)
+ ;; ("With.some.path" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/lends-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @lends tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/license-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @license tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@license Some-License-Name"
+ "@license"
+ "Some long license texts"
+ )
+ '(
+ ("@license Some-License-Name" . typescript-jsdoc-tag)
+ ("Some-License-Name" . font-lock-comment-face)
+ ("@license$" . typescript-jsdoc-tag)
+ ("Some long license texts" . font-lock-comment-face)
+ ("long license texts" . font-lock-comment-face)
+ ("license texts" . font-lock-comment-face)
+ ("texts" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/license-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @license tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@license {LicenseType0}"
+ "@license {LicenseType1} With more text"
+ )
+ '(
+ ("@license {LicenseType0}" . typescript-jsdoc-tag)
+ ("{LicenseType0}" . font-lock-comment-face)
+ ("@license {LicenseType1} With more text" . typescript-jsdoc-tag)
+ ("{LicenseType1} With more text" . font-lock-comment-face)
+ ("With more text" . font-lock-comment-face)
+ ("more text" . font-lock-comment-face)
+ ("text" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/license-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @license tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@license"
+ )
+ '(
+ ;; ("@license$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/listens-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @listens tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@listens event:nameOfEvent"
+ )
+ '(
+ ("@listens event:nameOfEvent" . typescript-jsdoc-tag)
+ ("event:nameOfEvent" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/listens-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @listens tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@listens extra text0"
+ "@listens {ListenType0}"
+ "@listens {ListenType1} and text1"
+ )
+ '(
+ ("@listens extra text0" . typescript-jsdoc-tag)
+ ("extra text0" . typescript-jsdoc-value)
+ ;; ("text0" . typescript-jsdoc-value)
+ ("@listens {ListenType0}" . typescript-jsdoc-tag)
+ ("{ListenType0}" . typescript-jsdoc-value)
+ ("@listens {ListenType1} and text1" . typescript-jsdoc-tag)
+ ("{ListenType1} and text1" . typescript-jsdoc-value)
+ ;; ("and text1" . typescript-jsdoc-value)
+ ;; ("text1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/listens-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @listens tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@listens"
+ )
+ '(
+ ("@listens$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/member-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @member tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@member"
+ "@member {MemberType0}"
+ "@member memberName0"
+ "@member {MemberType1} memberName1"
+ "@var"
+ "@var {VarType0}"
+ "@var varName0"
+ "@var {VarType1} varName1"
+ )
+ '(
+ ;; ("@member$" . typescript-jsdoc-tag)
+ ("@member {MemberType0}" . typescript-jsdoc-tag)
+ ;; ("{MemberType0}" . typescript-jsdoc-type)
+ ("@member memberName0" . typescript-jsdoc-tag)
+ ("memberName0" . typescript-jsdoc-value)
+ ("@member {MemberType1} memberName1" . typescript-jsdoc-tag)
+ ;; ("{MemberType1} memberName1" . typescript-jsdoc-type)
+ ;; ("memberName1" . typescript-jsdoc-value)
+ ;; ("@var$" . typescript-jsdoc-tag)
+ ("@var {VarType0}" . typescript-jsdoc-tag)
+ ;; ;; ("{VarType0}" . typescript-jsdoc-type)
+ ("@var varName0" . typescript-jsdoc-tag)
+ ("varName0" . typescript-jsdoc-value)
+ ("@var {VarType1} varName1" . typescript-jsdoc-tag)
+ ;; ("{VarType1} varName1" . typescript-jsdoc-type)
+ ;; ("varName1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/member-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @member tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@member extra value0"
+ "@var extra value1"
+ )
+ '(
+ ("@member extra value0" . typescript-jsdoc-tag)
+ ("extra value0" . typescript-jsdoc-value)
+ ("value0" . font-lock-comment-face)
+ ("@var extra value1" . typescript-jsdoc-tag)
+ ("extra value1" . typescript-jsdoc-value)
+ ("value1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/member-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @member tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/memberof-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @memberof tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@memberof SomeClass0"
+ "@memberof SomeClass1#"
+ "@memberof <global>"
+ "@memberof! OtherClass0"
+ "@memberof! OtherClass1#"
+ ;; "@memberof! <global>" is valid, but it is hard to test.
+ )
+ '(
+ ("@memberof SomeClass0" . typescript-jsdoc-tag)
+ ("SomeClass0" . typescript-jsdoc-value)
+ ("@memberof SomeClass1#" . typescript-jsdoc-tag)
+ ("SomeClass1#" . typescript-jsdoc-value)
+ ("@memberof <global>" . typescript-jsdoc-tag)
+ ("<global>" . typescript-jsdoc-value)
+ ;; ("@memberof! OtherClass0" . typescript-jsdoc-tag)
+ ;; ("OtherClass0" . typescript-jsdoc-value)
+ ;; ("@memberof! OtherClass1#" . typescript-jsdoc-tag)
+ ;; ("OtherClass1#" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/memberof-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @memberof tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@memberof extra text0"
+ "@memberof {MemberOfType0}"
+ "@memberof {MemberOfType1} and text1"
+ "@memberof! again string0"
+ "@memberof! {MemberOfForcedType0}"
+ "@memberof! {MemberOfForcedType1} and more string1"
+ )
+ '(
+ ("@memberof extra text0" . typescript-jsdoc-tag)
+ ("extra text0" . typescript-jsdoc-value)
+ ;; ("text0" . typescript-jsdoc-value)
+ ("@memberof {MemberOfType0}" . typescript-jsdoc-tag)
+ ("{MemberOfType0}" . typescript-jsdoc-value)
+ ("@memberof {MemberOfType1} and text1" . typescript-jsdoc-tag)
+ ("{MemberOfType1} and text1" . typescript-jsdoc-value)
+ ;; ("and text1" . typescript-jsdoc-value)
+ ;; ("text1" . typescript-jsdoc-value)
+ ;; ("@memberof! again string0" . typescript-jsdoc-tag)
+ ;; ("again string0" . typescript-jsdoc-value)
+ ;; ("string0" . typescript-jsdoc-value)
+ ;; ("@memberof! {MemberOfForcedType0}" . typescript-jsdoc-tag)
+ ;; ("{MemberOfForcedType0}" . typescript-jsdoc-value)
+ ;; ("@memberof! {MemberOfForcedType1} and more string1" .
typescript-jsdoc-tag)
+ ;; ("{MemberOfForcedType1} and more string1" . typescript-jsdoc-value)
+ ;; ("and more string1" . typescript-jsdoc-value)
+ ;; ("more string1" . typescript-jsdoc-value)
+ ;; ("string1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/memberof-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @memberof tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@memberof"
+ "@memberof!"
+ )
+ '(
+ ("@memberof$" . font-lock-comment-face)
+ ("@memberof!$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/mixes-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @mixes tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@mixes OtherObject"
+ )
+ '(
+ ("@mixes OtherObject" . typescript-jsdoc-tag)
+ ("OtherObject" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/mixes-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @mixes tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@mixes extra text0"
+ "@mixes {MixesType0}"
+ "@mixes {MixesType1} and text1"
+ )
+ '(
+ ("@mixes extra text0" . typescript-jsdoc-tag)
+ ("extra text0" . typescript-jsdoc-value)
+ ("text0" . font-lock-comment-face)
+ ("@mixes {MixesType0}" . typescript-jsdoc-tag)
+ ("{MixesType0}" . typescript-jsdoc-value)
+ ("@mixes {MixesType1} and text1" . typescript-jsdoc-tag)
+ ("{MixesType1} and text1" . typescript-jsdoc-value)
+ ("and text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/mixes-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @mixes tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@mixes"
+ )
+ '(
+ ("@mixes$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/mixin-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @mixin tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@mixin"
+ "@mixin MixinName"
+ )
+ '(
+ ("@mixin$" . typescript-jsdoc-tag)
+ ("@mixin MixinName" . typescript-jsdoc-tag)
+ ;; ("MixinName" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/mixin-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @mixin tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@mixin and extra text0"
+ "@mixin {MixinType0}"
+ "@mixin {MixinType1} with more text1"
+ )
+ '(
+ ("@mixin and extra text0" . typescript-jsdoc-tag)
+ ;; ("and extra text0" . typescript-jsdoc-value)
+ ("extra text0" . font-lock-comment-face)
+ ("text0" . font-lock-comment-face)
+ ("@mixin {MixinType0}" . typescript-jsdoc-tag)
+ ;; ("{MixinType0}" . typescript-jsdoc-value)
+ ("@mixin {MixinType1} with more text1" . typescript-jsdoc-tag)
+ ;; ("{MixinType1} with more text1" . typescript-jsdoc-value)
+ ("with more text1" . font-lock-comment-face)
+ ("more text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/mixin-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @mixin tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+;; @modified tag is not yet released (It is a new tag of JSDoc 3.6.0)
+(ert-deftest jsdoc/modifies-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @modifies tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@modifies"
+ "@modifies {ModifiedType}"
+ )
+ '(
+ ;; ("@modifies$" . typescript-jsdoc-tag)
+ ;; ("@modifies {ModifiedType}" . typescript-jsdoc-tag)
+ ;; ("{ModifiedType}" . typescript-jsdoc-type)
+ )))
+
+(ert-deftest
jsdoc/modifies-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @modifies tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@modifies name0"
+ "@modifies {ModifiedType} and name1"
+ )
+ '(
+ ;; ("@modifies name0" . typescript-jsdoc-tag)
+ ;; ("name0" . font-lock-comment-face)
+ ;; ("@modifies {ModifiedType} and name1" . typescript-jsdoc-tag)
+ ;; ("{ModifiedType} and name1" . typescript-jsdoc-type)
+ ;; ("and name1" . font-lock-comment-face)
+ ;; ("name1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/modifies-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @modifies tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@modifies"
+ )
+ '(
+ ("@modifies$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/module-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @module tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@module"
+ "@module ModuleName0"
+ "@module {ModuleType0}"
+ "@module {ModuleType1} ModuleName1"
+ )
+ '(
+ ;; ("@module$" . typescript-jsdoc-tag)
+ ("@module ModuleName0" . typescript-jsdoc-tag)
+ ("ModuleName0" . typescript-jsdoc-value)
+ ("@module {ModuleType0}" . typescript-jsdoc-tag)
+ ;; ("{ModuleType0}" . typescript-jsdoc-type)
+ ("@module {ModuleType1} ModuleName1" . typescript-jsdoc-tag)
+ ;; ("{ModuleType1} ModuleName1" . typescript-jsdoc-type)
+ ;; ("ModuleName1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/module-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @module tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@module with multiple words0"
+ "@module {ModuleType} with multiple words1"
+ )
+ '(
+ ("@module with multiple words0" . typescript-jsdoc-tag)
+ ("with multiple words0" . typescript-jsdoc-value)
+ ("multiple words0" . font-lock-comment-face)
+ ("words0" . font-lock-comment-face)
+ ("@module {ModuleType} with multiple words1" . typescript-jsdoc-tag)
+ ;; ("{ModuleType} with multiple words1" . typescript-jsdoc-type)
+ ;; ("with multiple words1" . typescript-jsdoc-value)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/module-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @module tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/namespace-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @namespace tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@namespace"
+ "@namespace Namespace0"
+ "@namespace {NamespaceType0}"
+ "@namespace {NamespaceType1} Namespace1"
+ )
+ '(
+ ;; ("@namespace$" . typescript-jsdoc-tag)
+ ("@namespace Namespace0" . typescript-jsdoc-tag)
+ ("Namespace0" . typescript-jsdoc-value)
+ ("@namespace {NamespaceType0}" . typescript-jsdoc-tag)
+ ;; ("{NamespaceType0}" . typescript-jsdoc-type)
+ ("@namespace {NamespaceType1} Namespace1" . typescript-jsdoc-tag)
+ ;; ("{NamespaceType1} Namespace1" . typescript-jsdoc-type)
+ ;; ("Namespace1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/namespace-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @namespace tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@namespace with multiple words0"
+ "@namespace {NamespaceType} with multiple words1"
+ )
+ '(
+ ("@namespace with multiple words0" . typescript-jsdoc-tag)
+ ("with multiple words0" . typescript-jsdoc-value)
+ ("multiple words0" . font-lock-comment-face)
+ ("words0" . font-lock-comment-face)
+ ("@namespace {NamespaceType} with multiple words1" . typescript-jsdoc-tag)
+ ;; ("{NamespaceType} with multiple words1" . typescript-jsdoc-type)
+ ;; ("with multiple words1" . typescript-jsdoc-value)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/namespace-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @namespace tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/package-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @package tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@package"
+ )
+ '(
+ ("@package$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/package-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @package tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/package-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @package tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@package invalid extra values"
+ "@package {InvalidType}"
+ )
+ '(
+ ("@package invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@package {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/param-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @param tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@param"
+ "@param {ParamType0}"
+ "@param paramName0"
+ "@param {ParamType1} paramName1"
+ "@param {ParamType2} paramName2 with paramDescription2"
+ "@arg"
+ "@arg {ArgType0}"
+ "@arg argName0"
+ "@arg {ArgType1} argName1"
+ "@arg {ArgType2} argName2 with argDescription2"
+ "@argument"
+ "@argument {ArgumentType0}"
+ "@argument argumentName0"
+ "@argument {ArgumentType1} argumentName1"
+ "@argument {ArgumentType2} argumentName2 with argumentDescription2"
+ )
+ '(
+ ("@param$" . typescript-jsdoc-tag)
+ ("@param {ParamType0}" . typescript-jsdoc-tag)
+ ;; ("{ParamType0}" . typescript-jsdoc-type)
+ ("@param paramName0" . typescript-jsdoc-tag)
+ ("paramName0" . typescript-jsdoc-value)
+ ("@param {ParamType1} paramName1" . typescript-jsdoc-tag)
+ ("{ParamType1} paramName1" . typescript-jsdoc-type)
+ ("paramName1" . typescript-jsdoc-value)
+ ("@param {ParamType2} paramName2 with paramDescription2" .
typescript-jsdoc-tag)
+ ("{ParamType2} paramName2 with paramDescription2" . typescript-jsdoc-type)
+ ("paramName2 with paramDescription2" . typescript-jsdoc-value)
+ ("with paramDescription2" . font-lock-comment-face)
+ ("paramDescription2" . font-lock-comment-face)
+ ("@arg$" . typescript-jsdoc-tag)
+ ("@arg {ArgType0}" . typescript-jsdoc-tag)
+ ;; ("{ArgType0}" . typescript-jsdoc-type)
+ ("@arg argName0" . typescript-jsdoc-tag)
+ ("argName0" . typescript-jsdoc-value)
+ ("@arg {ArgType1} argName1" . typescript-jsdoc-tag)
+ ("{ArgType1} argName1" . typescript-jsdoc-type)
+ ("argName1" . typescript-jsdoc-value)
+ ("@arg {ArgType2} argName2 with argDescription2" . typescript-jsdoc-tag)
+ ("{ArgType2} argName2 with argDescription2" . typescript-jsdoc-type)
+ ("argName2 with argDescription2" . typescript-jsdoc-value)
+ ("with argDescription2" . font-lock-comment-face)
+ ("argDescription2" . font-lock-comment-face)
+ ("@argument$" . typescript-jsdoc-tag)
+ ("@argument {ArgumentType0}" . typescript-jsdoc-tag)
+ ;; ("{ArgumentType0}" . typescript-jsdoc-type)
+ ("@argument argumentName0" . typescript-jsdoc-tag)
+ ("argumentName0" . typescript-jsdoc-value)
+ ("@argument {ArgumentType1} argumentName1" . typescript-jsdoc-tag)
+ ("{ArgumentType1} argumentName1" . typescript-jsdoc-type)
+ ("argumentName1" . typescript-jsdoc-value)
+ ("@argument {ArgumentType2} argumentName2 with argumentDescription2" .
typescript-jsdoc-tag)
+ ("{ArgumentType2} argumentName2 with argumentDescription2" .
typescript-jsdoc-type)
+ ("argumentName2 with argumentDescription2" . typescript-jsdoc-value)
+ ("with argumentDescription2" . font-lock-comment-face)
+ ("argumentDescription2" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/param-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @param tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@param extra value0"
+ "@arg extra value1"
+ "@argument extra value2"
+ )
+ '(
+ ("@param extra value0" . typescript-jsdoc-tag)
+ ("extra value0" . typescript-jsdoc-value)
+ ("value0" . font-lock-comment-face)
+ ("@arg extra value1" . typescript-jsdoc-tag)
+ ("extra value1" . typescript-jsdoc-value)
+ ("value1" . font-lock-comment-face)
+ ("@argument extra value2" . typescript-jsdoc-tag)
+ ("extra value2" . typescript-jsdoc-value)
+ ("value2" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/param-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @param tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/private-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @private tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@private"
+ )
+ '(
+ ("@private$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/private-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @private tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/private-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @private tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@private invalid extra values"
+ "@private {InvalidType}"
+ )
+ '(
+ ("@private invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@private {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/property-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @property tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@property {PropertyType0}"
+ "@property propertyName0"
+ "@property {PropertyType1} propertyName1"
+ "@property {PropertyType2} propertyName2 with propertyDescription2"
+ "@prop"
+ "@prop {PropType0}"
+ "@prop propName0"
+ "@prop {PropType1} propName1"
+ "@prop {PropType2} propName2 with propDescription2"
+ )
+ '(
+ ("@property {PropertyType0}" . typescript-jsdoc-tag)
+ ;; ("{PropertyType0}" . typescript-jsdoc-type)
+ ("@property propertyName0" . typescript-jsdoc-tag)
+ ("propertyName0" . typescript-jsdoc-value)
+ ("@property {PropertyType1} propertyName1" . typescript-jsdoc-tag)
+ ("{PropertyType1} propertyName1" . typescript-jsdoc-type)
+ ("propertyName1" . typescript-jsdoc-value)
+ ("@property {PropertyType2} propertyName2 with propertyDescription2" .
typescript-jsdoc-tag)
+ ("{PropertyType2} propertyName2 with propertyDescription2" .
typescript-jsdoc-type)
+ ("propertyName2 with propertyDescription2" . typescript-jsdoc-value)
+ ("with propertyDescription2" . font-lock-comment-face)
+ ("propertyDescription2" . font-lock-comment-face)
+ ("@prop {PropType0}" . typescript-jsdoc-tag)
+ ;; ("{PropType0}" . typescript-jsdoc-type)
+ ("@prop propName0" . typescript-jsdoc-tag)
+ ("propName0" . typescript-jsdoc-value)
+ ("@prop {PropType1} propName1" . typescript-jsdoc-tag)
+ ("{PropType1} propName1" . typescript-jsdoc-type)
+ ("propName1" . typescript-jsdoc-value)
+ ("@prop {PropType2} propName2 with propDescription2" .
typescript-jsdoc-tag)
+ ("{PropType2} propName2 with propDescription2" . typescript-jsdoc-type)
+ ("propName2 with propDescription2" . typescript-jsdoc-value)
+ ("with propDescription2" . font-lock-comment-face)
+ ("propDescription2" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/property-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @property tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/property-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @property tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@property"
+ "@prop"
+ )
+ '(
+ ;; ("@property$" . font-lock-comment-face)
+ ;; ("@prop$" . font-lock-comment-face)
+ )))
+
+(ert-deftest
jsdoc/protected-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @protected tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@protected"
+ )
+ '(
+ ("@protected$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/protected-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @protected tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/protected-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @protected tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@protected invalid extra values"
+ "@protected {InvalidType}"
+ )
+ '(
+ ("@protected invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@protected {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/public-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @public tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@public"
+ )
+ '(
+ ("@public$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/public-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @public tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/public-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @public tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@public invalid extra values"
+ "@public {InvalidType}"
+ )
+ '(
+ ("@public invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@public {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/readonly-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @readonly tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@readonly"
+ )
+ '(
+ ("@readonly$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest
jsdoc/readonly-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @readonly tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/readonly-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @readonly tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@readonly invalid extra values"
+ "@readonly {InvalidType}"
+ )
+ '(
+ ("@readonly invalid extra values" . typescript-jsdoc-tag)
+ ("invalid extra values" . font-lock-comment-face)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@readonly {InvalidType}" . typescript-jsdoc-tag)
+ ("{InvalidType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/requires-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @requires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@requires SomeModuleName"
+ "@requires module:path/to/module"
+ "@requires {@link something}"
+ )
+ '(
+ ("@requires SomeModuleName" . typescript-jsdoc-tag)
+ ("SomeModuleName" . typescript-jsdoc-value)
+ ("@requires module:path/to/module" . typescript-jsdoc-tag)
+ ("module:path/to/module" . typescript-jsdoc-value)
+ ("@requires {@link something}" . typescript-jsdoc-tag)
+ ("{@link something}" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/requires-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @requires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@requires extra text0"
+ "@requires {RequiresType0}"
+ "@requires {RequiresType1} and text1"
+ )
+ '(
+ ("@requires extra text0" . typescript-jsdoc-tag)
+ ("extra text0" . typescript-jsdoc-value)
+ ("text0" . font-lock-comment-face)
+ ("@requires {RequiresType0}" . typescript-jsdoc-tag)
+ ("{RequiresType0}" . typescript-jsdoc-value)
+ ("@requires {RequiresType1} and text1" . typescript-jsdoc-tag)
+ ("{RequiresType1} and text1" . typescript-jsdoc-value)
+ ("and text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/requires-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @requires tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@requires"
+ )
+ '(
+ ;; ("@requires$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/returns-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @returns tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@returns description for returned value0"
+ "@returns {ReturnType1} description for returned value1"
+ "@return description for returned value2"
+ "@return {ReturnType3} description for returned value3"
+ )
+ '(
+ ("@returns description for returned value0" . typescript-jsdoc-tag)
+ ("description for returned value0" . font-lock-comment-face)
+ ("for returned value0" . font-lock-comment-face)
+ ("returned value0" . font-lock-comment-face)
+ ("value0" . font-lock-comment-face)
+ ("@returns {ReturnType1} description for returned value1" .
typescript-jsdoc-tag)
+ ("{ReturnType1} description for returned value1" . typescript-jsdoc-type)
+ ("description for returned value1" . font-lock-comment-face)
+ ("for returned value1" . font-lock-comment-face)
+ ("returned value1" . font-lock-comment-face)
+ ("value1" . font-lock-comment-face)
+ ("@return description for returned value2" . typescript-jsdoc-tag)
+ ("description for returned value2" . font-lock-comment-face)
+ ("for returned value2" . font-lock-comment-face)
+ ("returned value2" . font-lock-comment-face)
+ ("value2" . font-lock-comment-face)
+ ("@return {ReturnType3} description for returned value3" .
typescript-jsdoc-tag)
+ ("{ReturnType3} description for returned value3" . typescript-jsdoc-type)
+ ("description for returned value3" . font-lock-comment-face)
+ ("for returned value3" . font-lock-comment-face)
+ ("returned value3" . font-lock-comment-face)
+ ("value3" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/returns-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @returns tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/returns-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @returns tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@returns"
+ "@return"
+ )
+ '(
+ ;; ("@returns$" . font-lock-comment-face)
+ ;; ("@return$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/see-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @see tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@see someName.path"
+ "@see {@link something}"
+ "@see any other text"
+ )
+ '(
+ ;; ("@see someName.path" . typescript-jsdoc-tag)
+ ;; ("someName.path" . typescript-jsdoc-value)
+ ;; ("@see {@link something}" . typescript-jsdoc-tag)
+ ;; ("{@link something}" . typescript-jsdoc-value)
+ ;; ("@see any other text" . typescript-jsdoc-tag)
+ ;; ("any other text" . typescript-jsdoc-value)
+ ;; ("other text" . typescript-jsdoc-value)
+ ;; ("text" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/see-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @see tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@see {SeeType0}"
+ "@see {SeeType1} and text1"
+ )
+ '(
+ ;; ("@see {SeeType0}" . typescript-jsdoc-tag)
+ ;; ("{SeeType0}" . typescript-jsdoc-value)
+ ;; ("@see {SeeType1} and text1" . typescript-jsdoc-tag)
+ ;; ("{SeeType1} and text1" . typescript-jsdoc-value)
+ ;; ("and text1" . typescript-jsdoc-value)
+ ;; ("text1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/see-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @see tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@see"
+ )
+ '(
+ ("@see$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/since-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @since tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@since 1.0.1"
+ )
+ '(
+ ("@since 1.0.1" . typescript-jsdoc-tag)
+ ("1.0.1" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/since-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @since tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@since some extra text0"
+ "@since {SinceType0}"
+ "@since {SinceType1} and text1"
+ )
+ '(
+ ("@since some extra text0" . typescript-jsdoc-tag)
+ ("some extra text0" . typescript-jsdoc-value)
+ ("extra text0" . font-lock-comment-face)
+ ("text0" . font-lock-comment-face)
+ ("@since {SinceType0}" . typescript-jsdoc-tag)
+ ("{SinceType0}" . typescript-jsdoc-value)
+ ("@since {SinceType1} and text1" . typescript-jsdoc-tag)
+ ("{SinceType1} and text1" . typescript-jsdoc-value)
+ ("and text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/since-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @since tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@since"
+ )
+ '(
+ ("@since$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/static-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @static tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@static"
+ )
+ '(
+ ("@static$" . typescript-jsdoc-tag)
+ )))
+
+(ert-deftest jsdoc/static-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @static tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@static extra values"
+ "@static {StaticType}"
+ )
+ '(
+ ("@static extra values" . typescript-jsdoc-tag)
+ ("extra values" . font-lock-comment-face)
+ ("values" . font-lock-comment-face)
+ ("@static {StaticType}" . typescript-jsdoc-tag)
+ ("{StaticType}" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/static-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @static tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/summary-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @summary tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@summary some summary text"
+ )
+ '(
+ ("@summary some summary text" . typescript-jsdoc-tag)
+ ("some summary text" . font-lock-comment-face)
+ ("summary text" . font-lock-comment-face)
+ ("text" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/summary-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @summary tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@summary {SummaryType0}"
+ "@summary {SummaryType1} and text1"
+ )
+ '(
+ ("@summary {SummaryType0}" . typescript-jsdoc-tag)
+ ("{SummaryType0}" . font-lock-comment-face)
+ ("@summary {SummaryType1} and text1" . typescript-jsdoc-tag)
+ ("{SummaryType1} and text1" . font-lock-comment-face)
+ ("and text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/summary-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @summary tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@summary"
+ )
+ '(
+ ;; ("@summary$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/this-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @this tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@this ClassForThis"
+ )
+ '(
+ ("@this ClassForThis" . typescript-jsdoc-tag)
+ ("ClassForThis" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/this-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @this tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@this and multiple words0"
+ "@this {SummaryType0}"
+ "@this {SummaryType1} and multiple words1"
+ )
+ '(
+ ("@this and multiple words0" . typescript-jsdoc-tag)
+ ("and multiple words0" . typescript-jsdoc-value)
+ ("multiple words0" . font-lock-comment-face)
+ ("words0" . font-lock-comment-face)
+ ("@this {SummaryType0}" . typescript-jsdoc-tag)
+ ("{SummaryType0}" . typescript-jsdoc-value)
+ ("@this {SummaryType1} and multiple words1" . typescript-jsdoc-tag)
+ ("{SummaryType1} and multiple words1" . typescript-jsdoc-value)
+ ("and multiple words1" . font-lock-comment-face)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/this-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @this tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@this"
+ )
+ '(
+ ("@this$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/todo-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @todo tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@todo todo things"
+ "@todo more things to do!"
+ )
+ '(
+ ("@todo todo things" . typescript-jsdoc-tag)
+ ("todo things" . font-lock-comment-face)
+ ("things" . font-lock-comment-face)
+ ("@todo more things to do!" . typescript-jsdoc-tag)
+ ("more things to do!" . font-lock-comment-face)
+ ("things to do!" . font-lock-comment-face)
+ ("to do!" . font-lock-comment-face)
+ ("do!" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/todo-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @todo tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@todo {TodoType0}"
+ "@todo {TodoType1} and text1"
+ )
+ '(
+ ("@todo {TodoType0}" . typescript-jsdoc-tag)
+ ("{TodoType0}" . font-lock-comment-face)
+ ("@todo {TodoType1} and text1" . typescript-jsdoc-tag)
+ ("{TodoType1} and text1" . font-lock-comment-face)
+ ("and text1" . font-lock-comment-face)
+ ("text1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/todo-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @todo tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@todo"
+ )
+ '(
+ ;; ("@todo$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/throws-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @throws tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@throws explanation for throws cases0"
+ "@throws {ThrowsType0}"
+ "@throws {ThrowsType1} explanation for throws cases1"
+ "@exception explanation for exception0"
+ "@exception {ExceptionType0}"
+ "@exception {ExceptionType1} explanation for exception1"
+ )
+ '(
+ ("@throws explanation for throws cases0" . typescript-jsdoc-tag)
+ ;; ("explanation for throws cases0" . font-lock-comment-face)
+ ("for throws cases0" . font-lock-comment-face)
+ ("throws cases0" . font-lock-comment-face)
+ ("cases0" . font-lock-comment-face)
+ ("@throws {ThrowsType0}" . typescript-jsdoc-tag)
+ ;; ("{ThrowsType0}" . typescript-jsdoc-type)
+ ("@throws {ThrowsType1} explanation for throws cases1" .
typescript-jsdoc-tag)
+ ;; ("{ThrowsType1} explanation for throws cases1" . typescript-jsdoc-type)
+ ("explanation for throws cases1" . font-lock-comment-face)
+ ("for throws cases1" . font-lock-comment-face)
+ ("throws cases1" . font-lock-comment-face)
+ ("cases1" . font-lock-comment-face)
+ ("@exception explanation for exception0" . typescript-jsdoc-tag)
+ ;; ("explanation for exception0" . font-lock-comment-face)
+ ("for exception0" . font-lock-comment-face)
+ ("exception0" . font-lock-comment-face)
+ ("@exception {ExceptionType0}" . typescript-jsdoc-tag)
+ ;; ("{ExceptionType0}" . typescript-jsdoc-type)
+ ("@exception {ExceptionType1} explanation for exception1" .
typescript-jsdoc-tag)
+ ;; ("{ExceptionType1} explanation for exception1" . typescript-jsdoc-type)
+ ("explanation for exception1" . font-lock-comment-face)
+ ("for exception1" . font-lock-comment-face)
+ ("exception1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/throws-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @throws tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/throws-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @throws tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@throws"
+ "@exception"
+ )
+ '(
+ ;; ("@throws$" . font-lock-comment-face)
+ ;; ("@exception$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/tutorial-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @tutorial tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@tutorial tutorial-file0"
+ )
+ '(
+ ("@tutorial tutorial-file0" . typescript-jsdoc-tag)
+ ;; ("tutorial-file0" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/tutorial-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @tutorial tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@tutorial multiple words0"
+ "@tutorial {TutorialType0}"
+ "@tutorial {TutorialType1} multiple words1"
+ )
+ '(
+ ("@tutorial multiple words0" . typescript-jsdoc-tag)
+ ;; ("multiple words0" . typescript-jsdoc-value)
+ ("words0" . font-lock-comment-face)
+ ("@tutorial {TutorialType0}" . typescript-jsdoc-tag)
+ ;; ("{TutorialType0}" . typescript-jsdoc-value)
+ ("@tutorial {TutorialType1} multiple words1" . typescript-jsdoc-tag)
+ ;; ("{TutorialType1} multiple words1" . typescript-jsdoc-value)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/tutorial-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @tutorial tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@tutorial"
+ )
+ '(
+ ;; ("@tutorial$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/type-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @type tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@type TypeOfSomething0"
+ "@type {TypeofSomething1}"
+ )
+ '(
+ ("@type TypeOfSomething0" . typescript-jsdoc-tag)
+ ;; ("TypeOfSomething0" . typescript-jsdoc-type)
+ ("@type {TypeOfSomething1}" . typescript-jsdoc-tag)
+ ("{TypeOfSomething1}" . typescript-jsdoc-type)
+ )))
+
+(ert-deftest jsdoc/type-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @type tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@type multiple words0"
+ "@type {Type0} multiple words1"
+ )
+ '(
+ ("@type multiple words0" . typescript-jsdoc-tag)
+ ;; ("multiple words0" . typescript-jsdoc-type)
+ ("words0" . font-lock-comment-face)
+ ("@type {Type0} multiple words1" . typescript-jsdoc-tag)
+ ("{Type0} multiple words1" . typescript-jsdoc-type)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/type-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @type tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@type"
+ )
+ '(
+ ;; ("@type$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/typedef-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @typedef tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@typedef nameOfNewType0"
+ "@typedef namePath~OfNewType0"
+ "@typedef {TypeOfNewType0} nameOfNewType1"
+ "@typedef {TypeOfNewType1} namePath~OfNewType1"
+ "@callback nameOfNewCallback"
+ "@callback namePath~OfNewCallback"
+ )
+ '(
+ ("@typedef nameOfNewType0" . typescript-jsdoc-tag)
+ ("nameOfNewType0" . typescript-jsdoc-value)
+ ("@typedef namePath~OfNewType0" . typescript-jsdoc-tag)
+ ("namePath~OfNewType0" . typescript-jsdoc-value)
+ ("OfNewType0" . typescript-jsdoc-value)
+ ("@typedef {TypeOfNewType0} nameOfNewType1" . typescript-jsdoc-tag)
+ ("{TypeOfNewType0} nameOfNewType1" . typescript-jsdoc-type)
+ ("nameOfNewType1" . typescript-jsdoc-value)
+ ("@typedef {TypeOfNewType1} namePath~OfNewType1" . typescript-jsdoc-tag)
+ ("{TypeOfNewType1} namePath~OfNewType1" . typescript-jsdoc-type)
+ ("namePath~OfNewType1" . typescript-jsdoc-value)
+ ("OfNewType1" . typescript-jsdoc-value)
+ ("@callback nameOfNewCallback" . typescript-jsdoc-tag)
+ ("nameOfNewCallback" . typescript-jsdoc-value)
+ ("@callback namePath~OfNewCallback" . typescript-jsdoc-tag)
+ ("namePath~OfNewCallback" . typescript-jsdoc-value)
+ ("OfNewCallback" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/typedef-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @typedef tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@typedef"
+ "@typedef multiple words0"
+ "@typedef {TypeOfNewType0}"
+ "@typedef {TypeOfNewType1} multiple words1"
+ "@callback"
+ "@callback multiple words for callback0"
+ "@callback {CallbackType0}"
+ "@callback {CallbackType1} nameOfNewCallback"
+ "@callback {CallbackType2} namePath~OfNewCallback"
+ "@callback {CallbackType3} multiple words for callback1"
+ )
+ '(
+ ("@typedef$" . typescript-jsdoc-tag)
+ ("@typedef multiple words0" . typescript-jsdoc-tag)
+ ("multiple words0" . typescript-jsdoc-value)
+ ("words0" . font-lock-comment-face)
+ ("@typedef {TypeOfNewType0}" . typescript-jsdoc-tag)
+ ;; ("{TypeOfNewType0}" . typescript-jsdoc-type)
+ ("@typedef {TypeOfNewType1} multiple words1" . typescript-jsdoc-tag)
+ ("{TypeOfNewType1} multiple words1" . typescript-jsdoc-type)
+ ("multiple words1" . typescript-jsdoc-value)
+ ("words1" . font-lock-comment-face)
+ ;; ("@callback$" . typescript-jsdoc-tag)
+ ("@callback multiple words for callback0" . typescript-jsdoc-tag)
+ ("multiple words for callback0" . typescript-jsdoc-value)
+ ("words for callback0" . font-lock-comment-face)
+ ("for callback0" . font-lock-comment-face)
+ ("callback0" . font-lock-comment-face)
+ ("@callback {CallbackType0}" . typescript-jsdoc-tag)
+ ;; ("{CallbackType0}" . typescript-jsdoc-type)
+ ("@callback {CallbackType1} nameOfNewCallback" . typescript-jsdoc-tag)
+ ;; ("{CallbackType1} nameOfNewCallback" . typescript-jsdoc-type)
+ ;; ("nameOfNewCallback" . typescript-jsdoc-value)
+ ("@callback {CallbackType2} namePath~OfNewCallback" .
typescript-jsdoc-tag)
+ ;; ("{CallbackType2} namePath~OfNewCallback" . typescript-jsdoc-type)
+ ;; ("namePath~OfNewCallback" . typescript-jsdoc-value)
+ ;; ("OfNewCallback" . typescript-jsdoc-value)
+ ("@callback {CallbackType3} multiple words for callback1" .
typescript-jsdoc-tag)
+ ;; ("{CallbackType3} multiple words for callback1" .
typescript-jsdoc-type)
+ ;; ("multiple words for callback1" . typescript-jsdoc-value)
+ ("words for callback1" . font-lock-comment-face)
+ ("for callback1" . font-lock-comment-face)
+ ("callback1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/typedef-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @typedef tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest
jsdoc/variation-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @variation tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@variation 0"
+ "@variation (1)"
+ )
+ '(
+ ("@variation 0" . typescript-jsdoc-tag)
+ ("0" . typescript-jsdoc-value)
+ ("@variation (1)" . typescript-jsdoc-tag)
+ ("(1)" . typescript-jsdoc-value)
+ ("1)" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest
jsdoc/variation-tag-in-multiline-doc-comment-with-meaningless-cases ()
+ "Test for meaningless though valid usage of @variation tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@variation multiple words0"
+ "@variation {VariationType0}"
+ "@variation {VariationType1} multiple words1"
+ )
+ '(
+ ("@variation multiple words0" . typescript-jsdoc-tag)
+ ("multiple words0" . typescript-jsdoc-value)
+ ("words0" . font-lock-comment-face)
+ ("@variation {VariationType0}" . typescript-jsdoc-tag)
+ ("{VariationType0}" . typescript-jsdoc-value)
+ ("@variation {VariationType1} multiple words1" . typescript-jsdoc-tag)
+ ("{VariationType1} multiple words1" . typescript-jsdoc-value)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/variation-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @variation tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@variation"
+ )
+ '(
+ ("@variation$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/version-tag-in-multiline-doc-comment-with-meaningful-cases
()
+ "Test for meaningful and valid usage of @version tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@version 1.2.3"
+ "@version (4.7.1)"
+ )
+ '(
+ ("@version 1.2.3" . typescript-jsdoc-tag)
+ ("1.2.3" . typescript-jsdoc-value)
+ ("2.3" . typescript-jsdoc-value)
+ ("3" . typescript-jsdoc-value)
+ ("@version (4.7.1)" . typescript-jsdoc-tag)
+ ("(4.7.1)" . typescript-jsdoc-value)
+ ("7.1)" . typescript-jsdoc-value)
+ ("1)" . typescript-jsdoc-value)
+ )))
+
+(ert-deftest jsdoc/version-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @version tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@version multiple words0"
+ "@version {VersionType0}"
+ "@version {VersionType1} multiple words1"
+ )
+ '(
+ ("@version multiple words0" . typescript-jsdoc-tag)
+ ("multiple words0" . typescript-jsdoc-value)
+ ("words0" . font-lock-comment-face)
+ ("@version {VersionType0}" . typescript-jsdoc-tag)
+ ("{VersionType0}" . typescript-jsdoc-value)
+ ("@version {VersionType1} multiple words1" . typescript-jsdoc-tag)
+ ("{VersionType1} multiple words1" . typescript-jsdoc-value)
+ ("multiple words1" . font-lock-comment-face)
+ ("words1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/version-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @version tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@version"
+ )
+ '(
+ ("@version$" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/yields-tag-in-multiline-doc-comment-with-meaningful-cases ()
+ "Test for meaningful and valid usage of @yields tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@yields Text for yields0"
+ "@yields {YieldsType0}"
+ "@yields {YieldsType1} Text for yields1"
+ "@yield Text for yield0"
+ "@yield {YieldType0}"
+ "@yield {YieldType1} Text for yield1"
+ )
+ '(
+ ("@yields Text for yields0" . typescript-jsdoc-tag)
+ ("Text for yields0" . font-lock-comment-face)
+ ("for yields0" . font-lock-comment-face)
+ ("yields0" . font-lock-comment-face)
+ ("@yields {YieldsType0}" . typescript-jsdoc-tag)
+ ("{YieldsType0}" . typescript-jsdoc-type)
+ ("@yields {YieldsType1} Text for yields1" . typescript-jsdoc-tag)
+ ("{YieldsType1} Text for yields1" . typescript-jsdoc-type)
+ ("Text for yields1" . font-lock-comment-face)
+ ("for yields1" . font-lock-comment-face)
+ ("yields1" . font-lock-comment-face)
+ ("@yield Text for yield0" . typescript-jsdoc-tag)
+ ("Text for yield0" . font-lock-comment-face)
+ ("for yield0" . font-lock-comment-face)
+ ("yield0" . font-lock-comment-face)
+ ("@yield {YieldType0}" . typescript-jsdoc-tag)
+ ("{YieldType0}" . typescript-jsdoc-type)
+ ("@yield {YieldType1} Text for yield1" . typescript-jsdoc-tag)
+ ("{YieldType1} Text for yield1" . typescript-jsdoc-type)
+ ("Text for yield1" . font-lock-comment-face)
+ ("for yield1" . font-lock-comment-face)
+ ("yield1" . font-lock-comment-face)
+ )))
+
+(ert-deftest jsdoc/yields-tag-in-multiline-doc-comment-with-meaningless-cases
()
+ "Test for meaningless though valid usage of @yields tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ )
+ '(
+ )))
+
+(ert-deftest jsdoc/yields-tag-in-multiline-doc-comment-with-invalid-cases ()
+ "Test for invalid usage of @yields tags and its alias."
+ (jsdoc-multiline-test
+ '(
+ "@yields"
+ )
+ '(
+ ;; ("@yields$" . font-lock-comment-face)
+ )))
+
+;; Do we need to add closure tags?
+;; See
https://github.com/jsdoc3/jsdoc/blob/b21427343c7294bbf1f14c718a390f3e955e37cb/lib/jsdoc/tag/dictionary/definitions.js#L870-L1031
+
+(provide 'typescript-mode-jsdoc-tests)
+;;; typescript-mode-jsdoc-tests.el ends here
diff --git a/typescript-mode-test-utilities.el
b/typescript-mode-test-utilities.el
new file mode 100644
index 0000000000..faa6c1166a
--- /dev/null
+++ b/typescript-mode-test-utilities.el
@@ -0,0 +1,63 @@
+;;; typescript-mode-test-utilities --- This file contains test utilities for
typescript-mode.el
+
+;;; Commentary:
+;; See typescript-mode-tests.el and typescript-mode-jsdoc-tests.el
+
+;;; Code:
+
+(require 'ert)
+(require 'typescript-mode)
+
+;; Adapted from jdee-mode's test suite.
+(defmacro test-with-temp-buffer (content &rest body)
+ "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
+ (declare (debug t)
+ (indent 1))
+ `(with-temp-buffer
+ (insert ,content)
+ (typescript-mode)
+ (goto-char (point-min))
+ ;; We need this so that tests that simulate user actions operate on the
right buffer.
+ (switch-to-buffer (current-buffer))
+ ,@body))
+
+(defmacro test-with-fontified-buffer (content &rest body)
+ "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
+ (declare (debug t)
+ (indent 1))
+ `(test-with-temp-buffer
+ ,content
+ (font-lock-fontify-buffer)
+ ,@body))
+
+(defun get-face-at (loc)
+ "Get the face at `LOC'.
+If it is not a number, then we `re-search-forward' with `LOC'
+as the search pattern."
+ (when (not (numberp loc))
+ (save-excursion
+ (re-search-forward loc)
+ (setq loc (match-beginning 0))))
+ (get-text-property loc 'face))
+
+(defun font-lock-test (contents expected)
+ "Perform a test on our template.
+`CONTENTS' is the string to put in the temporary buffer.
+`EXPECTED' is the expected results.
+It should be a list of (LOCATION . FACE) pairs, where
+LOCATION can be either a single location, or list of locations,
+that are all expected to have the same face."
+ (test-with-fontified-buffer
+ contents
+ ;; Make sure our propertize function has been applied to the whole
+ ;; buffer.
+ (syntax-propertize (point-max))
+ (dolist (spec expected)
+ (if (listp (car spec))
+ (dolist (source (car spec))
+ (should (eq (get-face-at source) (cdr spec))))
+ (should (eq (get-face-at (car spec)) (cdr spec)))))))
+
+(provide 'typescript-mode-test-utilities)
+
+;;; typescript-mode-test-utilities.el ends here
diff --git a/typescript-mode-tests.el b/typescript-mode-tests.el
index 4cf37fd01e..1c8aa75fa2 100644
--- a/typescript-mode-tests.el
+++ b/typescript-mode-tests.el
@@ -1,4 +1,3 @@
-
;;; typescript-mode-tests --- This file contains automated tests for
typescript-mode.el
;;; Commentary:
@@ -9,642 +8,9 @@
(require 'ert)
(require 'typescript-mode)
(require 'cl)
-
-(defun typescript-test-get-doc ()
- (buffer-substring-no-properties (point-min) (point-max)))
-
-(defun typescript-test-indent-all ()
- (delete-trailing-whitespace)
- (indent-region (point-min) (point-max) nil)
- (untabify (point-min) (point-max)))
-
-(ert-deftest indentation-reference-document-is-reflowed-correctly ()
- (let ((buffer (find-file "test-files/indentation-reference-document.ts")))
- ;; double ensure mode is active
- (typescript-mode)
-
- (let ((test-reference (typescript-test-get-doc)))
- (typescript-test-indent-all)
- (should (string-equal test-reference
- (typescript-test-get-doc)))
- (let ((typescript-indent-switch-clauses nil))
- (typescript-test-indent-all)
- (should (string-equal test-reference
- (typescript-test-get-doc)))))
- (kill-buffer buffer)))
-
-(ert-deftest switch-case-indent-default ()
- (let ((buffer (find-file "test-files/switch-case-indent-default.ts")))
- (typescript-mode)
- (let ((test-reference (typescript-test-get-doc)))
- (typescript-test-indent-all)
- (should (string-equal test-reference
- (typescript-test-get-doc))))
- (kill-buffer buffer)))
-
-(ert-deftest switch-case-indent-disabled ()
- (let ((buffer (find-file "test-files/switch-case-indent-disabled.ts"))
- (typescript-indent-switch-clauses nil))
- (typescript-mode)
- (let ((test-reference (typescript-test-get-doc)))
- (typescript-test-indent-all)
- (should (string-equal test-reference
- (typescript-test-get-doc))))
- (kill-buffer buffer)))
-
-(defun get-all-matched-strings (to-match)
- (let (result)
- (dotimes (x (/ (length (match-data)) 2))
- (setq result (nconc result (list (match-string x to-match)))))
- result))
-
-(ert-deftest typescript-tslint-report-regexp-matches ()
- "typescript-tslint-report-regexp matches a line that does not
-have a rule name or a severity."
- (let* ((to-match
- "src/modules/authenticator.ts[1, 83]: ' should be \"")
- (match (string-match typescript-tslint-report-regexp
- to-match))
- (matches (and match (get-all-matched-strings to-match))))
- (should match)
- (should (not (nth 1 matches)))
- (should (not (nth 2 matches)))
- (should (string-equal (nth 3 matches)
- "src/modules/authenticator.ts"))
- (should (string-equal (nth 4 matches) "1"))
- (should (string-equal (nth 5 matches) "83"))))
-
-(ert-deftest typescript-tslint-report-regexp-matches-with-name ()
- "typescript-tslint-report-regexp matches a line that has
-a rule name, no severity."
- (let* ((to-match
- "(quotemark) src/modules/authenticator.ts[1, 83]: ' should be \"")
- (match (string-match typescript-tslint-report-regexp
- to-match))
- (matches (and match (get-all-matched-strings to-match))))
- (should match)
- (should (not (nth 1 matches)))
- (should (string-equal (nth 2 matches) "(quotemark) "))
- (should (string-equal (nth 3 matches)
- "src/modules/authenticator.ts"))
- (should (string-equal (nth 4 matches) "1"))
- (should (string-equal (nth 5 matches) "83"))))
-
-(ert-deftest typescript-tslint-report-regexp-matches-with-error ()
- "typescript-tslint-report-regexp matches a line that has
-a severity set to ERROR, no rule name."
- (let* ((to-match
- "ERROR: src/modules/authenticator.ts[1, 83]: ' should be \"")
- (match (string-match typescript-tslint-report-regexp
- to-match))
- (matches (and match (get-all-matched-strings to-match))))
- (should match)
- (should (not (nth 1 matches)))
- (should (not (nth 2 matches)))
- (should (string-equal (nth 3 matches)
- "src/modules/authenticator.ts"))
- (should (string-equal (nth 4 matches) "1"))
- (should (string-equal (nth 5 matches) "83"))))
-
-(ert-deftest typescript-tslint-report-regexp-matches-with-warning ()
- "typescript-tslint-report-regexp matches a line that has
-a severity set to WARNING, no rule name."
- (let* ((to-match
- "WARNING: src/modules/authenticator.ts[1, 83]: ' should be \"")
- (match (string-match typescript-tslint-report-regexp
- to-match))
- (matches (and match (get-all-matched-strings to-match))))
- (should match)
- (should (string-equal (nth 1 matches) "WARNING"))
- (should (not (nth 2 matches)))
- (should (string-equal (nth 3 matches)
- "src/modules/authenticator.ts"))
- (should (string-equal (nth 4 matches) "1"))
- (should (string-equal (nth 5 matches) "83"))))
-
-(ert-deftest typescript--number-literal-re-matches-numbers ()
- "`typescript--number-literal-re' matches numbers."
- (dolist (to-match '("NaN" "Infinity" "-Infinity" "-1" "1" "0.1" ".1" "-.1"
"8e23"
- "9E-2" ".1e23" "0b1" "-0B1" "0o7" "-0O13" "0xaf"
"-0XAF"))
- (should (string-match typescript--number-literal-re to-match))
- ;; The regular expression does not begin with ^ and end with $ so
- ;; we need to check ourselves that the whole string is matched.
- (should (string-equal (match-string 0 to-match) to-match))))
-
-(ert-deftest typescript--number-literal-re-does-not-match-non-numbers ()
- "`typescript--number-literal-re' does not match non-numbers."
- (dolist (to-match '("NaNa" "Inf" "1." "." "0xPQ" "e" "2.3e2.4"))
- ;; For the same reason as for the positive test above, what we want is
either no match
- ;; or a match that fails to match the whole string.
- (should-not (and (string-match typescript--number-literal-re to-match)
- (string-equal (match-string 0 to-match) to-match)))))
-
-(ert-deftest correctly-indents-lines-with-wide-chars ()
- "Otsuka Ai and other multi-char users should be a happy to write typescript."
-
- (with-temp-buffer
- (ignore-errors (typescript-mode))
- (insert "let x = '大塚愛'")
- (let ((pos1 (current-column)))
- (typescript-indent-line)
- (let ((pos2 (current-column)))
- (should (= pos1 pos2))))))
-
-(ert-deftest correctly-indents-lines-with-tabs ()
- (with-temp-buffer
- (ignore-errors (typescript-mode))
-
- (insert "class Example {")
- (newline-and-indent)
- (insert "constructor() {")
- (newline-and-indent)
- (insert "const a = new Promise")
-
- (should (= 29 (current-column)))
- (typescript-indent-line)
- (should (= 29 (current-column)))
-
- ;; verify tab was used
- (move-beginning-of-line nil)
- (should (= 0 (current-column)))
- (forward-char 1)
- (should (= 8 (current-column)))))
-
-(ert-deftest indentation-does-not-hang-on-multiline-string ()
- "Testcase for https://github.com/ananthakumaran/typescript.el/issues/20";
-
- (with-temp-buffer
- (typescript-mode)
-
- (insert "let multiLineString = \"line 1")
- (newline-and-indent)
- (insert "// and so we continue")
- (newline-and-indent)
- ;; completing and not locking up is test-success!
- ))
-
-(defun test-re-search (searchee contents offset)
- (with-temp-buffer
- (typescript-mode)
-
- (insert contents)
- (goto-char (- (point-max) offset))
-
- (should (= 5 (typescript--re-search-backward-inner searchee nil 1)))))
-
-(ert-deftest re-search-backwards-skips-single-line-strings ()
- (test-re-search "token" "let token = \"token in string-thing\";" 2))
-
-(ert-deftest re-search-backwards-skips-multi-line-strings ()
- (test-re-search "token" "let token = \"token in\n multi-line token
string\";" 2))
-
-(ert-deftest re-search-backwards-skips-single-line-comments ()
- (test-re-search "token" "let token; // token in comment" 0))
-
-(ert-deftest re-search-backwards-skips-multi-line-comments ()
- (test-re-search "token" "let token; /* token in \nmulti-line token comment"
0))
-
-;; Adapted from jdee-mode's test suite.
-(defmacro test-with-temp-buffer (content &rest body)
- "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
- (declare (debug t)
- (indent 1))
- `(with-temp-buffer
- (insert ,content)
- (typescript-mode)
- (goto-char (point-min))
- ;; We need this so that tests that simulate user actions operate on the
right buffer.
- (switch-to-buffer (current-buffer))
- ,@body))
-
-(defmacro test-with-fontified-buffer (content &rest body)
- "Fill a temporary buffer with `CONTENT' and eval `BODY' in it."
- (declare (debug t)
- (indent 1))
- `(test-with-temp-buffer
- ,content
- (font-lock-fontify-buffer)
- ,@body))
-
-(defun get-face-at (loc)
- "Get the face at `LOC'. If it is not a number, then we `re-search-forward'
with `LOC'
-as the search pattern."
- (when (not (numberp loc))
- (save-excursion
- (re-search-forward loc)
- (setq loc (match-beginning 0))))
- (get-text-property loc 'face))
-
-(setq font-lock-contents
- " * @param {Something} bar A parameter. References [[moo]] and [[foo]].
- * @param second May hold ``x`` or ``y``.")
-
-(defun font-lock-test (contents expected)
- "Perform a test on our template. `CONTENTS' is the string to
-put in the temporary buffer. `EXPECTED' is the expected
-results. It should be a list of (LOCATION . FACE) pairs, where
-LOCATION can be either a single location, or list of locations,
-that are all expected to have the same face."
- (test-with-fontified-buffer
- contents
- ;; Make sure our propertize function has been applied to the whole
- ;; buffer.
- (syntax-propertize (point-max))
- (dolist (spec expected)
- (if (listp (car spec))
- (dolist (source (car spec))
- (should (eq (get-face-at source) (cdr spec))))
- (should (eq (get-face-at (car spec)) (cdr spec)))))))
-
-(ert-deftest font-lock/documentation-in-documentation-comments ()
- "Documentation in documentation comments should be fontified as
-documentation."
- (font-lock-test
- (concat "/**\n" font-lock-contents "\n*/")
- '((1 . font-lock-comment-delimiter-face)
- (5 . font-lock-comment-face)
- ("@param" . typescript-jsdoc-tag)
- ("{Something}" . typescript-jsdoc-type)
- ("bar" . typescript-jsdoc-value)
- ("\\[\\[moo\\]\\]" . typescript-jsdoc-value)
- ("\\[\\[foo\\]\\]" . typescript-jsdoc-value)
- ("``x``" . typescript-jsdoc-value)
- ("``y``" . typescript-jsdoc-value))))
-
-(ert-deftest font-lock/no-documentation-in-non-documentation-comments ()
- "Documentation tags that are not in documentation comments
-should not be fontified as documentation."
- (test-with-fontified-buffer
- (concat "/*\n" font-lock-contents "\n*/\n")
- (let ((loc 3))
- ;; Make sure we start with the right face.
- (should (eq (get-face-at loc) font-lock-comment-face))
- (should (eq (text-property-not-all loc (point-max) 'face
font-lock-comment-face)
- (1- (point-max)))))))
-
-(ert-deftest font-lock/no-documentation-in-strings ()
- "Documentation tags that are not in strings should not be
-fontified as documentation."
- (test-with-fontified-buffer
- (concat "const x = \"/**" font-lock-contents "*/\";")
- (let ((loc (search-forward "\"")))
- ;; Make sure we start with the right face.
- (should (eq (get-face-at loc) font-lock-string-face))
- ;; Make sure the face does not change later.
- (should (eq (text-property-not-all loc (point-max) 'face
font-lock-string-face)
- (1- (point-max)))))))
-
-(ert-deftest font-lock/immediate-doc ()
- "Tests that it is not necessary to have the documentation tag on a
-new line after the start of '/**'."
- (font-lock-test
- ;; We have 4 comments here because we need to cover the multiple
- ;; regexes that deal with the different types of jsdoc tags.
- "/** @type {foo} */\n
-/** @alias bar */\n
-/** @author me */\n
-/** @param meow */"
- '((1 . font-lock-comment-delimiter-face)
- ("@type" . typescript-jsdoc-tag)
- ("{foo}" . typescript-jsdoc-type)
- ("@alias" . typescript-jsdoc-tag)
- ("bar" . typescript-jsdoc-value)
- ("@author" . typescript-jsdoc-tag)
- ("me" . font-lock-comment-face)
- ("@param" . typescript-jsdoc-tag)
- ("meow" . typescript-jsdoc-value))))
-
-(ert-deftest font-lock/function-definition-prefixes ()
- "Tests that function names are highlighted in definitions, even
-when prefixed with module modifiers."
- (font-lock-test
- "function basicDefn(x0: xty0, y0: yty0): ret0 {}\n
-export function exportedDefn(x1: xty1, y1: yty1): ret1 {}\n
-export default function exportedDefaultDefn(x2: xty2, y2: yty2): ret2 {}\n
-declare function declareFunctionDefn(x3: xty3, y3: yty3): ret3;"
- '(("basicDefn" . font-lock-function-name-face)
- ("exportedDefn" . font-lock-function-name-face)
- ("exportedDefaultDefn" . font-lock-function-name-face)
- ("declareFunctionDefn" . font-lock-function-name-face)
- (("x0" "x1" "x2" "x3") . font-lock-variable-name-face)
- (("y0" "y1" "y2" "y3") . font-lock-variable-name-face)
- (("ret0" "ret1" "ret2" "ret3") . nil))))
-
-(ert-deftest font-lock/regexp ()
- "Regular expresssions should be fontified as string constant."
- (let ((content "=/foo/ (/bar/ ,/baz/ :/buzz/"))
- (font-lock-test content
- '(("=" . nil) ("/foo/" . font-lock-string-face)
- ("(" . nil) ("/bar/" . font-lock-string-face)
- ("," . nil) ("/baz/" . font-lock-string-face)
- (":" . nil) ("/buzz/" . font-lock-string-face))))
- ;; Make sure that escaped forward slashes are handled too.
- (font-lock-test "var a = /flip\\/flop/;"
- '(("=" . nil)
- (("/flip" "\\\\" "/" "flop/") . font-lock-string-face)
- (";" . nil)))
- ;; Make sure a forward slash in a character class is handled fine.
- ;; It must not terminate the regular expression.
- (font-lock-test "var a = /[/]/;"
- '(("=" . nil)
- (("/" "\\[/" "\\]/") . font-lock-string-face)
- (";" . nil)))
- ;; Make sure an open bracket in a character class does not
- ;; throw off fontification.
- (font-lock-test "var a = /[[]/;"
- '(("=" . nil)
- (("/" "\\[\\[\\]" "/") . font-lock-string-face)
- (";" . nil)))
- ;; A sequence of two forward slashes is never a regex, so there is
- ;; no such thing as an \"empty regex\" when we use the forward slash
- ;; notation.
- (font-lock-test "=//g something // comment"
- '(("g something" . font-lock-comment-face))))
-
-(ert-deftest font-lock/yield ()
- "`yield' and `yield*' should be fontified as keywords."
- (font-lock-test
- "function* gen(x0: xty0, y0: yty0): ret0 {
- yield 123;
- yield* subIter;
-}"
- '(("yield 123" . font-lock-keyword-face)
- ("yield\\*" . font-lock-keyword-face)
- ("\\* subIter" . font-lock-keyword-face))))
-
-(ert-deftest font-lock/yielder ()
- "`yielder' should not be fontified as a keyword."
- (font-lock-test
- "function* gen(x0: xty0, y0: yty0): ret0 {
- const yielder = 123;
- yield abc;
- return yielder;
-}"
- '(("yielder =" . font-lock-variable-name-face)
- ("yielder;" . nil))))
-
-(ert-deftest
font-lock/text-after-trailing-regexp-delim-should-not-be-fontified ()
- "Text after trailing regular expression delimiter should not be fontified."
- (test-with-fontified-buffer
- "=/foo/g something // comment"
- (should (eq (get-face-at "g something") nil)))
- (test-with-fontified-buffer
- "=/foo\\bar/g something // comment"
- (should (eq (get-face-at "g something") nil)))
- (test-with-fontified-buffer
- "=/foo\\\\bar/g something // comment"
- (should (eq (get-face-at "g something") nil)))
- (test-with-fontified-buffer
- "=/foo\\\\/g something // comment"
- (should (eq (get-face-at "g something") nil))))
-
-(ert-deftest font-lock/type-names ()
- "Type names should be highlighted in definitions."
- ;; Typical case.
- (test-with-fontified-buffer
- "export class Foo extends Bar implements Qux {}"
- (should (eq (get-face-at "Foo") 'font-lock-type-face))
- (should (eq (get-face-at "Bar") 'font-lock-type-face))
- (should (eq (get-face-at "Qux") 'font-lock-type-face)))
- ;; Ensure we require symbol boundaries.
- (test-with-fontified-buffer
- "Notclass Foo"
- (should (not (eq (get-face-at "Foo") 'font-lock-type-face))))
- ;; Other common ways of defining types.
- (test-with-fontified-buffer
- "interface Thing {}"
- (should (eq (get-face-at "Thing") 'font-lock-type-face)))
- (test-with-fontified-buffer
- "enum Thing {}"
- (should (eq (get-face-at "Thing") 'font-lock-type-face)))
- (test-with-fontified-buffer
- "type Thing = number;"
- (should (eq (get-face-at "Thing") 'font-lock-type-face))))
-
-(defun flyspell-predicate-test (search-for)
- "This function runs a test on
-`typescript--flyspell-mode-predicate'. `SEARCH-FOR' is a string
-to search for in the current buffer before running
-`typescript--flyspell-mode-predicate'. This test checks that the
-point has not moved. It returns the value of returned by the
-invocation of `typescript--flyspell-mode-predicate'."
- (search-forward search-for)
- (let ((point-before (point)))
- (prog1
- (typescript--flyspell-mode-predicate)
- ;; We should not have moved.
- (should (eq (point) point-before)))
- ))
-
-(ert-deftest flyspell-mode-predicate-skips-what-it-should ()
- "Check that the custom flyspell predicate filters strings in
-import... from...."
- (let (flyspell-generic-progmode-verify)
- (fset 'flyspell-generic-progmode-verify (lambda () t))
- ;; In the following searches we search for the starting quote of the
strings
- ;; to avoid hitting keywords. Moreover, the end position of the search is
important.
- ;; Flyspell puts point at the end of the word before calling the
predicate. We must
- ;; replicate that behavior here.
- (test-with-fontified-buffer
- "import 'a';\nimport { x } from 'b';\nconst foo = 'c';import { x }\nfrom
'd';"
- (should (not (flyspell-predicate-test "'a")))
- (should (not (flyspell-predicate-test "'b")))
- (should (flyspell-predicate-test "'c"))
- (should (not (flyspell-predicate-test "'d"))))
- (test-with-fontified-buffer
- ;; This is valid TypeScript.
- "const from = 'a';"
- (should (flyspell-predicate-test "'a")))
- (test-with-fontified-buffer
- ;; TypeScript does not allow a function named "import" but object
- ;; members may be named "import". So this *can* be valid
- ;; TypeScript.
- "x.import('a');"
- (should (flyspell-predicate-test "'a")))))
-
-
-(ert-deftest typescript--move-to-end-of-plain-string ()
- "Unit tests for `typescript--move-to-end-of-plain-string'."
- (cl-flet
- ((should-fail ()
- (let ((point-before (point)))
- (should (not (typescript--move-to-end-of-plain-string)))
- (should (eq (point) point-before))))
- (should-not-fail (expected)
- (let ((result
(typescript--move-to-end-of-plain-string)))
- (should (eq result expected))
- (should (eq (point) expected)))))
- ;;
- ;; The tests below are structured as follows. For each case:
- ;;
- ;; 1. Move point to a new location in the buffer.
- ;;
- ;; 2. Check whether typescript--move-to-end-of-plain-string returns the
value we expected
- ;; and changes (point) when successful.
- ;;
- ;; Cases often start with a check right away: (point) equal to
- ;; (point-min) for those cases.
- ;;
- (dolist (delimiter '("'" "\""))
- (test-with-temp-buffer
- (replace-regexp-in-string "'" delimiter "const a = 'not terminated")
- (should-fail)
- (re-search-forward delimiter)
- (should-fail))
- (test-with-temp-buffer
- (replace-regexp-in-string "'" delimiter "const a = 'terminated'")
- (should-fail)
- ;; This checks that the function works when invoked on the start
delimiter of
- ;; a terminated string.
- (re-search-forward delimiter)
- (should-not-fail (1- (point-max)))
- (goto-char (point-min))
- (re-search-forward "term")
- (should-not-fail (1- (point-max)))
- ;; This checks that the function works when invoked on the end
delimiter of
- ;; a terminated string.
- (goto-char (1- (point-max)))
- (should-not-fail (1- (point-max))))
- (test-with-temp-buffer
- (replace-regexp-in-string "'" delimiter "const a = 'terminated aaa';\n
-const b = 'not terminated bbb")
- (should-fail)
- (re-search-forward "term")
- (should-not-fail (save-excursion (re-search-forward "aaa")))
- (re-search-forward "const b")
- (should-fail)
- (re-search-forward "not terminated")
- (should-fail))
- ;; Case with escaped delimiter.
- (test-with-temp-buffer
- (replace-regexp-in-string "'" delimiter "const a = 'terminat\\'ed
aaa';\n
- const b = 'not terminated bbb")
- (re-search-forward "term")
- (should-not-fail (save-excursion (re-search-forward "aaa"))))
- ;; Delimiters in comments.
- (test-with-temp-buffer
- (replace-regexp-in-string "'" delimiter "const a = 'terminated aaa';\n
-// Comment 'or'\n
-const b = 'not terminated bbb")
- (re-search-forward "term")
- (should-not-fail (save-excursion (re-search-forward "aaa")))
- (re-search-forward "Comment ")
- (should-fail)
- (forward-char)
- (should-fail)
- (re-search-forward "or")
- (should-fail)))
- ;; Ignores template strings.
- (test-with-temp-buffer
- "const a = `terminated aaa`"
- (re-search-forward "term")
- (should-fail))))
-
-(ert-deftest typescript-convert-to-template ()
- "Unit tests for `typescript-convert-to-template'."
- (cl-flet
- ((should-do-nothing (str regexp)
- (test-with-temp-buffer
- str
- (re-search-forward regexp)
- (typescript-convert-to-template)
- (should (string-equal (typescript-test-get-doc) str))))
- (should-modify (str delimiter regexp)
- (test-with-temp-buffer
- str
- (re-search-forward regexp)
- (typescript-convert-to-template)
- (should (string-equal (typescript-test-get-doc)
- (replace-regexp-in-string delimiter
"`" str))))))
- (dolist (delimiter '("'" "\""))
- (let ((str (replace-regexp-in-string "'" delimiter "const a = 'not
terminated")))
- (dolist (move-to '("const" "not"))
- (should-do-nothing str move-to)))
- (let ((str (replace-regexp-in-string "'" delimiter "const a =
'terminated'")))
- (should-do-nothing str "const")
- (should-modify str delimiter delimiter)
- (should-modify str delimiter "term")
- (should-modify str delimiter "terminated"))
- ;; Delimiters in comments.
- (let ((str (replace-regexp-in-string "'" delimiter "const a =
'terminated aaa';\n
-// Comment 'or'\n
-const b = 'not terminated bbb")))
- (should-do-nothing str "Comment ")))
- ;; Ignores template strings.
- (let ((str "const a = `terminated aaa`"))
- (should-do-nothing str "terminated"))))
-
-(ert-deftest typescript-autoconvert-to-template ()
- "Unit tests for `typescript-autoconvert-to-template'."
- (cl-flet
- ((should-do-nothing (str regexp)
- (test-with-temp-buffer
- str
- (re-search-forward regexp)
- (typescript-autoconvert-to-template)
- (should (string-equal (typescript-test-get-doc) str))))
- (should-modify (str delimiter regexp)
- (test-with-temp-buffer
- str
- (re-search-forward regexp)
- (typescript-autoconvert-to-template)
- (should (string-equal (typescript-test-get-doc)
- (replace-regexp-in-string delimiter
"`" str))))))
- (dolist (delimiter '("'" "\""))
- (let ((str (replace-regexp-in-string "'" delimiter "const a =
'terminated'")))
- (should-do-nothing str "= ")
- (should-do-nothing str "terminated"))
- (let ((str (replace-regexp-in-string "'" delimiter "const a =
'${foo}'")))
- (should-do-nothing str "= ")
- (should-modify str delimiter (concat "foo}" delimiter))))))
-
-(ert-deftest typescript-autoconvert-to-template-is-invoked ()
- "Test that we call `typescript-autoconvert-to-template' as needed."
- (cl-flet
- ((should-do-nothing (str delimiter)
- (test-with-temp-buffer
- str
- (goto-char (point-max))
- (execute-kbd-macro delimiter)
- (should (string-equal (typescript-test-get-doc) (concat
str delimiter)))))
- (should-modify (str delimiter)
- (test-with-temp-buffer
- str
- (goto-char (point-max))
- (execute-kbd-macro delimiter)
- (should (string-equal (typescript-test-get-doc)
- (replace-regexp-in-string delimiter
"`" (concat str delimiter)))))))
- (dolist (delimiter '("'" "\""))
- (let ((str (replace-regexp-in-string "'" delimiter "const a = '${foo}")))
- (should-do-nothing str delimiter)
- (let ((typescript-autoconvert-to-template-flag t))
- (should-modify str delimiter))))))
-
-;; compilation-mode tests
-
-(ert-deftest recognizes-tsc-errors ()
-
- (dolist (test-case
- `(("test.ts(2,7): error TS2322: Type '2' is not assignable to type
'string'."
- ,typescript-tsc-error-regexp
- "test.ts")
-
- ("test.ts:2:7 - error TS2322: Type '2' is not assignable to type
'string'."
- ,typescript-tsc-pretty-error-regexp
- "test.ts")
- ))
- (let* ((text (car test-case))
- (regexp (cadr test-case))
- (matched-file-name (cl-caddr test-case))
- (times 1))
- (with-temp-buffer
- (insert text)
- (goto-char (point-min))
-
- (re-search-forward regexp)
- (should
- (equal matched-file-name (match-string 1)))))))
-
+(require 'typescript-mode-test-utilities)
+(require 'typescript-mode-general-tests)
+(require 'typescript-mode-jsdoc-tests)
(provide 'typescript-mode-tests)
- [nongnu] elpa/typescript-mode bce2e73cf2 107/222: Remove unused dependencies, (continued)
- [nongnu] elpa/typescript-mode bce2e73cf2 107/222: Remove unused dependencies, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 7172a23d86 072/222: Add a custom predicate for flyspell-prog-mode., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode d8501770f6 103/222: Fix indentation of multiple curly braces in sequence., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode a09e9c78f9 108/222: Highlight class names., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 7c6fd0f4a8 115/222: Document how to handle ANSI codes in error messages., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 9796425fdb 113/222: Add support for new type "unknown"., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 39b7ba9e54 117/222: Distinguish type arguments from lesser/greater than. (Fixes #81), ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 30f8b8feb4 122/222: Merge pull request #87 from Ailrun/add-jsdoc-tags, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 29282a32b7 124/222: add never type, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 8910e12525 129/222: Add autoload cookie with safe-local-var for typescript-indent-level, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode fbaad515c9 132/222: Merge pull request #89 from Ailrun/update-jsdoc-tests,
ELPA Syncer <=
- [nongnu] elpa/typescript-mode 32146510b8 147/222: Pin our dist to Trusty., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 706f938aef 155/222: force generic regex to include symbol before it (#119), ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode e38492f1cd 179/222: Extend Type-name to support namespace-prefixes., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 7040961735 166/222: Highlight type-names in type-casts too., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode de1a696c3c 174/222: Ignore errors from backward-list, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode a7cd7a92a5 167/222: fix(font-lock): prefer fontifying constants over keywords, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 1767de1095 180/222: Merge pull request #129 from emacs-typescript/feature/types-in-declarations, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 0d5c941c4c 195/222: * typescript-mode.el: Use EOS instead of EOL for auto mode regexp., ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 7d80174b23 216/222: Skip past ? and ! in typescript--compute-member-expression-indent, ELPA Syncer, 2022/02/06
- [nongnu] elpa/typescript-mode 6918f3f6d7 212/222: Merge pull request #154 from emacs-typescript/feature/build-tasks, ELPA Syncer, 2022/02/06