Fix linting errors and add @module jsdoc directives

jcbrand · jcbrand · commit d95a7987cef0 · 2019-07-11T10:48:52.000+02:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -244,6 +244,7 @@
             "error",
             "always"
         ],
+        "require-atomic-updates": "off",
         "require-await": "error",
         "require-jsdoc": "off",
         "rest-spread-spacing": "error",
diff --git a/src/converse-autocomplete.js b/src/converse-autocomplete.js
@@ -4,10 +4,12 @@
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
 
-// This plugin started as a fork of Lea Verou's Awesomplete
-// https://leaverou.github.io/awesomplete/
-
-
+/**
+ * @module converse-autocomplete
+ * @description
+ * Converse.js plugin which started as a fork of Lea Verou's Awesomplete
+ * https://leaverou.github.io/awesomplete/
+ */
 import converse from "@converse/headless/converse-core";
 
 const { _, Backbone } = converse.env,
diff --git a/src/converse-bookmark-views.js b/src/converse-bookmark-views.js
@@ -4,12 +4,11 @@
 // Copyright (c) 2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
-/* This is a Converse.js plugin which add support for bookmarks specified
- * in XEP-0048.
+/**
+ * @module converse-bookmark-views
+ * @description
+ * Converse.js plugin which adds views for XEP-0048 bookmarks
  */
-
 import "backbone.nativeview";
 import BrowserStorage from "backbone.browserStorage";
 import { OrderedListView } from "backbone.overview";
diff --git a/src/converse-chatboxviews.js b/src/converse-chatboxviews.js
@@ -4,6 +4,9 @@
 // Copyright (c) 2012-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
 
+/**
+ * @module converse-chatboxviews
+ */
 import "@converse/headless/converse-chatboxes";
 import "backbone.nativeview";
 import { Overview } from "backbone.overview";
diff --git a/src/converse-chatview.js b/src/converse-chatview.js
@@ -4,6 +4,9 @@
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
 
+/**
+ * @module converse-chatview
+ */
 import "backbone.nativeview";
 import "converse-chatboxviews";
 import "converse-message-view";
diff --git a/src/converse-controlbox.js b/src/converse-controlbox.js
@@ -4,8 +4,9 @@
 // Copyright (c) 2012-2017, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
+/**
+ * @module converse-controlbox
+ */
 import "converse-chatview";
 import "converse-profile";
 import "converse-rosterview";
diff --git a/src/converse-dragresize.js b/src/converse-dragresize.js
@@ -4,8 +4,9 @@
 // Copyright (c) 2012-2017, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define, window, document */
-
+/**
+ * @module converse-dragresize
+ */
 import "converse-chatview";
 import "converse-controlbox";
 import converse from "@converse/headless/converse-core";
diff --git a/src/converse-fullscreen.js b/src/converse-fullscreen.js
@@ -4,7 +4,9 @@
 // Copyright (c) JC Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-
+/**
+ * @module converse-fullscreen
+ */
 import "@converse/headless/converse-muc";
 import "converse-chatview";
 import "converse-controlbox";
diff --git a/src/converse-headline.js b/src/converse-headline.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-headline
+ */
 import "converse-chatview";
 import converse from "@converse/headless/converse-core";
 import tpl_chatbox from "templates/chatbox.html";
diff --git a/src/converse-mam-views.js b/src/converse-mam-views.js
@@ -4,8 +4,11 @@
 // Copyright (c) 2012-2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-// Views for XEP-0313 Message Archive Management
-
+/**
+ * @module converse-mam-views
+ * @description
+ * Views for XEP-0313 Message Archive Management
+ */
 import converse from "@converse/headless/converse-core";
 import { debounce } from 'lodash'
 
diff --git a/src/converse-message-view.js b/src/converse-message-view.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-message-view
+ */
 import URI from "urijs";
 import converse from  "@converse/headless/converse-core";
 import filesize from "filesize";
diff --git a/src/converse-minimize.js b/src/converse-minimize.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-minimize
+ */
 import "converse-chatview";
 import BrowserStorage from "backbone.browserStorage";
 import { Overview } from "backbone.overview";
