Merge pull request #372 from rsksmart/add-linter-and-prettier-support

Installed prettier and linter

Author: marcos-iov

.gitignore

@@ -18,3 +18,4 @@ tcpsigner.log
 logs/
 federate-node.jar
 zlogs/
+.eslintcache

.prettierignore

@@ -0,0 +1,23 @@
+# Dependency Directories
+node_modules/
+
+# Build Outputs
+dist/
+build/
+coverage/
+
+# Auto-generated artifacts
+package-lock.json
+pnpm-lock.yaml
+
+# OS / Editor junk
+.DS_Store
+.idea/
+.vscode/
+
+# File types to ignore
+*.json
+*.xml
+*.md
+*.yml
+*.yaml

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 4,
+  "useTabs": false,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "bracketSpacing": true
+}

cleanEnv.js

@@ -7,50 +7,50 @@ require('dotenv').config();
 const killServicesCommand = "kill $(ps -A | grep -e java -e bitcoind | awk '{print $1}')";
 
 async function clearLogFiles(directory) {
-  try {
-    const files = await fs.promises.readdir(directory, { withFileTypes: true });
-
-    for (const file of files) {
-      const filePath = path.join(directory, file.name);
-
-      if (file.isDirectory()) {
-        await clearLogFiles(filePath);
-      } else if (path.extname(file.name) === ".log") {
-        await fs.promises.truncate(filePath, 0);
-        console.log(`Cleared content of file: ${filePath}`);
-      }
+    try {
+        const files = await fs.promises.readdir(directory, { withFileTypes: true });
+
+        for (const file of files) {
+            const filePath = path.join(directory, file.name);
+
+            if (file.isDirectory()) {
+                await clearLogFiles(filePath);
+            } else if (path.extname(file.name) === '.log') {
+                await fs.promises.truncate(filePath, 0);
+                console.log(`Cleared content of file: ${filePath}`);
+            }
+        }
+    } catch (err) {
+        console.error(`Error processing directory ${directory}: ${err.message}`);
     }
-  } catch (err) {
-    console.error(`Error processing directory ${directory}: ${err.message}`);
-  }
 }
 
 function clearBitcoinDataDirectory() {
-  return new Promise((resolve, reject) => {
-    const directory = process.env.BITCOIN_DATA_DIR;
-
-    if (!directory) {
-      return reject(new Error("BITCOIN_DATA_DIR is not set."));
-    }
-
-    fs.readdir(directory, (err, files) => {
-      if (err) {
-        return reject(new Error(`Error reading directory ${directory}: ${err.message}`));
-      }
-
-      const deletePromises = files.map(file => {
-        const filePath = path.join(directory, file);
-        return fs.promises.rm(filePath, { recursive: true, force: true });
-      });
-
-      Promise.all(deletePromises)
-        .then(() => {
-          console.log(`Successfully cleared contents of: ${directory}`);
-          resolve();
-        })
-        .catch(reject);
+    return new Promise((resolve, reject) => {
+        const directory = process.env.BITCOIN_DATA_DIR;
+
+        if (!directory) {
+            return reject(new Error('BITCOIN_DATA_DIR is not set.'));
+        }
+
+        fs.readdir(directory, (err, files) => {
+            if (err) {
+                return reject(new Error(`Error reading directory ${directory}: ${err.message}`));
+            }
+
+            const deletePromises = files.map((file) => {
+                const filePath = path.join(directory, file);
+                return fs.promises.rm(filePath, { recursive: true, force: true });
+            });
+
+            Promise.all(deletePromises)
+                .then(() => {
+                    console.log(`Successfully cleared contents of: ${directory}`);
+                    resolve();
+                })
+                .catch(reject);
+        });
     });
-  });
 }
 const cleanEnvironment = async () => {
     console.info('Cleaning environment...');

config/regtest-all-keyfiles.js

@@ -0,0 +1,53 @@
+const js = require('@eslint/js');
+const globals = require('globals');
+
+const JS_FILES = ['**/*.js']; // only .js files (not .mjs/.cjs)
+
+module.exports = [
+    { ignores: ['node_modules/**', 'dist/**', 'coverage/**'] },
+
+    {
+        files: ['**/*.{js,cjs,mjs}'],
+        ...js.configs.recommended,
+    },
+
+    // Your environment + language options
+    {
+        files: JS_FILES,
+        languageOptions: {
+            ecmaVersion: 2021,
+            globals: {
+                ...globals.node,
+                ...globals.es2021,
+                ...globals.mocha,
+            },
+        },
+        rules: {
+            'no-console': 'warn',
+        },
+    },
+
+    {
+        files: ['**/*.cjs'],
+        languageOptions: {
+            ecmaVersion: 2021,
+            sourceType: 'commonjs',
+            globals: {
+                ...globals.node,
+                ...globals.es2021,
+            },
+        },
+    },
+
+    {
+        files: ['**/*.mjs'],
+        languageOptions: {
+            ecmaVersion: 2021,
+            sourceType: 'module',
+            globals: {
+                ...globals.node,
+                ...globals.es2021,
+            },
+        },
+    },
+];

config/regtest-key-files-and-hsms.js

@@ -3,21 +3,20 @@ const rsk = require('peglib').rsk;
 const rskUtilsLegacy = require('./rsk-utils-legacy');
 
 const sendTxToBridgeWithoutMining = (rskClient) => async (senderAddress, valueInWeis) => {
-
     return new Promise((resolve, reject) => {
         const sendResult = rskClient.eth.sendTransaction({
             from: senderAddress,
             to: rsk.getBridgeAddress(),
             value: valueInWeis,
-            gasPrice: 2
+            gasPrice: 2,
         });
 
         sendResult.catch((err) => reject(err));
         sendResult.once('transactionHash', (txHash) => {
             resolve(txHash);
         });
-    })
-}
+    });
+};
 
 const createPegoutRequest = async (rskClient, pegClient, amountInRBTC, requestSize = 1) => {
     const AMOUNT_IN_WEIS = rsk.btcToWeis(amountInRBTC);
@@ -34,11 +33,10 @@ const createPegoutRequest = async (rskClient, pegClient, amountInRBTC, requestSi
     for (let i = 0; i < requestSize; i++) {
         await sendTxToBridgeFunction(addresses.rsk, AMOUNT_IN_WEIS);
     }
-    await rskClient.evm.mine()
-}
+    await rskClient.evm.mine();
+};
 
 module.exports = {
-    with: (btcClient, rskClient) => ({
-    }),
+    with: (btcClient, rskClient) => ({}),
     createPegoutRequest,
 };