chore: add eslint support

.eslintignore

@@ -1,3 +1,3 @@
 **/*{.,-}min.js
 test
-
+dist

.eslintrc.yml

@@ -0,0 +1,20 @@
+env:
+  browser: true
+  commonjs: true
+  es2021: true
+extends:
+  - 'eslint:recommended'
+  - 'plugin:@typescript-eslint/recommended'
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: 12
+plugins:
+  - '@typescript-eslint'
+rules:
+  indent:
+    - error
+    - 4
+  quotes:
+    - error
+    - double
+

bin/crypto_create_CA.js

@@ -1,4 +1,5 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-var-requires */
 // ---------------------------------------------------------------------------------------------------------------------
 // node-opcua
 // ---------------------------------------------------------------------------------------------------------------------
@@ -25,6 +26,7 @@
 const updateNotifier = require("update-notifier");
 const pkg = require("../package.json");
 
+// eslint-disable-next-line no-undef
 require("../dist/crypto_create_CA.js").main(process.argv.splice(2), () => {
     /* empty */
     updateNotifier({pkg}).notify();

bin/install_prerequisite.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 "use strict";
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 var install_prerequisite = require("../dist/lib/misc/install_prerequisite").install_prerequisite;
 install_prerequisite(function(err){
     if (err) {

lib/crypto_create_CA.ts

@@ -62,7 +62,9 @@ import {
 
 // see https://github.com/yargs/yargs/issues/781
 import * as commands from "yargs";
-const { hideBin } = require('yargs/helpers')
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { hideBin } = require("yargs/helpers")
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const argv = require("yargs/yargs")(hideBin(process.argv))
 
 
@@ -353,60 +355,60 @@ interface OptionMap {
 
 function add_standard_option(options: OptionMap, optionName: string) {
     switch (optionName) {
-        case "root":
-            options.root = {
-                alias: "r",
-                type: "string",
-                default: "{CWD}/certificates",
-                describe: "the location of the Certificate folder",
-            };
-            break;
-
-        case "CAFolder":
-            options.CAFolder = {
-                alias: "c",
-                type: "string",
-                default: "{root}/CA",
-                describe: "the location of the Certificate Authority folder",
-            };
-            break;
-
-        case "PKIFolder":
-            options.PKIFolder = {
-                type: "string",
-                default: "{root}/PKI",
-                describe: "the location of the Public Key Infrastructure",
-            };
-            break;
+    case "root":
+        options.root = {
+            alias: "r",
+            type: "string",
+            default: "{CWD}/certificates",
+            describe: "the location of the Certificate folder",
+        };
+        break;
+
+    case "CAFolder":
+        options.CAFolder = {
+            alias: "c",
+            type: "string",
+            default: "{root}/CA",
+            describe: "the location of the Certificate Authority folder",
+        };
+        break;
 
-        case "silent":
-            options.silent = {
-                alias: "s",
-                type: "boolean",
-                default: false,
-                describe: "minimize output",
-            };
-            break;
-
-        case "privateKey":
-            options.privateKey = {
-                alias: "p",
-                type: "string",
-                default: "{PKIFolder}/own/private_key.pem",
-                describe: "the private key to use to generate certificate",
-            };
-            break;
-
-        case "keySize":
-            options.keySize = {
-                alias: ["k", "keyLength"],
-                type: "number",
-                default: 2048,
-                describe: "the private key size in bits (1024|2048|3072|4096)",
-            };
-            break;
-        default:
-            throw Error("Unknown option  " + optionName);
+    case "PKIFolder":
+        options.PKIFolder = {
+            type: "string",
+            default: "{root}/PKI",
+            describe: "the location of the Public Key Infrastructure",
+        };
+        break;
+
+    case "silent":
+        options.silent = {
+            alias: "s",
+            type: "boolean",
+            default: false,
+            describe: "minimize output",
+        };
+        break;
+
+    case "privateKey":
+        options.privateKey = {
+            alias: "p",
+            type: "string",
+            default: "{PKIFolder}/own/private_key.pem",
+            describe: "the private key to use to generate certificate",
+        };
+        break;
+
+    case "keySize":
+        options.keySize = {
+            alias: ["k", "keyLength"],
+            type: "number",
+            default: 2048,
+            describe: "the private key size in bits (1024|2048|3072|4096)",
+        };
+        break;
+    default:
+        throw Error("Unknown option  " + optionName);
     }
 }
 
@@ -622,7 +624,7 @@ function createDefaultCertificate(
 }
 
 // tslint:disable-next-line:no-empty
-let done: ErrorCallback = (err?: Error | null) => {};
+let done: ErrorCallback = (err?: Error | null) => {/** */};
 
 function create_default_certificates(dev: boolean, done: ErrorCallback) {
     function __create_default_certificates(
@@ -1079,7 +1081,7 @@ argv
     .command(
         "dump <certificateFile>",
         "display a certificate",
-        () => {},
+        () => { /** */},
         (yargs: any) => {
             dumpCertificate(yargs.certificateFile, (err: Error | null, data?: string) => {
                 if (!err) {
@@ -1093,7 +1095,7 @@ argv
     .command(
         "toder <pemCertificate>",
         "convert a certificate to a DER format with finger print",
-        () => {},
+        () => {/** */},
         (yargs: commands.Argv) => {
             function convertToDerFromCommandLine(argv: any, done: ErrorCallback) {
                 toDer(argv.pemCertificate, (err: Error | null) => done(err!));
@@ -1105,7 +1107,7 @@ argv
     .command(
         "fingerprint <certificateFile>",
         "print the certificate fingerprint",
-        () => {},
+        () => { /** */},
         (local_argv: any) => {
             const certificate = local_argv.certificateFile;
             fingerprint(certificate, (err: Error | null, data?: string) => {

lib/misc/hostname.ts

@@ -41,7 +41,7 @@ export async function extractFullyQualifiedDomainName(): Promise<string> {
     }
     if (process.platform === "win32") {
         // http://serverfault.com/a/73643/251863
-        const env = process.env;http://serverfault.com/a/73643/251863
+        const env = process.env; 
         _fullyQualifiedDomainNameInCache =
             env.COMPUTERNAME + (env.USERDNSDOMAIN && env.USERDNSDOMAIN!.length > 0 ? "." + env.USERDNSDOMAIN! : "");
     } else {

lib/misc/install_prerequisite.ts

@@ -57,6 +57,7 @@ declare interface WgetInterface {
 }
 
 // tslint:disable-next-line:no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const wget = require("wget-improved") as WgetInterface;
 
 type CallbackFunc<T> = (err: Error | null, result?: T) => void;
@@ -91,8 +92,8 @@ function execute(cmd: string, callback: CallbackFunc<ExecuteResult>, cwd?: strin
 
     // xx cwd = cwd ? {cwd: cwd} : {};
     const options = {
-      cwd,
-      windowsHide: true
+        cwd,
+        windowsHide: true
     };
 
 
@@ -114,7 +115,7 @@ function execute(cmd: string, callback: CallbackFunc<ExecuteResult>, cwd?: strin
 }
 
 function quote(str: string): string {
-    return '"' + str.replace(/\\/g, "/") + '"';
+    return "\"" + str.replace(/\\/g, "/") + "\"";
 }
 
 function is_expected_openssl_version(strVersion: string): boolean {

lib/misc/subject.ts

@@ -41,7 +41,6 @@ const _keys = {
 };
 
 export class Subject implements SubjectOptions {
-
     public readonly commonName?: string;
     public readonly organization?: string;
     public readonly organizationalUnit?: string;
@@ -51,8 +50,7 @@ export class Subject implements SubjectOptions {
     public readonly domainComponent?: string;
 
     constructor(options: SubjectOptions | string) {
-
-        if (typeof(options) === "string") {
+        if (typeof options === "string") {
             options = Subject.parse(options);
         }
         this.commonName = options.commonName;
@@ -65,9 +63,8 @@ export class Subject implements SubjectOptions {
     }
 
     public static parse(str: string): SubjectOptions {
-
-        const elements = str.split(/\/(?=[^\/]*?=)/);
-        const options: any = {};
+        const elements = str.split(/\/(?=[^/]*?=)/);
+        const options: Record<string, unknown> = {};
 
         elements.forEach((element: string) => {
             if (element.length === 0) {
@@ -76,17 +73,16 @@ export class Subject implements SubjectOptions {
             const s: string[] = element.split("=");
 
             if (s.length !== 2) {
-                    throw new Error("invalid format for " + element);
+                throw new Error("invalid format for " + element);
             }
             const longName = (_keys as any)[s[0]];
             const value = s[1];
-            options[longName] = Buffer.from(value,"ascii").toString("utf8");
+            options[longName] = Buffer.from(value, "ascii").toString("utf8");
         });
         return options as SubjectOptions;
     }
 
     public toString() {
-
         let tmp = "";
         if (this.country) {
             tmp += "/C=" + this.country;
@@ -111,5 +107,4 @@ export class Subject implements SubjectOptions {
         }
         return tmp;
     }
-
 }

lib/pki/certificate_authority.ts

@@ -140,14 +140,15 @@ function construct_CertificateAuthority(certificateAuthority: CertificateAuthori
     }
 
     // tslint:disable:no-empty
-    displayTitle("Create Certificate Authority (CA)", (err?: Error | null) => { });
+    displayTitle("Create Certificate Authority (CA)", (err?: Error | null) => { /** */ });
 
     const indexFileAttr = path.join(caRootDir, "index.txt.attr");
     if (!fs.existsSync(indexFileAttr)) {
         fs.writeFileSync(indexFileAttr, "unique_subject = no");
     }
 
     const caConfigFile = certificateAuthority.configFile;
+    // eslint-disable-next-line no-constant-condition
     if (1 || !fs.existsSync(caConfigFile)) {
         let data = configurationFileTemplate; // inlineText(configurationFile);
         data = data.replace(/%%ROOT_FOLDER%%/, make_path(caRootDir));
@@ -156,7 +157,7 @@ function construct_CertificateAuthority(certificateAuthority: CertificateAuthori
     }
 
     // http://www.akadia.com/services/ssh_test_certificate.html
-    const subjectOpt = ' -subj "' + subject.toString() + '" ';
+    const subjectOpt = " -subj \"" + subject.toString() + "\" ";
     const options = { cwd: caRootDir };
     processAltNames({} as Params);
 
@@ -268,8 +269,8 @@ export class CertificateAuthority {
     public readonly subject: Subject;
 
     constructor(options: CertificateAuthorityOptions) {
-        assert(options.hasOwnProperty("location"));
-        assert(options.hasOwnProperty("keySize"));
+        assert(Object.prototype.hasOwnProperty.call(options,"location"));
+        assert(Object.prototype.hasOwnProperty.call(options,"keySize"));
         this.location = options.location;
         this.keySize = options.keySize || 2048;
         this.subject = new Subject(options.subject || defaultSubject);
@@ -729,6 +730,7 @@ export class CertificateAuthority {
 }
 
 // tslint:disable:no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const thenify = require("thenify");
 const opts = { multiArgs: false };
 CertificateAuthority.prototype.initialize = thenify.withCallback(CertificateAuthority.prototype.initialize, opts);