Use EditorConfig **DRAFT**

.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+max_line_length = 80
+
+[*.{json,md,yml}]
+indent_style = space
+indent_size = 2
+
+[*.{ts,js}]
+indent_style = space
+indent_size = 4

.github/workflows/lint.yml

@@ -7,16 +7,16 @@ jobs:
       matrix:
         node-version: [12.x]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - run: npm ci
-    - run: npm run lint-check-only
+      - uses: actions/checkout@v2
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm run lint-check-only

.github/workflows/pr.yml

@@ -7,56 +7,56 @@ jobs:
       matrix:
         node-version: [12.x]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - uses: actions/cache@v2
-      id: npm-cache
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - run: npm ci
-    - run: npm run test
+      - uses: actions/checkout@v2
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        id: npm-cache
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm run test
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [12.x]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - run: npm ci
-    - run: npm run lint
+      - uses: actions/checkout@v2
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm run lint
   docs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [12.x]
     steps:
-    - uses: actions/checkout@v2
-    - name: Install Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - run: npm ci
-    - run: npm run build:doc
-    - run: git diff-files --ignore-all-space --name-only --exit-code
+      - uses: actions/checkout@v2
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm run build:doc
+      - run: git diff-files --ignore-all-space --name-only --exit-code

.prettierignore

@@ -0,0 +1,4 @@
+package-lock.json
+doc/
+dist/
+coverage/

.prettierrc.js

@@ -1,20 +1,4 @@
 module.exports = {
-    printWidth: 80,
     semi: false,
     trailingComma: "all",
-    tabWidth: 4,
-    overrides: [
-        {
-            files: ["*.json"],
-            options: {
-                tabWidth: 2,
-            },
-        },
-        {
-            files: "*.md",
-            options: {
-                tabWidth: 2,
-            },
-        },
-    ],
 }

README.md

@@ -29,6 +29,12 @@ Within the project root directory:
 npm install
 ```
 
+### Format Code Files
+
+```shell
+npm run formatcode
+```
+
 ### Run Linter
 
 ```shell

package.json

@@ -16,6 +16,7 @@
     "build": "tsc --build",
     "build:doc": "rimraf doc && typedoc src/index.ts",
     "build:release": "rimraf dist && rollup -c",
+    "formatcode": "prettier --write .",
     "lint": "tsc && eslint --fix 'src/**'",
     "lint-check-only": "tsc && eslint 'src/**'",
     "test": "jest --coverage",

rollup.config.js

@@ -1,62 +1,61 @@
-import path from "path";
-import resolve from "@rollup/plugin-node-resolve";
-import typescript from "@rollup/plugin-typescript";
-import { terser } from "rollup-plugin-terser";
-import license from "rollup-plugin-license";
-import sizes from "rollup-plugin-sizes";
+import path from "path"
+import resolve from "@rollup/plugin-node-resolve"
+import typescript from "@rollup/plugin-typescript"
+import { terser } from "rollup-plugin-terser"
+import license from "rollup-plugin-license"
+import sizes from "rollup-plugin-sizes"
 
-const __dirname = path.resolve();
-const extensions = [".ts", ".js"];
+const __dirname = path.resolve()
+const extensions = [".ts", ".js"]
 const commonPlugins = [
     terser({
-      output: {
-        comments: false
-      }
+        output: {
+            comments: false,
+        },
     }),
     license({
-      banner: {
-        content: {
-          file: "LICENSE_TEMPLATE"
-        }
-      }
+        banner: {
+            content: {
+                file: "LICENSE_TEMPLATE",
+            },
+        },
     }),
-    sizes()
-];
+    sizes(),
+]
 
 export default [
-  {
-    input: "./src/index.ts",
-    plugins: [
-      resolve({ extensions }),
-      typescript({
-        target: "es5",
-        composite: false
-      }),
-      ...commonPlugins
-    ],
-    output: {
-      dir: path.resolve(__dirname, "dist"),
-      format: "umd",
-      name: "openinsights"
-    }
-  },
-  {
-    input: "./src/index.ts",
-    plugins: [
-      resolve({ extensions }),
-      typescript({
-        declaration: true,
-        composite: false,
-        declarationDir: path.resolve(__dirname, "dist", "esm", "types"),
-        outDir: path.resolve(__dirname, "dist", "esm"),
-        rootDir: path.resolve(__dirname, "src")
-      }),
-      ...commonPlugins
-    ],
-    output: {
-      dir: path.resolve(__dirname, "dist", "esm"),
-      format: "es"
-    }
-  }
-];
-
+    {
+        input: "./src/index.ts",
+        plugins: [
+            resolve({ extensions }),
+            typescript({
+                target: "es5",
+                composite: false,
+            }),
+            ...commonPlugins,
+        ],
+        output: {
+            dir: path.resolve(__dirname, "dist"),
+            format: "umd",
+            name: "openinsights",
+        },
+    },
+    {
+        input: "./src/index.ts",
+        plugins: [
+            resolve({ extensions }),
+            typescript({
+                declaration: true,
+                composite: false,
+                declarationDir: path.resolve(__dirname, "dist", "esm", "types"),
+                outDir: path.resolve(__dirname, "dist", "esm"),
+                rootDir: path.resolve(__dirname, "src"),
+            }),
+            ...commonPlugins,
+        ],
+        output: {
+            dir: path.resolve(__dirname, "dist", "esm"),
+            format: "es",
+        },
+    },
+]

setupJest.js

@@ -1 +1 @@
-require('jest-fetch-mock').enableMocks()
+require("jest-fetch-mock").enableMocks()

tsconfig.json

@@ -1,23 +1,19 @@
 {
-    "compilerOptions": {
-        "target": "es5",
-        "composite": true,
-        "rootDir": "src",
-        "outDir": "dist",
-        "lib": ["DOM", "ES2015", "ES2020"],
-        "module": "es6",
-        "moduleResolution": "node",
-        "strict": true,
-        "esModuleInterop": true,
-        "forceConsistentCasingInFileNames": true,
-        "declaration": true,
-        "declarationDir": "dist/types",
-        "declarationMap": true
-    },
-    "include": ["src/**/*"],
-    "exclude": [
-        "dist",
-        "**/*.test.ts",
-        "src/testUtil"
-    ]
+  "compilerOptions": {
+    "target": "es5",
+    "composite": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "lib": ["DOM", "ES2015", "ES2020"],
+    "module": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationDir": "dist/types",
+    "declarationMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist", "**/*.test.ts", "src/testUtil"]
 }