Merge pull request #288 from IBM/eslint-mocha

test: Configure eslint properly for Mocha tests

Author: kadler

.eslintrc.js

@@ -1,13 +1,37 @@
-module.exports =  { 
-    "extends": "airbnb-base",
-    env: {
-        node: true
-    },
-    rules: {
-        // Tweak rules set by airbnb config
-        'no-console': 'off', // allow console
-        'import/no-extraneous-dependencies': ["error", {"optionalDependencies": true}], // Allow optional dep import
-        // Warn unresolved imports ie: idb-connector import will be unresolved when on non IBM i system.
-        'import/no-unresolved': ['off', { commonjs: true }],
+module.exports = {
+  extends: 'airbnb-base',
+  plugins: [
+    'mocha',
+  ],
+  env: {
+    node: true,
+  },
+  rules: {
+    // Tweak rules set by airbnb config
+    // We need to allow use of console.log for verbose mode
+    'no-console': 'off',
+  },
+  overrides: [
+    {
+      files: ['test/**/*.js'],
+      env: {
+        node: true,
+        mocha: true,
+      },
+      extends: 'plugin:mocha/recommended',
+      rules: {
+        // These are set by airbnb-base, but go against Mocha conventions
+        // See https://mochajs.org/#arrow-functions
+        // and https://github.com/airbnb/javascript/issues/433
+        'func-names': 'off',
+        'prefer-arrow-callback': 'off',
+
+        // The following rules cause problems for our existing tests, so they are disabled for now:
+        'mocha/no-mocha-arrows': 'off',
+        'mocha/no-skipped-tests': 'off',
+        'mocha/no-hooks-for-single-case': 'off',
+        'mocha/no-identical-title': 'off',
       },
+    },
+  ],
 };

lib/transports/idbTransport.js

@@ -18,7 +18,10 @@
 const idbCall = (config, xmlInput, cb) => {
   const {
     dbconn, dbstmt, IN, CLOB, CHAR, SQL_ATTR_DBC_SYS_NAMING, SQL_FALSE,
-  // eslint-disable-next-line global-require
+    // idb-connector is an optional dependency, since users may not use this transport
+    // thus we can't globally require it
+    // eslint-disable-next-line max-len
+    // eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
   } = require('idb-connector');
 
   const {

lib/transports/odbcTransport.js

@@ -16,7 +16,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 function odbcCall(config, xmlInput, done) {
-  // eslint-disable-next-line global-require
+  // odbc is an optional dependency, since users may not use this transport
+  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
   const odbc = require('odbc');
 
   const {

lib/transports/sshTransport.js

@@ -16,7 +16,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 function sshCall(config, xmlIn, done) {
-  // eslint-disable-next-line global-require
+  // ssh2 is an optional dependency, since users may not use this transport
+  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
   const { Client } = require('ssh2');
 
   const {

package-lock.json

@@ -48,6 +48,7 @@
     "eslint": "^6.2.0",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-mocha": "^7.0.1",
     "mocha": "^6.2.3",
     "sinon": "^7.4.1",
     "standard-version": "^7.0.0"

package.json

@@ -15,8 +15,6 @@
 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-/* eslint-env mocha */
-
 const { expect } = require('chai');
 const { parseString } = require('xml2js');
 const { CommandCall, Connection } = require('../../lib/itoolkit');

test/functional/CommandCallFunctional.js

@@ -15,7 +15,6 @@
 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-/* eslint-env mocha */
 
 const { expect } = require('chai');
 const { parseString } = require('xml2js');

test/functional/ProgramCallFunctional.js

@@ -3,7 +3,9 @@ const createLib = `CRTLIB LIB(${lib}) TYPE(*TEST) TEXT('Used to test Node.js too
 const findLib = `SELECT SCHEMA_NAME FROM qsys2.sysschemas WHERE SCHEMA_NAME = '${lib}'`;
 
 function checkObjectExistsSSH(config, object = {}, callback) {
-  /* eslint-disable global-require */
+  // ssh2 is an optional dependency, since users may not use this transport
+  // thus we can't globally require it
+  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
   const { Client } = require('ssh2');
 
   const client = new Client();
@@ -68,6 +70,9 @@ function checkObjectExistsSSH(config, object = {}, callback) {
 }
 
 function checkObjectExistsODBC(config, object = {}, callback) {
+  // odbc is an optional dependency, since users may not use this transport
+  // thus we can't globally require it
+  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
   const odbc = require('odbc');
 
   const connectionString = config.dsn || `DRIVER=IBM i Access ODBC Driver;SYSTEM=${config.host};UID=${config.username};PWD=${config.password};`;
@@ -110,6 +115,10 @@ function checkObjectExistsODBC(config, object = {}, callback) {
 }
 
 function checkObjectExistsIDB(config, object = {}, callback) {
+  // idb-connector is an optional dependency, since users may not use this transport
+  // thus we can't globally require it
+  // eslint-disable-next-line max-len
+  // eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
   const { dbconn, dbstmt } = require('idb-connector');
 
   /* eslint-disable new-cap */

test/functional/checkObjectExists.js

@@ -15,7 +15,6 @@
 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-/* eslint-env mocha */
 /* eslint-disable new-cap */