test: Constrain eslint rules

Instead of disabling import/no-extraneous-dependencies and
import/no-unresolved globally, constrain them to the specific instances
where they are needed using eslint comments.

In addition, explain why the no-console error must be disabled.

Author: kadler

.eslintrc.js

@@ -5,9 +5,7 @@ module.exports =  {
     },
     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 }],
+        // We need to allow use of console.log for verbose mode
+        'no-console': '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 {

test/functional/checkObjectExists.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 */