Merge pull request #146 from sandersn/parse-typescript-types

feat: test typeof and import types from Typescript

Author: gajus

README.md

@@ -1016,7 +1016,7 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"additionalTagNames":{"customTags":["baz","bar"]}}}
 
-/**
+/** 
  * @abstract
  * @access
  * @alias
@@ -1104,9 +1104,9 @@ RegExp
 <a name="eslint-plugin-jsdoc-rules-check-types-why-not-capital-case-everything"></a>
 #### Why not capital case everything?
 
-Why are `boolean`, `number` and `string` exempt from starting with a capital letter? Let's take `string` as an example. In Javascript, everything is an object. The string Object has prototypes for string functions such as `.toUpperCase()`.
+Why are `boolean`, `number` and `string` exempt from starting with a capital letter? Let's take `string` as an example. In Javascript, everything is an object. The string Object has prototypes for string functions such as `.toUpperCase()`. 
 
-Fortunately we don't have to write `new String()` everywhere in our code. Javascript will automatically wrap string primitives into string Objects when we're applying a string function to a string primitive. This way the memory footprint is a tiny little bit smaller, and the [GC](https://en.wikipedia.org/wiki/Garbage_collection_(computer_science)) has less work to do.
+Fortunately we don't have to write `new String()` everywhere in our code. Javascript will automatically wrap string primitives into string Objects when we're applying a string function to a string primitive. This way the memory footprint is a tiny little bit smaller, and the [GC](https://en.wikipedia.org/wiki/Garbage_collection_(computer_science)) has less work to do. 
 
 So in a sense, there two types of strings in Javascript; `{string}` literals, also called primitives and `{String}` Objects. We use the primitives because it's easier to write and uses less memory. `{String}` and `{string}` are technically both valid, but they are not the same.
 
@@ -1208,6 +1208,30 @@ function quux (foo, bar, baz) {
  */
 function quux (foo, bar, baz) {
 
+}
+
+/**
+ * @param {typeof bar} foo
+ */
+function qux(foo) {
+}
+
+/**
+ * @param {import('./foo').bar.baz} foo
+ */
+function qux(foo) {
+}
+
+/**
+ * @param {(x: number, y: string) => string} foo
+ */
+function qux(foo) {
+}
+
+/**
+ * @param {() => string} foo
+ */
+function qux(foo) {
 }
 ````
 
@@ -2457,6 +2481,16 @@ function quux (foo) {
  */
 const quux = () => {}
 // Message: Present JSDoc @returns declaration but not available return expression in function.
+
+/**
+ * @returns {undefined} Foo.
+ * @returns {String} Foo.
+ */
+function quux () {
+
+  return foo;
+}
+// Message: Found more than one @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -2497,15 +2531,23 @@ function quux () {
  */
 const quux = () => foo;
 
-/**
+/** 
  * @returns {Promise<void>}
  */
 async function quux() {}
 
-/**
+/** 
  * @returns {Promise<void>}
  */
 async () => {}
+
+/** 
+ * @returns Foo.
+ * @abstract
+ */
+function quux () {
+  throw new Error('must be implemented by subclass!');
+}
 ````
 
 

package.json

@@ -6,7 +6,7 @@
   },
   "dependencies": {
     "comment-parser": "^0.5.4",
-    "jsdoctypeparser": "^2.0.0-alpha-8",
+    "jsdoctypeparser": "3.1.0",
     "lodash": "^4.17.11"
   },
   "description": "JSDoc linting rules for ESLint.",
@@ -58,7 +58,7 @@
     "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps",
     "create-readme": "gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions",
     "lint": "eslint ./src ./test",
-    "test": "mocha --recursive --require @babel/register"
+    "test": "mocha --recursive --require @babel/register --reporter progress"
   },
   "version": "1.0.0"
 }

src/rules/checkIndentation.js

@@ -7,6 +7,7 @@ export default iterateJsdoc(({
 }) => {
   const reg = new RegExp(/^[ \t]+\*[ \t]{2}/m);
   const text = sourceCode.getText(jsdocNode);
+
   if (reg.test(text)) {
     report('There must be no indentation.');
   }

test/rules/assertions/checkTypes.js

@@ -158,6 +158,42 @@ export default {
            */
           function quux (foo, bar, baz) {
 
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @param {typeof bar} foo
+           */
+          function qux(foo) {
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @param {import('./foo').bar.baz} foo
+           */
+          function qux(foo) {
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @param {(x: number, y: string) => string} foo
+           */
+          function qux(foo) {
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @param {() => string} foo
+           */
+          function qux(foo) {
           }
       `
     }