Setup Prettier for test/cy code

.github/workflows/lint.yaml

@@ -20,3 +20,7 @@ jobs:
     - run: just web install
     - run: just web lint
     - run: just web check-format
+
+    - run: just test/cy install
+    - run: just test/cy lint
+    - run: just test/cy check-format

test/cy/.eslintrc.cjs

@@ -1,7 +1,7 @@
 module.exports = {
-    extends: ['plugin:cypress/recommended'],
-    plugins: ['cypress'],
-    env: {
-      'cypress/globals': true,
-    }
-  };
+  extends: ["plugin:cypress/recommended", "prettier"],
+  plugins: ["cypress"],
+  env: {
+    "cypress/globals": true,
+  },
+};

test/cy/.prettierrc

@@ -0,0 +1 @@
+{}

test/cy/cypress.config.js

@@ -8,6 +8,6 @@ module.exports = defineConfig({
     },
     viewportHeight: 1080,
     viewportWidth: 1920,
-    video: true
+    video: true,
   },
 });

test/cy/cypress/e2e/contract/deploy.cy.js

@@ -1,50 +1,55 @@
-describe('Publish', () => {
-  it('publish content and check app type', () => {
+describe("Publish", () => {
+  it("publish content and check app type", () => {
     cy.visit({
-      url: '/',
-      qs: { token: Cypress.env('token') }
+      url: "/",
+      qs: { token: Cypress.env("token") },
     });
 
     // Add a New Deployment button
-    cy.get('div[data-automation="add-new-deployment"]')
-      .click();
+    cy.get('div[data-automation="add-new-deployment"]').click();
 
     // Continue to Deploy
     // ensure accounts are loaded to stall before clicking
-    cy.get('label[data-automation="account"]')
-      .should('exist');
-    cy.get('button[data-automation="continue-deployment"]')
-      .click();
+    cy.get('label[data-automation="account"]').should("exist");
+    cy.get('button[data-automation="continue-deployment"]').click();
 
     // Deploy
-    cy.get('button[data-automation="deploy"]')
-      .click();
+    cy.get('button[data-automation="deploy"]').click();
 
     // Wait for Deployment Success message
-    cy.get('div[data-automation="deploy-message"]', { timeout: 30000 })
-      .contains("Deploy was successful!");
+    cy.get('div[data-automation="deploy-message"]', {
+      timeout: 30000,
+    }).contains("Deploy was successful!");
 
     // Get the link from the deployment logs
-    cy.get('a[href="#/progress')
-      .click();
+    cy.get('a[href="#/progress').click();
     cy.get('div[class="space-between-sm"]')
-      .find('p').last().invoke('text').then((guid) => {
-        Cypress.env('DEPLOYED_APP_URL', '/__api__/v1/content/' + guid);
-        cy.log("MY GUID " + Cypress.env('DEPLOYED_APP_URL'));
-        cy.log("MY URL " + Cypress.env('CYPRESS_CONNECT_ADDRESS') + Cypress.env('DEPLOYED_APP_URL'))
+      .find("p")
+      .last()
+      .invoke("text")
+      .then((guid) => {
+        Cypress.env("DEPLOYED_APP_URL", "/__api__/v1/content/" + guid);
+        cy.log("MY GUID " + Cypress.env("DEPLOYED_APP_URL"));
+        cy.log(
+          "MY URL " +
+            Cypress.env("CYPRESS_CONNECT_ADDRESS") +
+            Cypress.env("DEPLOYED_APP_URL"),
+        );
 
         // Use API to check the content on Connect
         cy.request({
-          method: 'GET',
-          url: Cypress.env('CYPRESS_CONNECT_ADDRESS') + Cypress.env('DEPLOYED_APP_URL'),
-          'auth': {
-            'bearer': Cypress.env('CONNECT_API_KEY')
-        },
-      }).then((response) => {
-        expect(response.status).to.equal(200);
-        // app mode should be correct
-        expect(response.body).to.have.property('app_mode', 'python-fastapi')
+          method: "GET",
+          url:
+            Cypress.env("CYPRESS_CONNECT_ADDRESS") +
+            Cypress.env("DEPLOYED_APP_URL"),
+          auth: {
+            bearer: Cypress.env("CONNECT_API_KEY"),
+          },
+        }).then((response) => {
+          expect(response.status).to.equal(200);
+          // app mode should be correct
+          expect(response.body).to.have.property("app_mode", "python-fastapi");
+        });
       });
-    });
   });
 });

test/cy/cypress/e2e/ui/home.cy.js

@@ -1,54 +1,51 @@
-describe('Landing', () => {
+describe("Landing", () => {
   beforeEach(() => {
     cy.visit({
-      url: '/',
+      url: "/",
     });
   });
-  it('.should() - assert that <title> is correct', () => {
-    cy.title().should('include', 'Posit Publisher');
+  it(".should() - assert that <title> is correct", () => {
+    cy.title().should("include", "Posit Publisher");
   });
-  
-  it('dark mode works', () => {
+
+  it("dark mode works", () => {
     // expand dark mode menu
     cy.expandDarkMenu();
-    cy.get('body').should('have.css', 'background-color', 'rgb(250, 250, 250)');
+    cy.get("body").should("have.css", "background-color", "rgb(250, 250, 250)");
 
     // set dark mode on
-    cy.get('div[data-automation="dark-on"]')
-      .click();
-    cy.get('body').should('have.css', 'background-color', 'rgb(18, 18, 18)');
+    cy.get('div[data-automation="dark-on"]').click();
+    cy.get("body").should("have.css", "background-color", "rgb(18, 18, 18)");
 
     cy.expandDarkMenu();
     // set dark mode off
-    cy.get('div[data-automation="dark-off"]')
-      .click();
-    cy.get('body').should('have.css', 'background-color', 'rgb(250, 250, 250)');
+    cy.get('div[data-automation="dark-off"]').click();
+    cy.get("body").should("have.css", "background-color", "rgb(250, 250, 250)");
 
     cy.expandDarkMenu();
     // set dark mode auto
-    cy.get('div[data-automation="dark-auto"]')
-      .click();
-    cy.get('body').should('have.css', 'background-color', 'rgb(250, 250, 250)');
+    cy.get('div[data-automation="dark-auto"]').click();
+    cy.get("body").should("have.css", "background-color", "rgb(250, 250, 250)");
   });
 
-// disabling configuration file test temporarily
- // it('configuration file is displayed', () => {
- //   cy.get('div[data-automation="config-card"]')
- //     .find('h3[class="card-title truncate"]')
- //     .contains("default");
- // });
- 
+  // disabling configuration file test temporarily
+  // it('configuration file is displayed', () => {
+  //   cy.get('div[data-automation="config-card"]')
+  //     .find('h3[class="card-title truncate"]')
+  //     .contains("default");
+  // });
+
   // cy.get('div[data-automation="config-card"]')
   //   .find('p')
   //   .should('contain', '.posit')
   //   .and('contain', 'publish')
   //   .and('contain', 'default.toml');
   // });
 
-it('files are displayed', () => {
-  cy.get('div[data-automation="file-tree"]')
-    .should('contain', 'fastapi-simple')
-    .and('contain', 'requirements.txt')
-    .and('contain', 'simple.py');
+  it("files are displayed", () => {
+    cy.get('div[data-automation="file-tree"]')
+      .should("contain", "fastapi-simple")
+      .and("contain", "requirements.txt")
+      .and("contain", "simple.py");
   });
-});
+});

test/cy/cypress/support/commands.js

@@ -24,11 +24,8 @@
 // -- This will overwrite an existing command --
 // Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
 
-Cypress.Commands.add('expandDarkMenu', () => {
-    cy.get('button[data-automation="menu-button"]')
-    .click();
-    cy.get('div[data-automation="dark-mode-submenu"]')
-    .click();
-    cy.get('div[data-automation="dark-on"]')
-    .should('be.visible');
-});
+Cypress.Commands.add("expandDarkMenu", () => {
+  cy.get('button[data-automation="menu-button"]').click();
+  cy.get('div[data-automation="dark-mode-submenu"]').click();
+  cy.get('div[data-automation="dark-on"]').should("be.visible");
+});

test/cy/cypress/support/e2e.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import "./commands";
 
 // Alternatively you can use CommonJS syntax:
-// require('./commands')
+// require('./commands')

test/cy/justfile

@@ -46,6 +46,20 @@ lint:
 
     npm run lint
 
+format:
+    #!/usr/bin/env bash
+    set -eou pipefail
+    {{ _with_debug }}
+
+    npm run format
+
+check-format:
+    #!/usr/bin/env bash
+    set -eou pipefail
+    {{ _with_debug }}
+
+    npm run check-format
+
 # Install dependencies
 install:
     #!/usr/bin/env bash

test/cy/package.json

@@ -3,6 +3,8 @@
   "scripts": {
     "lint": "eslint --ext .js,.ts,.cjs .",
     "fix": "eslint --ext .js,.ts,.cjs . --fix",
+    "format": "prettier . --write",
+    "check-format": "prettier . --check",
     "init": "just ../../run init ./test/sample-content/fastapi-simple",
     "start": "just ../../run ui --listen 127.0.0.1:9000 ./test/sample-content/fastapi-simple",
     "test": "start-server-and-test --expect 200 start http-get://127.0.0.1:9000 run",
@@ -18,7 +20,9 @@
   "devDependencies": {
     "cypress": "^13.3.0",
     "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-cypress": "^2.15.1",
+    "prettier": "3.2.5",
     "start-server-and-test": "^2.0.3"
   }
 }