jenkins-bot has submitted this change and it was merged.
Change subject: Enable eslint:valid-jsdoc with exceptions for @chainable
......................................................................
Enable eslint:valid-jsdoc with exceptions for @chainable
Change-Id: Ic92b425d4060a7263bf5cd131fcbd1cc443fcb3d
---
M .eslintrc.json
M src/ce/ve.ce.View.js
M src/dm/ve.dm.SurfaceFragment.js
M src/ui/ve.ui.Context.js
M src/ui/ve.ui.ContextItem.js
M src/ui/ve.ui.Surface.js
M src/ui/widgets/ve.ui.LanguageResultWidget.js
M src/ui/widgets/ve.ui.LinkAnnotationWidget.js
M src/ve.EventSequencer.js
M src/ve.Filibuster.js
10 files changed, 19 insertions(+), 1 deletion(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.eslintrc.json b/.eslintrc.json
index 23a927c..10222e1 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -15,7 +15,6 @@
},
"rules": {
"dot-notation": 0,
- "valid-jsdoc": 0,
"wrap-iife": 0,
"no-console": "error",
"spaced-comment": ["error", "always", { "exceptions": ["*",
"!"] }]
diff --git a/src/ce/ve.ce.View.js b/src/ce/ve.ce.View.js
index 0affa81..c21ddf8 100644
--- a/src/ce/ve.ce.View.js
+++ b/src/ce/ve.ce.View.js
@@ -70,6 +70,7 @@
/* Static members */
+// eslint-disable-next-line valid-jsdoc
/**
* Allowed attributes for DOM elements, in the same format as
ve.dm.Model#preserveHtmlAttributes
*
diff --git a/src/dm/ve.dm.SurfaceFragment.js b/src/dm/ve.dm.SurfaceFragment.js
index 06c95e4..0b60e0a 100644
--- a/src/dm/ve.dm.SurfaceFragment.js
+++ b/src/dm/ve.dm.SurfaceFragment.js
@@ -4,6 +4,9 @@
* @copyright 2011-2016 VisualEditor Team and others; see
http://ve.mit-license.org
*/
+// HACK: eslint valid-jsdoc doesn't yet support @chainable:
https://github.com/eslint/eslint/issues/6681
+/* eslint-disable valid-jsdoc */
+
/**
* DataModel surface fragment.
*
diff --git a/src/ui/ve.ui.Context.js b/src/ui/ve.ui.Context.js
index 43d3222..f58b6a8 100644
--- a/src/ui/ve.ui.Context.js
+++ b/src/ui/ve.ui.Context.js
@@ -106,6 +106,8 @@
return this.surface;
};
+/* eslint-disable valid-jsdoc */
+
/**
* Toggle the menu.
*
diff --git a/src/ui/ve.ui.ContextItem.js b/src/ui/ve.ui.ContextItem.js
index 8b6491d..461fd0e 100644
--- a/src/ui/ve.ui.ContextItem.js
+++ b/src/ui/ve.ui.ContextItem.js
@@ -125,6 +125,8 @@
return this.fragment;
};
+/* eslint-disable valid-jsdoc */
+
/**
* Setup the item.
*
diff --git a/src/ui/ve.ui.Surface.js b/src/ui/ve.ui.Surface.js
index d16b1cf..38823b1 100644
--- a/src/ui/ve.ui.Surface.js
+++ b/src/ui/ve.ui.Surface.js
@@ -121,6 +121,8 @@
/* Methods */
+/* eslint-disable valid-jsdoc */
+
/**
* Destroy the surface, releasing all memory and removing all DOM elements.
*
@@ -408,6 +410,8 @@
return this.setDisabled( false );
};
+/* eslint-enable valid-jsdoc */
+
/**
* Handle transact events from the document model
*
diff --git a/src/ui/widgets/ve.ui.LanguageResultWidget.js
b/src/ui/widgets/ve.ui.LanguageResultWidget.js
index 8cd7018..7f41d23 100644
--- a/src/ui/widgets/ve.ui.LanguageResultWidget.js
+++ b/src/ui/widgets/ve.ui.LanguageResultWidget.js
@@ -30,6 +30,7 @@
/* Methods */
+// eslint-disable-next-line valid-jsdoc
/**
* Update labels based on query
*
diff --git a/src/ui/widgets/ve.ui.LinkAnnotationWidget.js
b/src/ui/widgets/ve.ui.LinkAnnotationWidget.js
index 2b6c5a7..8d9786e 100644
--- a/src/ui/widgets/ve.ui.LinkAnnotationWidget.js
+++ b/src/ui/widgets/ve.ui.LinkAnnotationWidget.js
@@ -136,6 +136,7 @@
} );
};
+// eslint-disable-next-line valid-jsdoc
/**
* Sets the annotation value.
*
diff --git a/src/ve.EventSequencer.js b/src/ve.EventSequencer.js
index caf413f..a652708 100644
--- a/src/ve.EventSequencer.js
+++ b/src/ve.EventSequencer.js
@@ -124,6 +124,8 @@
this.afterLoopTimeoutId = null;
};
+/* eslint-disable valid-jsdoc */
+
/**
* Attach to a node, to listen to its jQuery events
*
diff --git a/src/ve.Filibuster.js b/src/ve.Filibuster.js
index 25c16b8..6ccd6c1 100644
--- a/src/ve.Filibuster.js
+++ b/src/ve.Filibuster.js
@@ -69,6 +69,7 @@
this.callPath.length = 0;
};
+// eslint-disable-next-line valid-jsdoc
/**
* Attaches an observer callback. The callback returns a value representing
the current state,
* which must be a string (this ensures state values are immutable, comparable
with strict
@@ -248,6 +249,7 @@
return this;
};
+// eslint-disable-next-line valid-jsdoc
/**
* Wrap the functions in a class with wrappers that perform logging.
*
@@ -276,6 +278,7 @@
return this;
};
+// eslint-disable-next-line valid-jsdoc
/**
* Recursively wrap the functions in a namespace with wrappers that perform
logging.
*
--
To view, visit https://gerrit.wikimedia.org/r/318214
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic92b425d4060a7263bf5cd131fcbd1cc443fcb3d
Gerrit-PatchSet: 3
Gerrit-Project: VisualEditor/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Esanders <esand...@wikimedia.org>
Gerrit-Reviewer: Esanders <esand...@wikimedia.org>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