diff --git a/src/converse-modal.js b/src/converse-modal.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-modal
+ */
 import "backbone.vdomview";
 import bootstrap from "bootstrap.native";
 import converse from "@converse/headless/converse-core";
diff --git a/src/converse-muc-views.js b/src/converse-muc-views.js
@@ -4,8 +4,11 @@
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
 //
-// XEP-0045 Multi-User Chat Views
-
+/**
+ * @module converse-muc-views
+ * @description
+ * XEP-0045 Multi-User Chat Views
+ */
 import "converse-modal";
 import "backbone.vdomview";
 import BrowserStorage from "backbone.browserStorage";
diff --git a/src/converse-notification.js b/src/converse-notification.js
@@ -4,8 +4,9 @@
 // Copyright (c) 2013-2019, JC Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
+/**
+ * @module converse-notification
+ */
 import converse from "@converse/headless/converse-core";
 
 const { Strophe, _, sizzle } = converse.env,
diff --git a/src/converse-omemo.js b/src/converse-omemo.js
@@ -4,8 +4,10 @@
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
 
-/* global libsignal, ArrayBuffer, parseInt, crypto */
-
+/* global libsignal, ArrayBuffer */
+/**
+ * @module converse-omemo
+ */
 import BrowserStorage from "backbone.browserStorage";
 import converse from "@converse/headless/converse-core";
 import tpl_toolbar_omemo from "templates/toolbar_omemo.html";
diff --git a/src/converse-profile.js b/src/converse-profile.js
@@ -4,8 +4,9 @@
 // Copyright (c) 2013-2017, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
+/**
+ * @module converse-profile
+ */
 import "@converse/headless/converse-vcard";
 import "converse-modal";
 import _FormData from "formdata-polyfill";
diff --git a/src/converse-push.js b/src/converse-push.js
@@ -3,12 +3,12 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* This is a Converse.js plugin which add support for registering
+/**
+ * @module converse-push
+ * @description
+ * Converse.js plugin which add support for registering
  * an "App Server" as defined in  XEP-0357
  */
-
-
 import converse from "@converse/headless/converse-core";
 
 const { Strophe, $iq, _ } = converse.env;
diff --git a/src/converse-register.js b/src/converse-register.js
@@ -4,12 +4,12 @@
 // Copyright (c) 2012-2017, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
-/* This is a Converse.js plugin which add support for in-band registration
+/**
+ * @module converse-register
+ * @description
+ * This is a Converse.js plugin which add support for in-band registration
  * as specified in XEP-0077.
  */
-
 import "converse-controlbox";
 import converse from "@converse/headless/converse-core";
 import tpl_form_input from "templates/form_input.html";
diff --git a/src/converse-roomslist.js b/src/converse-roomslist.js
@@ -3,8 +3,10 @@
 //
 // Copyright (c) 2013-2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* This is a non-core Converse.js plugin which shows a list of currently open
+/**
+ * @module converse-roomslist
+ * @description
+ * Converse.js plugin which shows a list of currently open
  * rooms in the "Rooms Panel" of the ControlBox.
  */
 import BrowserStorage from "backbone.browserStorage";
diff --git a/src/converse-rosterview.js b/src/converse-rosterview.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-rosterview
+ */
 import "@converse/headless/converse-chatboxes";
 import "@converse/headless/converse-roster";
 import "converse-modal";
diff --git a/src/converse-singleton.js b/src/converse-singleton.js
@@ -3,13 +3,11 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* converse-singleton
- * ******************
- *
+/**
+ * @module converse-singleton
+ * @description
  * A plugin which restricts Converse to only one chat.
  */
-
 import converse from "@converse/headless/converse-core";
 
 const { _, Strophe } = converse.env;
diff --git a/src/converse-uniview.js b/src/converse-uniview.js
@@ -3,18 +3,16 @@
 //
 // Copyright (c) 2013-2018, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* converse-uniview
