[JS] Modernize and automate code quality/formatting (#6815)

* [JS] `prettier` config and updated `eslint`

Fixes #6757

* lint-staged config

run "npx lint-staged" from nodejs root for service

* set up husky

* `eslint --fix` on `adaptivecards`

does not include fixing of fixes :)

* eslint manual cleanup

* Fix formatting of properties with quotes

* `prettier` format `adaptivecards`

* tsx/jsx support and remove from .editorconfig

* Pre-filter commit hook to only check if files opened in nodejs

Author: paulcam206

.editorconfig

@@ -1,6 +1,6 @@
 root = true
 
-[**.{cpp,h,java,mm,cs,ts,js,tsx}]
+[**.{cpp,h,java,mm,cs}]
 indent_style = spaces
 indent_size = 4
 charset = utf-8

source/nodejs/.eslintignore

@@ -0,0 +1,9 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+cd source/nodejs
+NODEJS_FILES_CHANGED=`git status . --short | wc -l`
+if [ $NODEJS_FILES_CHANGED != "0" ]; then
+    npx lint-staged
+fi
+

source/nodejs/.eslintrc.js

@@ -0,0 +1,24 @@
+import { ESLint } from "eslint";
+import micromatch from "micromatch";
+
+// As suggested here: https://github.com/okonet/lint-staged#eslint--7-1
+const removeIgnoredFiles = async (files) => {
+  const eslint = new ESLint();
+  const isIgnored = await Promise.all(
+    files.map((file) => {
+      return eslint.isPathIgnored(file);
+    })
+  );
+  const filteredFiles = files.filter((_, i) => !isIgnored[i]);
+  return filteredFiles.join(" ");
+};
+
+export default {
+  "**/!(package-lock)*": async (files) => {
+    const filesToLint = await removeIgnoredFiles(micromatch(files, ["**/!(__)*.{ts,tsx,js,jsx}"]));
+    return [
+      `eslint --fix --max-warnings=0 ${filesToLint}`,
+      `prettier --write --ignore-unknown ${files.join(" ")}`
+    ];
+  }
+};

source/nodejs/.husky/pre-commit

@@ -0,0 +1,5 @@
+{
+	"printWidth": 100,
+	"trailingComma": "none",
+	"quoteProps": "preserve"
+}

source/nodejs/.lintstagedrc.mjs

@@ -29,7 +29,7 @@
 		"watch": "webpack --watch",
 		"start": "webpack-dev-server --open",
 		"dts": "dts-generator --prefix adaptivecards --project . --out dist/adaptivecards.d.ts",
-		"lint": "eslint src/*.ts",
+		"lint": "eslint .",
 		"prerelease": "npm run clean && npm run build-source",
 		"release": "webpack --mode=production && npm run dts",
 		"docs": "npx typedoc"

source/nodejs/.prettierrc.json

@@ -2,20 +2,20 @@
 // Licensed under the MIT License.
 import { ActionSet, SubmitAction } from "../../card-elements";
 
-test('ActionSet should be instantiated', () => {
+test("ActionSet should be instantiated", () => {
     const actionSet = new ActionSet();
     expect(actionSet).toEqual(expect.anything());
-})
+});
 
-test('getActionById returns action', () =>{
-	const actionSet = new ActionSet()
-	const action = new SubmitAction()
-	const id = 'Card.LastActionHero'
-	action.id = id
+test("getActionById returns action", () => {
+    const actionSet = new ActionSet();
+    const action = new SubmitAction();
+    const id = "Card.LastActionHero";
+    action.id = id;
 
-	actionSet.addAction(action)
+    actionSet.addAction(action);
 
-	const result = actionSet.getActionById(id)
+    const result = actionSet.getActionById(id);
 
-	expect(result).not.toBeUndefined()
-})
+    expect(result).not.toBeUndefined();
+});

source/nodejs/adaptivecards/package.json

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { AdaptiveCard } from "../../card-elements";
 
