Wip/prettier formatting

.circleci/config.yml

@@ -65,7 +65,7 @@ jobs:
       - run:
           name: Copy build
           command: |
-            cp -r * /tmp/build/
+            cp -r . /tmp/build
       - save_cache:
           name: Save dependencies
           key: ts-{{ checksum "package.json" }}-cljs-{{ checksum "shadow-cljs.edn" }}-grammar-{{ checksum "src/calva-fmt/atom-language-clojure/package.json" }}
@@ -96,7 +96,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Update system package lists
           command: sudo apt-get update
@@ -128,6 +128,19 @@ jobs:
           paths:
             - ~/.atom/packages
             - ./node_modules
+  prettier-check:
+    docker:
+      - image: circleci/node:latest
+    working_directory: ~/calva
+    steps:
+      - attach_workspace:
+          at: /tmp
+      - run:
+          name: Restore build
+          command: cp -rT /tmp/build ~/calva
+      - run:
+          name: Run prettier format check
+          command: npm run prettier-check
   test-cljslib:
     docker:
       - image: circleci/node:latest
@@ -137,7 +150,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Run CLJS Tests
           command: npm run calva-lib-test
@@ -152,7 +165,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Run TS Unit Tests
           command: npm run unit-test
@@ -167,7 +180,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Compile Extension Tests
           command: npm run compile-test
@@ -185,7 +198,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: "Publish Release on GitHub"
           command: |
@@ -217,7 +230,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Publish to the marketplace
           command: |
@@ -237,7 +250,7 @@ jobs:
           at: /tmp
       - run:
           name: Restore build
-          command: cp -r /tmp/build/* .
+          command: cp -rT /tmp/build ~/calva
       - run:
           name: Publish to Open VSX
           command: |
@@ -323,6 +336,9 @@ workflows:
           filters:
             tags:
               ignore: /^v\d+\.\d+\.\d+-?.*/
+      - prettier-check:
+          requires:
+            - build
       - test-grammar:
           requires:
             - build
@@ -343,6 +359,14 @@ workflows:
               ignore: /.*/
             tags:
               only: /^v\d+\.\d+\.\d+-?.*/
+      - prettier-check:
+          requires:
+            - build
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /^v\d+\.\d+\.\d+-?.*/
       - test-grammar:
           requires:
             - build
@@ -377,6 +401,7 @@ workflows:
               only: /^v\d+\.\d+\.\d+-?.*/
       - github-release:
           requires:
+            - prettier-check
             - test-grammar
             - test-cljslib
             - test-integration

.prettierignore

@@ -0,0 +1,7 @@
+/node_modules
+/.shadow-cljs
+/out
+/.vscode-test
+/.vscode
+/.lsp
+/.clj-kondo

.prettierrc