- * ****************
- *
+/**
+ * @module converse-uniview
+ * @description
  * A plugin which ensures that only one chat (private or groupchat) is
  * visible at any one time. All other ongoing chats are hidden and kept in the
  * background.
  *
  * This plugin makes sense in mobile, embedded or fullscreen chat environments
  * (as configured by the `view_mode` setting).
  */
-
 import "converse-chatview";
 import converse from "@converse/headless/converse-core";
 
diff --git a/src/headless/converse-bookmarks.js b/src/headless/converse-bookmarks.js
@@ -4,12 +4,11 @@
 // Copyright (c) 2019, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global define */
-
-/* This is a Converse.js plugin which adds views for bookmarks specified
- * in XEP-0048.
+/**
+ * @module converse-bookmarks
+ * @description
+ * Converse.js plugin which adds views for bookmarks specified in XEP-0048.
  */
-
 import BrowserStorage from "backbone.browserStorage";
 import converse from "@converse/headless/converse-core";
 import muc from "@converse/headless/converse-muc";
diff --git a/src/headless/converse-bosh.js b/src/headless/converse-bosh.js
@@ -3,9 +3,11 @@
 //
 // Copyright (c) The Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* This is a Converse.js plugin which add support for XEP-0206: XMPP Over BOSH */
-
+/**
+ * @module converse-bosh
+ * @description
+ * Converse.js plugin which add support for XEP-0206: XMPP Over BOSH
+ */
 import BrowserStorage from "backbone.browserStorage";
 import converse from "./converse-core";
 
diff --git a/src/headless/converse-caps.js b/src/headless/converse-caps.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-caps
+ */
 import SHA1 from 'strophe.js/src/sha1';
 import converse from "@converse/headless/converse-core";
 
diff --git a/src/headless/converse-chatboxes.js b/src/headless/converse-chatboxes.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2012-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-chatboxes
+ */
 import "./utils/emoji";
 import "./utils/form";
 import BrowserStorage from "backbone.browserStorage";
diff --git a/src/headless/converse-core.js b/src/headless/converse-core.js
@@ -3,7 +3,9 @@
 //
 // Copyright (c) 2013-2019, the Converse.js developers
 // Licensed under the Mozilla Public License (MPLv2)
-
+/**
+ * @module converse-core
+ */
 import * as bosh from 'strophe.js/src/bosh';
 import * as strophe from 'strophe.js/src/core';
 import * as websocket from 'strophe.js/src/websocket';
diff --git a/src/headless/converse-disco.js b/src/headless/converse-disco.js
@@ -3,9 +3,11 @@
 //
 // Copyright (c) 2013-2019, the Converse developers
 // Licensed under the Mozilla Public License (MPLv2)
-
-/* This is a Converse plugin which add support for XEP-0030: Service Discovery */
-
+/**
+ * @module converse-disco
+ * @description
+ * Converse plugin which add support for XEP-0030: Service Discovery
+ */
 import BrowserStorage from "backbone.browserStorage";
 import converse from "./converse-core";
 import sizzle from "sizzle";
diff --git a/src/headless/converse-mam.js b/src/headless/converse-mam.js
diff --git a/src/headless/converse-muc.js b/src/headless/converse-muc.js
diff --git a/src/headless/converse-ping.js b/src/headless/converse-ping.js
diff --git a/src/headless/converse-pubsub.js b/src/headless/converse-pubsub.js
diff --git a/src/headless/converse-roster.js b/src/headless/converse-roster.js
diff --git a/src/headless/converse-rsm.js b/src/headless/converse-rsm.js
diff --git a/src/headless/converse-smacks.js b/src/headless/converse-smacks.js
diff --git a/src/headless/converse-vcard.js b/src/headless/converse-vcard.js
diff --git a/src/headless/i18n.js b/src/headless/i18n.js
diff --git a/src/headless/lodash.noconflict.js b/src/headless/lodash.noconflict.js
diff --git a/src/headless/utils/core.js b/src/headless/utils/core.js
diff --git a/src/headless/utils/muc.js b/src/headless/utils/muc.js
diff --git a/src/jquery-stub.js b/src/jquery-stub.js
diff --git a/src/underscore-shim.js b/src/underscore-shim.js
