Introduce jsduck config (#286)

Contains overrides for jsdoc for legacy environments still using jsduck.

Fixes #285

jsdoc.json

@@ -3,13 +3,11 @@
 	"settings": {
 		"jsdoc": {
 			"tagNamePreference": {
-				"alternateClassName": "alias",
 				"arg": "param",
 				"argument": "param",
 				"augments": "extends",
 				"cfg": "cfg",
 				"chainable": "chainable",
-				"context": "this",
 				"constant": "const",
 				"defaultvalue": "default",
 				"description": "desc",

jsduck.json

@@ -0,0 +1,16 @@
+{
+	"extends": [ "./jsdoc" ],
+	"settings": {
+		"jsdoc": {
+			"tagNamePreference": {
+				"this": "context",
+				"alias": "alternateClassName",
+				"typedef": "type"
+			}
+		}
+	},
+	"rules": {
+		"jsdoc/require-returns": "off",
+		"jsdoc/require-returns-check": "off"
+    }
+}

package.json

@@ -29,6 +29,7 @@
 		"node.json",
 		"jquery.json",
 		"jsdoc.json",
+		"jsduck.json",
 		"mediawiki.json",
 		"mocha.json",
 		"qunit.json",

test/fixtures/jsdoc/invalid.js

@@ -44,6 +44,16 @@
 	APP.method = function () {
 	};
 
+	/* eslint-disable jsdoc/require-returns, jsdoc/require-returns-check */
+	/**
+	 * @return {Object} foo
+	 * @return {number} foo.bar
+	 */
+	APP.method = function () {
+		return { bar: 7 };
+	};
+	/* eslint-enable jsdoc/require-returns, jsdoc/require-returns-check */
+
 	// eslint-disable-next-line jsdoc/implements-on-classes
 	/**
 	 * @implements {HTMLElement}
@@ -239,4 +249,16 @@
 	 * @yields
 	 */
 
+	// eslint-disable-next-line jsdoc/check-tag-names
+	/**
+	 * @context
+	 */
+
+	// eslint-disable-next-line jsdoc/check-tag-names
+	/**
+	 * @alternateClassName
+	 */
+
+	// @type is allowed in jsdoc and jsduck
+
 }( this ) );

test/fixtures/jsdoc/valid.js

@@ -86,6 +86,9 @@
 	 * {@link APP}
 	 * {@link APP}
 	 *
+	 * @this Foo
+	 * @alias Bar
+	 * @typedef Baz
 	 * @abstract
 	 * @extends String
 	 * @class

test/fixtures/jsduck/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+	"root": true,
+	"extends": [
+		"../../../client",
+		"../../../jsduck"
+	],
+	"rules": {
+		"no-usused-vars": "off",
+		"no-implicit-globals": "off"
+	}
+}

test/fixtures/jsduck/invalid.js

@@ -0,0 +1,18 @@
+( function () {
+
+	// eslint-disable-next-line jsdoc/check-tag-names
+	/**
+	 * @this Foo
+	 */
+
+	// eslint-disable-next-line jsdoc/check-tag-names
+	/**
+	 * @alias Bar
+	 */
+
+	// eslint-disable-next-line jsdoc/check-tag-names
+	/**
+	 * @typedef Baz
+	 */
+
+}( this ) );

test/fixtures/jsduck/valid.js

@@ -0,0 +1,44 @@
+( function () {
+	var APP;
+
+	// In jsduck environments we need to support this use case
+	// to document complex returns, however this triggers
+	// require-returns and require-returns check:
+
+	// Off: jsdoc/require-returns
+	// Off: jsdoc/require-returns-check
+	/**
+	 * @return {Object} foo
+	 * @return {number} foo.bar
+	 */
+	APP.method = function () {
+		return { bar: 7 };
+	};
+
+	// These means we can't catch the following errors:
+
+	// Off: jsdoc/require-returns
+	/**
+	 * @param {number} bar
+	 */
+	APP.method = function ( bar ) {
+		return { bar: bar };
+	};
+
+	// Off: jsdoc/require-returns-check
+	/**
+	 * @return {number}
+	 */
+	APP.method = function () {
+	};
+
+	// Some different aliases are used in jsduck:
+	/**
+	 * @context {jQuery}
+	 * @alternateClassName otherName
+	 * @type {Object}
+	 */
+	APP.method = function () {
+	};
+
+}( this ) );