Merge pull request #97 from docusign/feature/add-and-configure-linter

Add code analyzer

Author: raileendr

.eslintignore

@@ -0,0 +1,4 @@
+config/*
+public/*
+node_modules/*
+test/*

.eslintrc.json

@@ -0,0 +1,87 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+        "arrow-spacing": [1, { "before": true, "after": true }],
+        "block-spacing": [1, "always"],
+        "brace-style": [1, "1tbs", { "allowSingleLine": true }],
+        "comma-spacing": [1, { "before": false, "after": true }],
+        "comma-style": [1, "last"],
+        "dot-location": [1, "property"],
+        "eol-last": 1,
+        "eqeqeq": [1, "always", {"null": "ignore"}],
+        "key-spacing": [1, { "beforeColon": false, "afterColon": true }],
+        "no-cond-assign": 1,
+        "no-const-assign": 1,
+        "no-debugger": 1,
+        "no-delete-var": 1,
+        "no-dupe-args": 1,
+        "no-dupe-class-members": 1,
+        "no-dupe-keys": 1,
+        "no-duplicate-case": 1,
+        "no-empty-character-class": 1,
+        "no-labels": 1,
+        "no-ex-assign": 1,
+        "no-extra-boolean-cast": 1,
+        "no-extra-parens": [1, "functions"],
+        "no-fallthrough": 1,
+        "no-floating-decimal": 1,
+        "no-func-assign": 1,
+        "no-implied-eval": 1,
+        "no-inner-declarations": [1, "functions"],
+        "no-invalid-regexp": 1,
+        "no-irregular-whitespace": 1,
+        "no-label-var": 1,
+        "no-lone-blocks": 1,
+        "no-mixed-spaces-and-tabs": 1,
+        "no-multi-spaces": 1,
+        "no-multi-str": 1,
+        "no-multiple-empty-lines": [1, { "max": 2 }],
+        "no-native-reassign": 1,
+        "no-negated-in-lhs": 1,
+        "no-new": 1,
+        "no-new-func": 1,
+        "no-new-require": 1,
+        "no-new-wrappers": 1,
+        "no-obj-calls": 1,
+        "no-octal": 1,
+        "no-octal-escape": 1,
+        "no-return-assign": 1,
+        "no-self-compare": 1,
+        "no-sequences": 1,
+        "no-shadow-restricted-names": 1,
+        "no-spaced-func": 1,
+        "no-sparse-arrays": 1,
+        "no-throw-literal": 1,
+        "no-trailing-spaces": 1,
+        "no-undef-init": 1,
+        "no-unexpected-multiline": 1,
+        "no-unneeded-ternary": [1, { "defaultAssignment": false }],
+        "no-unreachable": 1,
+        "no-useless-call": 1,
+        "no-with": 1,
+        "one-var": [1, { "initialized": "never" }],        
+        "quotes": [1, "single", "avoid-escape"],
+        "quote-props": [1, "as-needed"],
+        "semi": [1, "always"],
+        "semi-spacing": [1, { "before": false, "after": false }],
+        "keyword-spacing": [1, { "before": true, "after": true }],
+        "space-before-function-paren": [1, {
+            "anonymous": "never",
+            "named": "never",
+            "asyncArrow": "always"
+        }],
+        "space-in-parens": [1, "never"],
+        "space-infix-ops": 1,
+        "space-unary-ops": [1, { "words": true, "nonwords": false }],
+        "yoda": [1, "never"]
+    }
+}

.github/workflows/node.js.yml

@@ -31,6 +31,9 @@ jobs:
         npm cache clean --force
         npm cache verify
         npm install
+    
+    - name: Run linter
+      run: npm run lint
 
     - name: Run build
       run: npm run build --if-present

embeddedSigning.js

@@ -4,8 +4,8 @@
  * @author DocuSign
  */
 
-const fs = require("fs-extra");
-const docusign = require("docusign-esign");
+const fs = require('fs-extra');
+const docusign = require('docusign-esign');
 
 /**
  * This function does the work of creating the envelope and the
@@ -21,9 +21,9 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
   //ds-snippet-start:eSign1Step3
   let dsApiClient = new docusign.ApiClient();
   dsApiClient.setBasePath(args.basePath);
-  dsApiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
-  let envelopesApi = new docusign.EnvelopesApi(dsApiClient),
-    results = null;
+  dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
+  let envelopesApi = new docusign.EnvelopesApi(dsApiClient);
+  let results = null;
 
   // Step 1. Make the envelope request body
   let envelope = makeEnvelope(args.envelopeArgs);
@@ -65,7 +65,7 @@ function makeEnvelope(args) {
   // args.signerEmail
   // args.signerName
   // args.signerClientId
-  // docFile 
+  // docFile
 
   // document 1 (pdf) has tag /sn1/
   //
@@ -79,15 +79,15 @@ function makeEnvelope(args) {
 
   // create the envelope definition
   let env = new docusign.EnvelopeDefinition();
-  env.emailSubject = "Please sign this document";
+  env.emailSubject = 'Please sign this document';
 
   // add the documents
-  let doc1 = new docusign.Document(),
-    doc1b64 = Buffer.from(docPdfBytes).toString("base64");
+  let doc1 = new docusign.Document();
+  let doc1b64 = Buffer.from(docPdfBytes).toString('base64');
   doc1.documentBase64 = doc1b64;
-  doc1.name = "Lorem Ipsum"; // can be different from actual file name
-  doc1.fileExtension = "pdf";
-  doc1.documentId = "3";
+  doc1.name = 'Lorem Ipsum'; // can be different from actual file name
+  doc1.fileExtension = 'pdf';
+  doc1.documentId = '3';
 
   // The order in the docs array determines the order in the envelope
   env.documents = [doc1];
@@ -108,10 +108,10 @@ function makeEnvelope(args) {
   // The DocuSign platform seaches throughout your envelope's
   // documents for matching anchor strings.
   let signHere1 = docusign.SignHere.constructFromObject({
-    anchorString: "/sn1/",
-    anchorYOffset: "10",
-    anchorUnits: "pixels",
-    anchorXOffset: "20",
+    anchorString: '/sn1/',
+    anchorYOffset: '10',
+    anchorUnits: 'pixels',
+    anchorXOffset: '20',
   });
   // Tabs are set per recipient / signer
   let signer1Tabs = docusign.Tabs.constructFromObject({
@@ -127,7 +127,7 @@ function makeEnvelope(args) {
 
   // Request that the envelope be sent by setting |status| to "sent".
   // To request that the envelope be created as a draft, set to "created"
-  env.status = "sent";
+  env.status = 'sent';
 
   return env;
 }
@@ -151,12 +151,12 @@ function makeRecipientViewRequest(args) {
   // the DocuSign signing. It's usually better to use
   // the session mechanism of your web framework. Query parameters
   // can be changed/spoofed very easily.
-  viewRequest.returnUrl = args.dsReturnUrl + "?state=123";
+  viewRequest.returnUrl = args.dsReturnUrl + '?state=123';
 
   // How has your app authenticated the user? In addition to your app's
   // authentication, you can include authenticate steps from DocuSign.
   // Eg, SMS authentication
-  viewRequest.authenticationMethod = "none";
+  viewRequest.authenticationMethod = 'none';
 
   // Recipient information must match embedded recipient info
   // we used to create the envelope.