@@ -0,0 +1,27 @@
+{
+  "printWidth": 80,
+  "tabWidth": 4,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "proseWrap": "preserve",
+  "htmlWhitespaceSensitivity": "css",
+  "endOfLine": "lf",
+  "embeddedLanguageFormatting": "auto",
+  "overrides": [
+    {
+      "files": [
+        "*.css"
+      ],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

CHANGELOG.md

@@ -4,6 +4,8 @@ Changes to Calva.
 
 ## [Unreleased]
 
+- Maintenance: [Consistently format all JavaScript and TypeScript in the project and provide for easily formatting these files in the future.](https://github.com/BetterThanTomorrow/calva/pull/1524)
+
 ## [2.0.240] - 2022-02-06
 - Maintenance: [Update dependencies to fix security vulnerabilities](https://github.com/BetterThanTomorrow/calva/pull/1520)
 

docs/PULL_REQUEST_TEMPLATE.md

@@ -51,6 +51,7 @@ I have:
      - [ ] If I am fixing the issue, I have used [GitHub's fixes/closes syntax](https://help.github.com/en/articles/closing-issues-using-keywords)
      - [ ] If I am fixing just part of the issue, I have just referenced it w/o any of the "fixes” keywords.
 - [ ] Created the issue I am fixing/addressing, if it was not present.
+- [ ] Formatted all JavaScript and TypeScript code that was changed. (use the [prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) or run `npm run prettier-format`)
 
 <!-- This is a nice book to read about the power of checklists: https://www.samuelthomasdavies.com/book-summaries/health-fitness/the-checklist-manifesto/ -->
 

package.json

@@ -2580,7 +2580,9 @@
         "calva-lib-test": "node ./out/cljs-lib/test/cljs-lib-tests.js",
         "integration-test": "node ./out/extension-test/integration/runTests.js",
         "unit-test": "npx mocha --require ts-node/register 'src/extension-test/unit/**/*-test.ts'",
-        "publish": "bb publish.clj"
+        "publish": "bb publish.clj",
+        "prettier-format": "npx prettier --write './**/*.{ts,js}'",
+        "prettier-check": "npx prettier --check './**/*.{ts,js}'"
     },
     "dependencies": {
         "@types/escape-html": "0.0.20",
@@ -2637,6 +2639,7 @@
         "node-gyp": "^8.4.1",
         "nodemon": "^2.0.3",
         "ovsx": "^0.3.0",
+        "prettier": "2.5.1",
         "rimraf": "^2.7.1",
         "shadow-cljs": "^2.11.18",
         "source-map-support": "^0.5.16",
@@ -2652,4 +2655,4 @@
         "webpack": "^5.27.1",
         "webpack-cli": "^4.5.0"
     }
-}
+}

src/analytics.ts

@@ -1,66 +1,87 @@
-import * as vscode from 'vscode';
-import * as UA from 'universal-analytics';
-import * as uuid from "uuidv4";
-import * as os from 'os';
-
-// var debug = require('debug');
-// debug.log = console.info.bind(console);
-
-
-function userAllowsTelemetry(): boolean {
-    const config = vscode.workspace.getConfiguration('telemetry');
-    return config.get<boolean>('enableTelemetry', false);
-}
-
-export default class Analytics {
-    private visitor: UA.Visitor;
-    private extension: vscode.Extension<any>;
-    private extensionVersion: string;
-    private store: vscode.Memento;
-    private GA_ID = (process.env.CALVA_DEV_GA ? process.env.CALVA_DEV_GA : 'FUBAR-69796730-3').replace(/^FUBAR/, "UA");
-
-    constructor(context: vscode.ExtensionContext) {
-        this.extension = vscode.extensions.getExtension("betterthantomorrow.calva")!;
-        this.extensionVersion = this.extension.packageJSON.version;
-        this.store = context.globalState;
-
-        this.visitor = UA(this.GA_ID, this.userID());
-        this.visitor.set("cd1", this.extensionVersion);
-        this.visitor.set("cd2", vscode.version);
-        this.visitor.set("cd3", this.extensionVersion);
-        this.visitor.set("cd4", `${os.platform()}/${os.release()}`);
-        this.visitor.set("cn", `calva-${this.extensionVersion}`);
-        this.visitor.set("ua", `Calva/${this.extensionVersion} (${os.platform()}; ${os.release()}; ${os.type}) VSCode/${vscode.version}`);
-    }
-
-    private userID(): string {
-        const KEY = 'userLogID';
-        if (this.store.get(KEY) == undefined) {
-            const newID = uuid.uuid();
-            this.store.update(KEY, newID)
-            return newID;
-        } else {
-            return this.store.get(KEY);
-        }
-    }
-
-    logPath(path: string): Analytics {
-        if (userAllowsTelemetry()) {
-            this.visitor.pageview(path);
-        }
-        return this;
-    }
-
-    logEvent(category: string, action: string, label?: string, value?: string): Analytics {
-        if (userAllowsTelemetry()) {
-            this.visitor.event({ ec: category, ea: action, el: label, ev: value });
-        }
-        return this;
-    }
-
-    send() {
-        if (userAllowsTelemetry()) {
-            this.visitor.send();
-        }
-    }
-}
+import * as vscode from 'vscode';
+import * as UA from 'universal-analytics';
+import * as uuid from 'uuidv4';
+import * as os from 'os';
+
+// var debug = require('debug');
+// debug.log = console.info.bind(console);
+
+function userAllowsTelemetry(): boolean {
+    const config = vscode.workspace.getConfiguration('telemetry');
+    return config.get<boolean>('enableTelemetry', false);
+}
+
+export default class Analytics {
+    private visitor: UA.Visitor;
+    private extension: vscode.Extension<any>;
+    private extensionVersion: string;
+    private store: vscode.Memento;
+    private GA_ID = (process.env.CALVA_DEV_GA
+        ? process.env.CALVA_DEV_GA
+        : 'FUBAR-69796730-3'
+    ).replace(/^FUBAR/, 'UA');
+
+    constructor(context: vscode.ExtensionContext) {
+        this.extension = vscode.extensions.getExtension(
+            'betterthantomorrow.calva'
+        )!;
+        this.extensionVersion = this.extension.packageJSON.version;
+        this.store = context.globalState;
+
+        this.visitor = UA(this.GA_ID, this.userID());
+        this.visitor.set('cd1', this.extensionVersion);
+        this.visitor.set('cd2', vscode.version);
+        this.visitor.set('cd3', this.extensionVersion);
+        this.visitor.set('cd4', `${os.platform()}/${os.release()}`);
+        this.visitor.set('cn', `calva-${this.extensionVersion}`);
+        this.visitor.set(
+            'ua',
+            `Calva/${
+                this.extensionVersion
+            } (${os.platform()}; ${os.release()}; ${os.type}) VSCode/${
+                vscode.version
+            }`
+        );
+    }
+
+    private userID(): string {
+        const KEY = 'userLogID';
+        if (this.store.get(KEY) == undefined) {
+            const newID = uuid.uuid();
+            this.store.update(KEY, newID);
+            return newID;
+        } else {
+            return this.store.get(KEY);
+        }
+    }
+
+    logPath(path: string): Analytics {
+        if (userAllowsTelemetry()) {
+            this.visitor.pageview(path);
+        }
+        return this;
+    }
+
+    logEvent(
+        category: string,
+        action: string,
+        label?: string,
+        value?: string
+    ): Analytics {
+        if (userAllowsTelemetry()) {
+            this.visitor.event({
+                ec: category,
+                ea: action,
+                el: label,
+                ev: value,
+            });
+        }
+        return this;
+    }
+
+    send() {
+        if (userAllowsTelemetry()) {
+            this.visitor.send();
+        }
+    }
+}