-test('AdaptiveCard should be instantiated', () => {
+test("AdaptiveCard should be instantiated", () => {
     const adaptiveCard = new AdaptiveCard();
     expect(adaptiveCard).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/action_set.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { BackgroundImage } from "../../card-elements";
 
-test('BackgroundImage should be instantiated', () => {
+test("BackgroundImage should be instantiated", () => {
     const backgroundImage = new BackgroundImage();
     expect(backgroundImage).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/adaptive_card.spec.ts

@@ -1,15 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import { AdaptiveCard, SerializationContext, TextBlock } from '../../card-elements';
-import { Carousel, CarouselPage } from '../../carousel';
-import { ValidationEvent } from '../../enums';
-import { CarouselConfig } from '../../host-config';
+import { AdaptiveCard, SerializationContext, TextBlock } from "../../card-elements";
+import { Carousel, CarouselPage } from "../../carousel";
+import { ValidationEvent } from "../../enums";
+import { CarouselConfig } from "../../host-config";
 
-describe('carousels', () => {
-    describe('when default constructed', () => {
+describe("carousels", () => {
+    describe("when default constructed", () => {
         const defaultCarousel = new Carousel();
 
-        it('should have reasonable default values', () => {
+        it("should have reasonable default values", () => {
             expect(defaultCarousel.getJsonTypeName()).toBe("Carousel");
             expect(defaultCarousel.getItemCount()).toEqual(0);
             expect(defaultCarousel.getAllInputs()).toStrictEqual([]);
@@ -18,7 +18,7 @@ describe('carousels', () => {
         });
     });
 
-    describe('when parsed from a valid object', () => {
+    describe("when parsed from a valid object", () => {
         const tinyTimer = 42;
 
         const carouselTheJson = {
@@ -53,11 +53,17 @@ describe('carousels', () => {
 
         let carouselTheObject: Carousel;
 
-        it('shouldn\'t throw exceptions', () => {
-            carouselTheObject = context.parseElement(undefined, carouselTheJson, [], false, true) as Carousel;
+        it("shouldn't throw exceptions", () => {
+            carouselTheObject = context.parseElement(
+                undefined,
+                carouselTheJson,
+                [],
+                false,
+                true
+            ) as Carousel;
         });
 
-        it('should have all of its expected properties and child elements', () => {
+        it("should have all of its expected properties and child elements", () => {
             expect(carouselTheObject.timer).toEqual(carouselConfig.minAutoplayDelay);
             expect(carouselTheObject.getItemCount()).toBe(2);
             for (let i = 0; i < carouselTheObject.getItemCount(); i++) {
@@ -70,7 +76,7 @@ describe('carousels', () => {
             }
         });
 
-        it('shouldn\'t allow anything in pages but CarouselPages', () => {
+        it("shouldn't allow anything in pages but CarouselPages", () => {
             const incorrectTypeCarousel = {
                 "type": "Carousel",
                 "pages": [
@@ -80,15 +86,21 @@ describe('carousels', () => {
                 ]
             };
 
-            let incorrectTypeParsed = context.parseElement(undefined, incorrectTypeCarousel, [], false, true) as Carousel;
+            let incorrectTypeParsed = context.parseElement(
+                undefined,
+                incorrectTypeCarousel,
+                [],
+                false,
+                true
+            ) as Carousel;
             expect(incorrectTypeParsed.getItemCount()).toBe(0);
             expect(context.eventCount).toBe(1);
             expect(context.getEventAt(0).event).toBe(ValidationEvent.ElementTypeNotAllowed);
         });
     });
 
-    describe('certain elements', () => {
-        it('shouldn\'t be allowed within a Carousel', () => {
+    describe("certain elements", () => {
+        it("shouldn't be allowed within a Carousel", () => {
             const carouselCard = {
                 "type": "AdaptiveCard",
                 "body": {
@@ -128,12 +140,12 @@ describe('carousels', () => {
             expect(theCard.getActionCount()).toBe(0);
 
             expect(context.eventCount).toBe(2);
-        })
+        });
     });
 });
 
-describe('carousel pages', () => {
-    it('shouldn\'t be parseable outside of a Carousel', () => {
+describe("carousel pages", () => {
+    it("shouldn't be parseable outside of a Carousel", () => {
         const context = new SerializationContext();
         const pageObject = {
             "type": "CarouselPage",
@@ -143,7 +155,7 @@ describe('carousel pages', () => {
                     "text": "unthinkable!"
                 }
             ]
-        }
+        };
         expect(context.parseElement(undefined, pageObject, [], false)).toBeUndefined();
         expect(context.eventCount).toBe(1);
         expect(context.getEventAt(0).event).toBe(ValidationEvent.UnknownElementType);

source/nodejs/adaptivecards/src/__tests__/components/back_ground_image.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { Column } from "../../card-elements";
 
-test('Column should be instantiated', () => {
+test("Column should be instantiated", () => {
     const column = new Column();
     expect(column).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/carousel.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { ColumnSet } from "../../card-elements";
 
-test('Container should be instantiated', () => {
+test("Container should be instantiated", () => {
     const columnSet = new ColumnSet();
     expect(columnSet).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/column.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { Container } from "../../card-elements";
 
-test('Container should be instantiated', () => {
+test("Container should be instantiated", () => {
     const container = new Container();
     expect(container).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/column_set.spec.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {Fact} from "../../card-elements";
+import { Fact } from "../../card-elements";
 
-test('Fact should be instantiated', ()=>{
+test("Fact should be instantiated", () => {
     const fact = new Fact();
     expect(fact).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/container.spec.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {FactSet} from "../../card-elements";
+import { FactSet } from "../../card-elements";
 
-test('FactSet should be instantiated', ()=>{
+test("FactSet should be instantiated", () => {
     const factSet = new FactSet();
     expect(factSet).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/fact.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { HttpAction } from "../../card-elements";
 
-test('HttpAction should be instantiate', () => {
+test("HttpAction should be instantiate", () => {
     const httpAction = new HttpAction();
     expect(httpAction).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/fact_set.spec.ts

@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {Image} from "../../card-elements";
+import { Image } from "../../card-elements";
 
-test('Image should be instantiated', ()=>{
+test("Image should be instantiated", () => {
     const image = new Image();
     expect(image).toEqual(expect.anything());
     expect(image.altText).toBeUndefined();
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/http_action.spec.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {ImageSet} from "../../card-elements";
+import { ImageSet } from "../../card-elements";
 
-test('ImageSet should be instantiated', ()=>{
+test("ImageSet should be instantiated", () => {
     const imageSet = new ImageSet();
     expect(imageSet).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/image.spec.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {OpenUrlAction} from "../../card-elements";
+import { OpenUrlAction } from "../../card-elements";
 
-test('OpenUrlAction should be instantiated', ()=>{
+test("OpenUrlAction should be instantiated", () => {
     const openUrlAction = new OpenUrlAction();
     expect(openUrlAction).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/image_set.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { ShowCardAction } from "../../card-elements";
 
-test('ShowCardAction should be instantiated', () => {
+test("ShowCardAction should be instantiated", () => {
     const showCardAction = new ShowCardAction();
     expect(showCardAction).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/open_url_action.spec.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {SubmitAction} from "../../card-elements";
+import { SubmitAction } from "../../card-elements";
 
-test('SubmitAction should be instantiated', ()=>{
+test("SubmitAction should be instantiated", () => {
     const submitAction = new SubmitAction();
     expect(submitAction).toEqual(expect.anything());
-})
+});

source/nodejs/adaptivecards/src/__tests__/components/show_card_action.spec.ts

@@ -1,21 +1,23 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import {AdaptiveCard,TextBlock} from "../../card-elements";
+import { AdaptiveCard, TextBlock } from "../../card-elements";
 
-test('TextBlock should be instantiated', ()=>{
+test("TextBlock should be instantiated", () => {
     const textBlock = new TextBlock();
     expect(textBlock).toEqual(expect.anything());
-})
+});
 
 const emoji_message = "Mix 🗣 emoji inside 🙌 text";
 const simple_test_card = {
     "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
     "type": "AdaptiveCard",
     "version": "1.0",
-    "body": [{
-        "type": "TextBlock",
-        "text": emoji_message
-    }]
+    "body": [
+        {
+            "type": "TextBlock",
+            "text": emoji_message
+        }
+    ]
 };
 
 // TODO: confirm this test working as expected