feat(linter): Added 'cc' to lint the C++ code on 'npm lint' (#1501)

package.json

@@ -67,6 +67,7 @@
   },
   "devDependencies": {
     "bluebird": "^3.5.0",
+    "cc": "^1.0.1",
     "chai": "^4.0.2",
     "chai-subset": "^1.5.0",
     "conventional-changelog-cli": "^1.3.2",
@@ -97,7 +98,7 @@
     "arduino-test": "TEST_PORT=$(./bin/find-arduino.js) npm test",
     "changelog": "conventional-changelog -i CHANGELOG.md -s",
     "docs": "jsdoc -c ./.jsdoc.json ",
-    "lint": "eslint lib test bin examples",
+    "lint": "eslint lib test bin examples && cc",
     "rebuild-all": "npm rebuild && node-gyp rebuild",
     "repl": "node bin/repl.js",
     "terminal": "node bin/terminal.js",
@@ -111,5 +112,16 @@
     "prebuild": "prebuild --all --strip --verbose",
     "prebuild-upload": "prebuild --all --strip --verbose"
   },
-  "gypfile": true
+  "gypfile": true,
+  "cc": {
+    "filter": [
+      "legal/copyright",
+      "build/include"
+    ],
+    "files": [
+        "src/*.cpp",
+        "src/*.h"
+    ],
+    "linelength": "120"
+  }
 }

src/darwin_list.cpp

@@ -10,6 +10,9 @@
 #include <IOKit/serial/ioss.h>
 #endif
 
+#include <string>
+#include <list>
+
 uv_mutex_t list_mutex;
 Boolean lockInitialised = FALSE;
 
@@ -21,7 +24,7 @@ NAN_METHOD(List) {
   }
 
   ListBaton* baton = new ListBaton();
-  strcpy(baton->errorString, "");
+  snprintf(baton->errorString, sizeof(baton->errorString), "");
   baton->callback.Reset(info[0].As<v8::Function>());
 
   uv_work_t* req = new uv_work_t();
@@ -99,19 +102,19 @@ static void ExtractUsbInformation(stSerialDevice *serialDevice, IOUSBDeviceInter
   UInt32 locationID;
   kernResult = (*deviceInterface)->GetLocationID(deviceInterface, &locationID);
   if (KERN_SUCCESS == kernResult) {
-    snprintf(serialDevice->locationId, 11, "%08x", locationID);
+    snprintf(serialDevice->locationId, sizeof(serialDevice->locationId), "%08x", locationID);
   }
 
   UInt16 vendorID;
   kernResult = (*deviceInterface)->GetDeviceVendor(deviceInterface, &vendorID);
   if (KERN_SUCCESS == kernResult) {
-    snprintf(serialDevice->vendorId, 7, "%04x", vendorID);
+    snprintf(serialDevice->vendorId, sizeof(serialDevice->vendorId), "%04x", vendorID);
   }
 
   UInt16 productID;
   kernResult = (*deviceInterface)->GetDeviceProduct(deviceInterface, &productID);
   if (KERN_SUCCESS == kernResult) {
-    snprintf(serialDevice->productId, 7, "%04x", productID);
+    snprintf(serialDevice->productId, sizeof(serialDevice->productId), "%04x", productID);
   }
 }
 
