Add eslint in packing process (#936)

* Update README

* Add eslint in packing process

Author: DWJ01

README.md

@@ -34,7 +34,7 @@ The ${webrtc-javascript-sdk-sample-conference-dist} is built from owt-javascript
 If "--archive ${name}" option is appended to the pack command, a "Release-${name}.tgz" file will be generated in root folder. For other options, run the scripts with "--help" option.
 
 ## Quick Start
-In the repository root, run the following commands to start the media server on a single machine:
+In dist folder, run the following commands to start the media server on a single machine:
 1. `./bin/init-all.sh --deps`
 2. `./bin/start-all.sh`
 3. Open https://localhost:3004 to visit the web sample page. Due to the test certificate, you may need confirm this unsafe access.

scripts/pack.js

@@ -28,6 +28,7 @@ optParser.addOption('b', 'binary', 'boolean', 'Pack binary');
 optParser.addOption('np', 'no-pseudo', 'boolean', 'Whether use pseudo library');
 optParser.addOption('wf', 'with-ffmpeg', 'boolean', 'Whether pack ffmpeg library');
 optParser.addOption('h', 'help', 'boolean', 'Show help');
+optParser.addOption('li', 'lint', 'boolean', 'Whether lint code with eslint');
 
 const options = optParser.parseArgs(process.argv);
 
@@ -58,6 +59,25 @@ if (options.help || Object.keys(options).length === 0) {
   process.exit(0);
 }
 
+if (options.lint) {
+  // Check lint deps
+  const lintDeps = ['eslint'];
+  console.log('Checking lint dependencies...');
+  const npmRoot = execSync(`npm root -g`).toString().trim();
+  const missingLintDeps = lintDeps.filter((dep) => {
+    return !fs.existsSync(path.join(npmRoot, dep));
+  });
+
+  if (missingLintDeps.length === 0) {
+    console.log('Lint dependencies OK.');
+  } else {
+    for (const dep of missingLintDeps) {
+      console.log('Installing eslint');
+      execSync(`npm install eslint --global --save-dev`);
+    }
+  }
+}
+
 var npmInstallOption = '';
 if (process.getuid && process.getuid() === 0) {
   // Running as root
@@ -240,6 +260,14 @@ function packCommon(target) {
     // Copy common files
     for (const file of common.files) {
       const filePath = path.join(packSrc, file);
+      const extname = path.extname(filePath);
+      if (options.lint && extname === '.js') {
+        try {
+          execSync(`eslint -c ${rootDir}/source/.eslintrc.json ${filePath}`);
+        } catch(error) {
+          console.error(error.stdout.toString());
+        }
+      }
       execSync(`cp -a ${filePath} ${packDist}`);
     }
   }

source/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}