jenkins-bot has submitted this change and it was merged.
Change subject: build: Enforce disallowMixedSpacesAndTabs jscs rule
......................................................................
build: Enforce disallowMixedSpacesAndTabs jscs rule
Also, fix @returns comments (should be @return) and remove unnecessary
@method comments from the documentation.
Change-Id: Icd303626ac745c7ab5bff164f9b8cac276de1523
---
M .jscsrc
M modules/ve-mw/dm/models/ve.dm.MWImageModel.js
M modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
M modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
M modules/ve-mw/tests/dm/ve.dm.Document.test.js
5 files changed, 96 insertions(+), 65 deletions(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.jscsrc b/.jscsrc
index 449793d..5b6f4bd 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -1,6 +1,5 @@
{
"preset": "wikimedia",
- "requireSpacesInsideArrayBrackets": null,
- "disallowMixedSpacesAndTabs": null
+ "requireSpacesInsideArrayBrackets": null
}
diff --git a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
index 8fc8e7f..5813a09 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
@@ -117,7 +117,7 @@
* @param {Object} attributes Image attributes
* @param {string} [imageType] Image node type 'mwInlineImage' or
'mwBlockImage'.
* Defaults to 'mwBlockImage'
- * @returns {ve.dm.MWImageNode} An image node
+ * @return {ve.dm.MWImageNode} An image node
*/
ve.dm.MWImageModel.static.createImageNode = function ( attributes, imageType )
{
var attrs, newNode, newDimensions,
@@ -223,7 +223,7 @@
/**
* Get the hash object of the current image model state.
- * @returns {Object} Hash object
+ * @return {Object} Hash object
*/
ve.dm.MWImageModel.prototype.getHashObject = function () {
var hash = {
@@ -362,7 +362,7 @@
/**
* Get the original bounding box
- * @returns {Object} Bounding box with width and height
+ * @return {Object} Bounding box with width and height
*/
ve.dm.MWImageModel.prototype.getBoundingBox = function () {
return this.boundingBox;
@@ -682,7 +682,7 @@
/**
* Get the image file resource name
- * @returns {string} resourceName The resource name of the given media file
+ * @return {string} resourceName The resource name of the given media file
*/
ve.dm.MWImageModel.prototype.getResourceName = function () {
return this.imageResourceName;
@@ -768,18 +768,26 @@
*/
ve.dm.MWImageModel.prototype.getCaptionDocument = function () {
if ( !this.captionDoc ) {
- this.captionDoc = new ve.dm.Document( [
- { type: 'paragraph', internal: { generated: 'wrapper' }
},
- { type: '/paragraph' },
- { type: 'internalList' },
- { type: '/internalList' }
- ],
- /* htmlDocument */ null,
- /* parentDocument */ null,
- /* internalList */ null,
- /* innerWhitespace */ null,
- /* lang */ this.getLang(),
- /* dir */ this.getDir() );
+ this.captionDoc = new ve.dm.Document(
+ [
+ { type: 'paragraph', internal: { generated:
'wrapper' } },
+ { type: '/paragraph' },
+ { type: 'internalList' },
+ { type: '/internalList' }
+ ],
+ // htmlDocument
+ null,
+ // parentDocument
+ null,
+ // internalList
+ null,
+ // innerWhitespace
+ null,
+ // lang
+ this.getLang(),
+ // dir
+ this.getDir()
+ );
}
return this.captionDoc;
};
@@ -1050,7 +1058,7 @@
* The image file source that points to the location of the
* file on the web.
* For instance, '//upload.wikimedia.org/wikipedia/commons/0/0f/Foo.jpg'
- * @returns {string} The source of the given media file
+ * @return {string} The source of the given media file
*/
ve.dm.MWImageModel.prototype.getImageSource = function () {
return this.imageSrc;
@@ -1061,7 +1069,7 @@
* The resource name represents the filename without the full
* source url.
* For example, './File:Foo.jpg'
- * @returns {string} The resource name of the given media file
+ * @return {string} The resource name of the given media file
*/
ve.dm.MWImageModel.prototype.getImageResourceName = function () {
return this.imageResourceName;
@@ -1073,7 +1081,7 @@
* the link to the source of the image in commons or locally, but
* may hold an alternative link if link= is supplied in the wikitext.
* For example, './File:Foo.jpg' or 'http://www.wikipedia.org'
- * @returns {string} The destination href of the given media file
+ * @return {string} The destination href of the given media file
*/
ve.dm.MWImageModel.prototype.getImageHref = function () {
return this.imageHref;
@@ -1134,7 +1142,7 @@
/**
* Get the filename of the current image
- * @returns {string} filename Image filename
+ * @return {string} filename Image filename
*/
ve.dm.MWImageModel.prototype.getFilename = function () {
return this.filename;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
index 8ecdacd..241af70 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
@@ -66,7 +66,7 @@
* Find matching item in a surface.
*
* @param {ve.dm.Surface} surfaceModel Surface reference is in
- * @returns {ve.dm.InternalItemNode|null} Internal reference item, null if
none exists
+ * @return {ve.dm.InternalItemNode|null} Internal reference item, null if none
exists
*/
ve.dm.MWReferenceModel.prototype.findInternalItem = function ( surfaceModel ) {
if ( this.listIndex !== null ) {
@@ -223,25 +223,33 @@
*
* Auto-generates a blank document if no document exists.
*
- * @returns {ve.dm.Document} Reference document
+ * @return {ve.dm.Document} Reference document
*/
ve.dm.MWReferenceModel.prototype.getDocument = function () {
if ( !this.doc ) {
if ( this.deferDoc ) {
this.doc = this.deferDoc();
} else {
- this.doc = new ve.dm.Document( [
- { type: 'paragraph', internal: { generated:
'wrapper' } },
- { type: '/paragraph' },
- { type: 'internalList' },
- { type: '/internalList' }
- ],
- /* htmlDocument */ null,
- /* parentDocument */ null,
- /* internalList */ null,
- /* innerWhitespace */ null,
- /* lang */ this.getLang(),
- /* dir */ this.getDir() );
+ this.doc = new ve.dm.Document(
+ [
+ { type: 'paragraph', internal: {
generated: 'wrapper' } },
+ { type: '/paragraph' },
+ { type: 'internalList' },
+ { type: '/internalList' }
+ ],
+ // htmlDocument
+ null,
+ // parentDocument
+ null,
+ // internalList
+ null,
+ // innerWhitespace
+ null,
+ // lang
+ this.getLang(),
+ // dir
+ this.getDir()
+ );
}
}
return this.doc;
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
index f6c4503..31fe68d 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
@@ -245,7 +245,7 @@
* @static
* @param {Object} dataElement Element data
* @param {ve.dm.InternalList} internalList Internal list
- * @returns {string} Reference label
+ * @return {string} Reference label
*/
ve.dm.MWReferenceNode.static.getIndexLabel = function ( dataElement,
internalList ) {
var listIndex = dataElement.attributes.listIndex,
@@ -270,8 +270,8 @@
/**
* Gets the internal item node associated with this node
- * @method
- * @returns {ve.dm.InternalItemNode} Item node
+ *
+ * @return {ve.dm.InternalItemNode} Item node
*/
ve.dm.MWReferenceNode.prototype.getInternalItem = function () {
return this.getDocument().getInternalList().getItemNode(
this.getAttribute( 'listIndex' ) );
@@ -279,8 +279,8 @@
/**
* Gets the index label for the reference
- * @method
- * @returns {string} Reference label
+ *
+ * @return {string} Reference label
*/
ve.dm.MWReferenceNode.prototype.getIndexLabel = function () {
return this.constructor.static.getIndexLabel( this.element,
this.getDocument().getInternalList() );
@@ -288,7 +288,6 @@
/**
* Handle the node being attached to the root
- * @method
*/
ve.dm.MWReferenceNode.prototype.onRoot = function () {
this.addToInternalList();
@@ -296,7 +295,6 @@
/**
* Handle the node being detatched from the root
- * @method
*/
ve.dm.MWReferenceNode.prototype.onUnroot = function () {
this.removeFromInternalList();
@@ -304,7 +302,6 @@
/**
* Register the node with the internal list
- * @method
*/
ve.dm.MWReferenceNode.prototype.addToInternalList = function () {
if ( this.getRoot() === this.getDocument().getDocumentNode() ) {
@@ -319,7 +316,6 @@
/**
* Unregister the node from the internal list
- * @method
*/
ve.dm.MWReferenceNode.prototype.removeFromInternalList = function () {
this.getDocument().getInternalList().removeNode(
diff --git a/modules/ve-mw/tests/dm/ve.dm.Document.test.js
b/modules/ve-mw/tests/dm/ve.dm.Document.test.js
index 45c4099..f43d8d7 100644
--- a/modules/ve-mw/tests/dm/ve.dm.Document.test.js
+++ b/modules/ve-mw/tests/dm/ve.dm.Document.test.js
@@ -21,8 +21,10 @@
tests = [
{
data: [
- /* 0 */ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
- /* 1 */ { type: '/mwBlockImage' }
+ // 0
+ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
+ // 1
+ { type: '/mwBlockImage' }
],
cases: [
{
@@ -89,10 +91,14 @@
},
{
data: [
- /* 0 */ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
- /* 1 */ { type: '/mwBlockImage' },
- /* 2 */ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
- /* 3 */ { type: '/mwBlockImage' }
+ // 0
+ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
+ // 1
+ { type: '/mwBlockImage' },
+ // 2
+ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
+ // 3
+ { type: '/mwBlockImage' }
],
cases: [
{
@@ -129,12 +135,18 @@
},
{
data: [
- /* 0 */ { type: 'alienBlock' },
- /* 1 */ { type: '/alienBlock' },
- /* 2 */ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
- /* 3 */ { type: '/mwBlockImage' },
- /* 4 */ { type: 'alienBlock' },
- /* 5 */ { type: '/alienBlock' }
+ // 0
+ { type: 'alienBlock' },
+ // 1
+ { type: '/alienBlock' },
+ // 2
+ ve.copy(
ve.dm.mwExample.MWBlockImage.data[0] ),
+ // 3
+ { type: '/mwBlockImage' },
+ // 4
+ { type: 'alienBlock' },
+ // 5
+ { type: '/alienBlock' }
],
cases: [
{
@@ -183,14 +195,22 @@
},
{
data: [
- /* 0 */ { type: 'paragraph' },
- /* 1 */ { type: 'alienInline' },
- /* 2 */ { type: '/alienInline' },
- /* 3 */ ve.copy(
ve.dm.mwExample.MWInlineImage.data ),
- /* 4 */ { type: '/mwInlineImage' },
- /* 5 */ { type: 'alienInline' },
- /* 6 */ { type: '/alienInline' },
- /* 7 */ { type: '/paragraph' }
+ // 0
+ { type: 'paragraph' },
+ // 1
+ { type: 'alienInline' },
+ // 2
+ { type: '/alienInline' },
+ // 3
+ ve.copy(
ve.dm.mwExample.MWInlineImage.data ),
+ // 4
+ { type: '/mwInlineImage' },
+ // 5
+ { type: 'alienInline' },
+ // 6
+ { type: '/alienInline' },
+ // 7
+ { type: '/paragraph' }
],
cases: [
{
--
To view, visit https://gerrit.wikimedia.org/r/195013
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Icd303626ac745c7ab5bff164f9b8cac276de1523
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Krinkle <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
