Re-enable cpplint & eslint on Actions for Linux platform

Fix: RobotWebTools#1056
minggangw · Mar 4, 2025 · 395ed22 · 395ed22
1 parent 120fcd0
commit 395ed22
Show file tree

Hide file tree

Showing 55 changed files with 102 additions and 183 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
diff --git a/.github/workflows/linux-build-and-test.yml b/.github/workflows/linux-build-and-test.yml
@@ -50,4 +50,5 @@ jobs:
       run: |
         source /opt/ros/${{ needs.identify-ros-distro.outputs.distro }}/setup.bash
         npm i
+        npm run lint
         npm test
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,55 @@
+import prettier from "eslint-plugin-prettier";
+import globals from "globals";
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [{
+    ignores: ["generated/", "eslint.config.mjs", "lib/", "types/", "scripts/", "benchmark/", "docs/", "electron_demo/"],
+}, ...compat.extends("prettier"), {
+    plugins: {
+        prettier,
+    },
+
+    languageOptions: {
+        globals: {
+            ...globals.node,
+            every: true,
+            after: true,
+            constantly: true,
+        },
+
+        ecmaVersion: "latest",
+        sourceType: "commonjs",
+    },
+
+    rules: {
+        "prettier/prettier": "error",
+    },
+}, {
+    files: ["types/*.d.ts"],
+
+    plugins: {
+        "@typescript-eslint": typescriptEslint,
+    },
+
+    languageOptions: {
+        parser: tsParser,
+        sourceType: "module",
+    },
+
+    rules: {
+        strict: [0, "global"],
+    },
+}];
diff --git a/example/publisher-content-filter-example.js b/example/publisher-content-filter-example.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const rclnodejs = require('../index.js');
 
 async function main() {

diff --git a/example/publisher-message-example.js b/example/publisher-message-example.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const rclnodejs = require('../index.js');
 
 rclnodejs

diff --git a/example/publisher-multiarray-example.js b/example/publisher-multiarray-example.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const rclnodejs = require('../index.js');
 
 rclnodejs

diff --git a/example/publisher-raw-message.js b/example/publisher-raw-message.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const rclnodejs = require('../index.js');
 
 rclnodejs

diff --git a/example/subscription-multiarray-example.js b/example/subscription-multiarray-example.js
@@ -36,7 +36,7 @@ rclnodejs
         const weightStride = dim[1].stride;
         const channel = dim[2].size;
         const channelStride = dim[2].stride;
-        // eslint-disable-next-line
+
         const offset = multiArray.layout.data_offset;
 
         for (let i = 0; i < height; i++) {

diff --git a/example/subscription-raw-message.js b/example/subscription-raw-message.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const rclnodejs = require('../index.js');
 
 rclnodejs.init().then(() => {

diff --git a/lib/action/client.js b/lib/action/client.js
@@ -172,7 +172,7 @@ class ActionClient extends Entity {
           goalHandle.status = status;
 
           // Remove done handles from the list
-          // eslint-disable-next-line max-depth
+
           if (
             status === ActionInterfaces.GoalStatus.STATUS_SUCCEEDED ||
             status === ActionInterfaces.GoalStatus.STATUS_CANCELED ||

diff --git a/lib/clock_type.js b/lib/clock_type.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 /**
  * Enum for ClockType
  * @readonly

diff --git a/lib/interface_loader.js b/lib/interface_loader.js
@@ -59,7 +59,6 @@ let interfaceLoader = {
     // Suppose the name is a package, and traverse the path to collect the IDL files.
     let packagePath = path.join(generator.generatedRoot, name);
 
-    // eslint-disable-next-line
     let interfaces = fs.readdirSync(packagePath);
     if (interfaces.length > 0) {
       return this.loadInterfaceByPath(packagePath, interfaces);
@@ -108,7 +107,7 @@ let interfaceLoader = {
         packageName,
         packageName + '__' + type + '__' + messageName + '.js'
       );
-      // eslint-disable-next-line
+
       if (fs.existsSync(filePath)) {
         return require(filePath);
       }

diff --git a/lib/lifecycle.js b/lib/lifecycle.js
@@ -603,7 +603,6 @@ class LifecycleNode extends Node {
   _onGetState(request, response) {
     let result = response.template;
 
-    // eslint-disable-next-line camelcase
     result.current_state = this.currentState;
 
     response.send(result);
@@ -619,7 +618,6 @@ class LifecycleNode extends Node {
   _onGetAvailableStates(request, response) {
     let result = response.template;
 
-    // eslint-disable-next-line camelcase
     result.available_states = this.availableStates;
 
     response.send(result);
@@ -634,7 +632,6 @@ class LifecycleNode extends Node {
   _onGetAvailableTransitions(request, response) {
     let result = response.template;
 
-    // eslint-disable-next-line camelcase
     result.available_transitions = this.availableTransitions;
 
     response.send(result);

diff --git a/lib/parameter.js b/lib/parameter.js
@@ -19,8 +19,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
-
 const IsClose = require('is-close');
 
 /**

diff --git a/lib/parameter_service.js b/lib/parameter_service.js
@@ -1,4 +1,3 @@
-/* eslint-disable max-depth */
 // Copyright (c) 2020 Wayne Parrott. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

diff --git a/lib/qos.js b/lib/qos.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable */
-
 /**
  * Enum for HistoryPolicy
  * @readonly

diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
     "postinstall": "npm run generate-messages",
     "docs": "cd docs && make",
     "test": "node --expose-gc ./scripts/run_test.js && npx tsd",
-    "lint": "eslint --max-warnings=0 --ext js,ts index.js types scripts lib example rosidl_gen rosidl_parser test benchmark/rclnodejs && node ./scripts/cpplint.js",
+    "lint": "eslint && node ./scripts/cpplint.js",
     "format": "clang-format -i -style=file ./src/*.cpp ./src/*.hpp && prettier --write \"{lib,rosidl_gen,rostsd_gen,rosidl_parser,types,example,test,scripts,benchmark}/**/*.{js,md,ts}\" ./*.{js,md,ts}",
     "prepare": "husky"
   },
@@ -44,6 +44,8 @@
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.25.9",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.21.0",
     "@types/node": "^22.13.5",
     "@typescript-eslint/eslint-plugin": "^8.18.0",
     "@typescript-eslint/parser": "^8.18.0",
@@ -54,6 +56,7 @@
     "eslint": "^9.16.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^16.0.0",
     "husky": "^9.1.7",
     "jsdoc": "^4.0.4",
     "lint-staged": "^15.2.10",

diff --git a/rosidl_gen/action_msgs.js b/rosidl_gen/action_msgs.js
@@ -12,7 +12,6 @@
 
 'use strict';
 
-/* eslint-disable camelcase */
 const GOAL_ID_FIELD = {
   name: 'goal_id',
   type: {

diff --git a/rosidl_gen/filter.js b/rosidl_gen/filter.js
@@ -87,7 +87,6 @@ const RosPackageFilters = {
 
     if (!fs.existsSync(blocklistPath)) return;
 
-    // eslint-disable-next-line
     let blocklistData = JSON.parse(fs.readFileSync(blocklistPath, 'utf8'));
 
     let filters = blocklistData.map((pkgFilterData) => {

diff --git a/rosidl_gen/index.js b/rosidl_gen/index.js
@@ -64,7 +64,6 @@ async function generateAll(forcedGenerating) {
 
 const generator = {
   version() {
-    // eslint-disable-next-line
     return fse.readJsonSync(path.join(__dirname, 'generator.json')).version;
   },
 

diff --git a/rosidl_gen/message_translator.js b/rosidl_gen/message_translator.js
@@ -14,8 +14,6 @@
 
 'use strict';
 
-/* eslint-disable max-depth */
-
 function isTypedArray(value) {
   return ArrayBuffer.isView(value) && !(value instanceof DataView);
 }
@@ -133,7 +131,6 @@ function toPlainObject(message, enableTypedArray = true) {
       array.push(toPlainObject(e, enableTypedArray)); // Translate every elements
     });
     return array;
-    // eslint-disable-next-line no-else-return
   } else {
     // It's a ROS message
     const def = message.constructor.ROSMessageDef;

diff --git a/rosidl_gen/primitive_types.js b/rosidl_gen/primitive_types.js
@@ -18,8 +18,6 @@ const ref = require('@rclnodejs/ref-napi');
 const StructType = require('@rclnodejs/ref-struct-di')(ref);
 const rclnodejs = require('bindings')('rclnodejs');
 
-/* eslint-disable camelcase */
-
 const StringRefStruct = StructType({
   data: ref.types.CString,
   size: ref.types.size_t,
@@ -65,5 +63,3 @@ module.exports = {
   wstring: StringRefStruct,
   initString: initString,
 };
-
-/* eslint-enable camelcase */
diff --git a/rostsd_gen/index.js b/rostsd_gen/index.js
@@ -23,10 +23,6 @@ declare module "rclnodejs" {
 }
 */
 
-/* eslint-disable max-depth */
-/* eslint-disable no-sync */
-/* eslint-disable camelcase */
-
 'use strict';
 
 const path = require('path');

diff --git a/scripts/cpplint.js b/scripts/cpplint.js
@@ -18,18 +18,17 @@ const exec = require('child_process').exec;
 
 const cmd = 'wget -nc ';
 const cpplintUrl =
-  'https://raw.githubusercontent.com/google/styleguide' +
-  '/gh-pages/cpplint/cpplint.py';
+  'https://raw.githubusercontent.com/cpplint/cpplint/refs/heads/develop/cpplint.py';
 const root = `${__dirname}/../src`;
-const args = `--extensions=cpp,h,hpp,cc ${root}/*`;
+const args = `--filter=-build/include_subdir,-whitespace/indent_namespace --extensions=cpp,h,hpp,cc ${root}/*`;
 
 console.log('Downloading the cpplint...');
 exec(cmd + cpplintUrl, (err, stdout, stderr) => {
   if (err) {
     console.log(`Downloading failed: ${stderr}`);
   } else {
     console.log('Running the cpplint...');
-    exec('python cpplint.py ' + args, (err, stdout, stderr) => {
+    exec('python3 cpplint.py ' + args, (err, stdout, stderr) => {
       console.log(stdout);
       if (err) {
         console.log(stderr);

diff --git a/src/executor.hpp b/src/executor.hpp
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_EXECUTOR_HPP_
-#define RCLNODEJS_EXECUTOR_HPP_
+#ifndef SRC_EXECUTOR_HPP_
+#define SRC_EXECUTOR_HPP_
 
 #include <rcl/wait.h>
 #include <uv.h>
@@ -74,4 +74,4 @@ class Executor {
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_EXECUTOR_HPP_
diff --git a/src/handle_manager.hpp b/src/handle_manager.hpp
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_HANDLE_MANAGER_HPP_
-#define RCLNODEJS_HANDLE_MANAGER_HPP_
+#ifndef SRC_HANDLE_MANAGER_HPP_
+#define SRC_HANDLE_MANAGER_HPP_
 
 #include <nan.h>
 #include <rcl/wait.h>
@@ -132,4 +132,4 @@ class HandleManager {
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_HANDLE_MANAGER_HPP_
diff --git a/src/macros.hpp b/src/macros.hpp
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_MARCOS_HPP_
-#define RCLNODEJS_MARCOS_HPP_
+#ifndef SRC_MACROS_HPP_
+#define SRC_MACROS_HPP_
 
 #include "rcutils/logging_macros.h"
 
@@ -43,4 +43,4 @@
 #define RCLNODEJS_DEBUG(...)
 #endif
 
-#endif
+#endif  // SRC_MACROS_HPP_
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,8 +19,6 @@ @@
     'use strict';
-    /* eslint-disable camelcase */
     const IsClose = require('is-close');
     /**
@@ Expand Down @@