@@ -152,9 +155,9 @@ static stDeviceListItem* GetSerialDevices() {
       CFRelease(bsdPathAsCFString);
 
       if (result) {
-        stDeviceListItem *deviceListItem = (stDeviceListItem*) malloc(sizeof(stDeviceListItem));
+        stDeviceListItem *deviceListItem = reinterpret_cast<stDeviceListItem*>( malloc(sizeof(stDeviceListItem)));
         stSerialDevice *serialDevice = &(deviceListItem->value);
-        strcpy(serialDevice->port, bsdPath);
+        snprintf(serialDevice->port, sizeof(serialDevice->port), bsdPath);
         memset(serialDevice->locationId, 0, sizeof(serialDevice->locationId));
         memset(serialDevice->vendorId, 0, sizeof(serialDevice->vendorId));
         memset(serialDevice->productId, 0, sizeof(serialDevice->productId));
@@ -196,7 +199,7 @@ static stDeviceListItem* GetSerialDevices() {
                           kCFStringEncodingUTF8);
 
             if (result) {
-              strcpy(serialDevice->manufacturer, manufacturer);
+              snprintf(serialDevice->manufacturer, sizeof(serialDevice->manufacturer), manufacturer);
             }
 
             CFRelease(manufacturerAsCFString);
@@ -219,7 +222,7 @@ static stDeviceListItem* GetSerialDevices() {
                           kCFStringEncodingUTF8);
 
             if (result) {
-              strcpy(serialDevice->serialNumber, serialNumber);
+              snprintf(serialDevice->serialNumber, sizeof(serialDevice->serialNumber), serialNumber);
             }
 
             CFRelease(serialNumberAsCFString);
@@ -240,7 +243,7 @@ static stDeviceListItem* GetSerialDevices() {
 
           // Use the plugin interface to retrieve the device interface.
           res = (*plugInInterface)->QueryInterface(plugInInterface, CFUUIDGetUUIDBytes(kIOUSBDeviceInterfaceID),
-                               (LPVOID*) &deviceInterface);
+                               reinterpret_cast<LPVOID*> (&deviceInterface));
 
           // Now done with the plugin interface.
           (*plugInInterface)->Release(plugInInterface);

src/darwin_list.h

@@ -1,8 +1,9 @@
-#ifndef SRC_SERIALPORT_DARWIN_LIST_H_
-#define SRC_SERIALPORT_DARWIN_LIST_H_
+#ifndef SRC_DARWIN_LIST_H_
+#define SRC_DARWIN_LIST_H_
+#include <sys/param.h>  // For MAXPATHLEN
 #include <nan.h>
 #include <list>
-#include <sys/param.h> // For MAXPATHLEN
+#include <string>
 
 #define ERROR_STRING_SIZE 1024
 
@@ -41,4 +42,4 @@ typedef struct DeviceListItem {
     int* length;
 } stDeviceListItem;
 
-#endif  // SRC_SERIALPORT_DARWIN_LIST_H_
+#endif  // SRC_DARWIN_LIST_H_

src/poller.cpp

@@ -19,7 +19,7 @@ Poller::~Poller() {
   // if we call uv_poll_stop after uv_poll_init failed we segfault
   if (uv_poll_init_success) {
     uv_poll_stop(poll_handle);
-    uv_close((uv_handle_t*) poll_handle, Poller::onClose);
+    uv_close(reinterpret_cast<uv_handle_t*> (poll_handle), Poller::onClose);
   } else {
     delete poll_handle;
   }

src/serialport.cpp

@@ -54,7 +54,7 @@ NAN_METHOD(Open) {
   }
 
   OpenBaton* baton = new OpenBaton();
-  strcpy(baton->path, *path);
+  snprintf(baton->path, sizeof(baton->path), *path);
   baton->baudRate = getIntFromObject(options, "baudRate");
   baton->dataBits = getIntFromObject(options, "dataBits");
   baton->parity = ToParityEnum(getStringFromObj(options, "parity"));

src/serialport_linux.cpp

@@ -8,15 +8,15 @@
 int linuxSetCustomBaudRate(const int fd, const unsigned int baudrate) {
     struct termios2 t;
 
-    if(ioctl(fd, TCGETS2, &t)) {
+    if (ioctl(fd, TCGETS2, &t)) {
       return -1;
     }
 
     t.c_cflag &= ~CBAUD;
     t.c_cflag |= BOTHER;
     t.c_ospeed = t.c_ispeed = baudrate;
 
-    if(ioctl(fd, TCSETS2, &t)) {
+    if (ioctl(fd, TCSETS2, &t)) {
       return -2;
     }
 
@@ -27,11 +27,11 @@ int linuxSetCustomBaudRate(const int fd, const unsigned int baudrate) {
 int linuxGetSystemBaudRate(const int fd, int* const outbaud) {
   struct termios2 t;
 
-  if(ioctl(fd, TCGETS2, &t)) {
+  if (ioctl(fd, TCGETS2, &t)) {
     return -1;
   }
 
-  *outbaud = (int)t.c_ospeed;
+  *outbaud = static_cast<int>(t.c_ospeed);
 
   return 0;
 }

src/serialport_linux.h

@@ -1,8 +1,8 @@
-#ifndef CUSTOM_BAUDRATE_H
-#define CUSTOM_BAUDRATE_H
+#ifndef SRC_SERIALPORT_LINUX_H_
+#define SRC_SERIALPORT_LINUX_H_
 
 int linuxSetCustomBaudRate(const int fd, const unsigned int baudrate);
 int linuxGetSystemBaudRate(const int fd, int* const outbaud);
 
-#endif
+#endif  // SRC_SERIALPORT_LINUX_H_
 

src/serialport_unix.cpp

@@ -1,5 +1,5 @@
-#include "./serialport_unix.h"
-#include "./serialport.h"
+#include "serialport_unix.h"
+#include "serialport.h"
 
 #include <sys/file.h>
 #include <unistd.h>
@@ -15,13 +15,11 @@
 #if defined(MAC_OS_X_VERSION_10_4) && (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_4)
 #include <sys/ioctl.h>
 #include <IOKit/serial/ioss.h>
-#endif
 
-#if defined(__OpenBSD__)
+#elif defined(__OpenBSD__)
 #include <sys/ioctl.h>
-#endif
 
-#if defined(__linux__)
+#elif defined(__linux__)
 #include <sys/ioctl.h>
 #include <linux/serial.h>
 #include "serialport_linux.h"
@@ -105,7 +103,8 @@ int setBaudRate(ConnectionOptionsBaton *data) {
   // get port options
   struct termios options;
   if (-1 == tcgetattr(fd, &options)) {
-    snprintf(data->errorString, sizeof(data->errorString), "Error: %s setting custom baud rate of %d", strerror(errno), data->baudRate);
+    snprintf(data->errorString, sizeof(data->errorString),
+             "Error: %s setting custom baud rate of %d", strerror(errno), data->baudRate);
     return -1;
   }
 
@@ -115,10 +114,12 @@ int setBaudRate(ConnectionOptionsBaton *data) {
       int err = linuxSetCustomBaudRate(fd, data->baudRate);
 
       if (err == -1) {
-        snprintf(data->errorString, sizeof(data->errorString), "Error: %s || while retrieving termios2 info", strerror(errno));
+        snprintf(data->errorString, sizeof(data->errorString),
+                 "Error: %s || while retrieving termios2 info", strerror(errno));
         return -1;
-      } else if(err == -2) {
-        snprintf(data->errorString, sizeof(data->errorString), "Error: %s || while setting custom baud rate of %d", strerror(errno), data->baudRate);
+      } else if (err == -2) {
+        snprintf(data->errorString, sizeof(data->errorString),
+                 "Error: %s || while setting custom baud rate of %d", strerror(errno), data->baudRate);
         return -1;
       }
 
@@ -131,7 +132,8 @@ int setBaudRate(ConnectionOptionsBaton *data) {
     if (-1 == baudRate) {
       speed_t speed = data->baudRate;
       if (-1 == ioctl(fd, IOSSIOSPEED, &speed)) {
-        snprintf(data->errorString, sizeof(data->errorString), "Error: %s calling ioctl(.., IOSSIOSPEED, %ld )", strerror(errno), speed );
+        snprintf(data->errorString, sizeof(data->errorString),
+                 "Error: %s calling ioctl(.., IOSSIOSPEED, %ld )", strerror(errno), speed);
         return -1;
       } else {
         tcflush(fd, TCIOFLUSH);
@@ -141,7 +143,8 @@ int setBaudRate(ConnectionOptionsBaton *data) {
   #endif
 
   if (-1 == baudRate) {
-    snprintf(data->errorString, sizeof(data->errorString), "Error baud rate of %d is not supported on your platform", data->baudRate);
+    snprintf(data->errorString, sizeof(data->errorString),
+             "Error baud rate of %d is not supported on your platform", data->baudRate);
     return -1;
   }
 
@@ -163,7 +166,8 @@ void EIO_Update(uv_work_t* req) {
 int setup(int fd, OpenBaton *data) {
   int dataBits = ToDataBitsConstant(data->dataBits);
   if (-1 == dataBits) {
-    snprintf(data->errorString, sizeof(data->errorString), "Invalid data bits setting %d", data->dataBits);
+    snprintf(data->errorString, sizeof(data->errorString),
+             "Invalid data bits setting %d", data->dataBits);
     return -1;
   }
 
@@ -299,7 +303,8 @@ void EIO_Close(uv_work_t* req) {
   VoidBaton* data = static_cast<VoidBaton*>(req->data);
 
   if (-1 == close(data->fd)) {
-    snprintf(data->errorString, sizeof(data->errorString), "Error: %s, unable to close fd %d", strerror(errno), data->fd);
+    snprintf(data->errorString, sizeof(data->errorString),
+             "Error: %s, unable to close fd %d", strerror(errno), data->fd);
   }
 }
 
@@ -370,7 +375,7 @@ void EIO_GetBaudRate(uv_work_t* req) {
   }
   #endif
 
-  // TODO implement on mac
+  // TODO(Fumon) implement on mac
   #if defined(MAC_OS_X_VERSION_10_4) && (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_4)
   snprintf(data->errorString, sizeof(data->errorString), "Error: System baud rate check not implemented on darwin");
   return;