Merge pull request #9 from argos-ci/various-fixes

various fixes

Author: gregberge

.github/workflows/ci.yml

@@ -19,8 +19,11 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Lint & Format
-        run: npm run lint && npm run format
+      - name: Lint
+        run: npm run lint
+
+      - name: Check format
+        run: npm run check-format
 
       - name: Test
         run: npm run test

README.md

@@ -20,7 +20,7 @@ import "@argos-ci/cypress/support";
 
 ## Usage
 
-`cy.argosScreenshot` - command stabilizes the UI and takes a screenshot.
+`cy.argosScreenshot` command stabilizes the UI and takes a screenshot.
 
 _How to take a screenshot with `cy.argosScreenshot` command_
 
@@ -36,12 +36,12 @@ describe("Homepage", () => {
 });
 ```
 
-### Configuration
+## API
 
-`cy.argosScreenshot([name][, options])`
+### cy.argosScreenshot([name][, options])
 
 - `name` - The screenshot name; must be unique; default value to test title
-- `options` - Send to [cy.screenshot command options](https://docs.cypress.io/api/commands/screenshot)
+- `options` - See [cy.screenshot command options](https://docs.cypress.io/api/commands/screenshot)
 
 ## Helper attributes
 

cypress/e2e/argosScreenshot.cy.js

@@ -1,6 +1,6 @@
 const screenshotsFolder = Cypress.browser.isHeaded
-  ? `./cypress/screenshots/argos`
-  : `./cypress/screenshots/${Cypress.spec.name}/argos`;
+  ? `./cypress/screenshots`
+  : `./cypress/screenshots/${Cypress.spec.name}`;
 
 describe("argosScreenshot", () => {
   before(() => {
@@ -24,7 +24,7 @@ describe("argosScreenshot", () => {
 
     it("takes a screenshot with generic name", () => {
       cy.readFile(
-        `${screenshotsFolder}/argosScreenshot without name before all hook.png`
+        `${screenshotsFolder}/argosScreenshot -- without name -- waits for loader hiding -- before all hook.png`
       );
     });
   });

package.json

@@ -31,12 +31,16 @@
     "test": "cypress run",
     "test:open": "cypress open --e2e -b chrome",
     "format": "prettier --write .",
+    "check-format": "prettier --check .",
     "lint": "eslint --ignore-path .gitignore .",
     "release": "standard-version && conventional-github-releaser --preset angular"
   },
   "dependencies": {
     "cypress-wait-until": "^1.7.2"
   },
+  "peerDependencies": {
+    "cypress": ">=3"
+  },
   "devDependencies": {
     "@argos-ci/cli": "^0.1.2",
     "@argos-ci/cypress": "file:.",

support.js

@@ -54,9 +54,6 @@ function waitUntilNoBusy() {
   );
 }
 
-/**
- * Takes a screenshot for Argos.
- */
 Cypress.Commands.add(
   "argosScreenshot",
   { prevSubject: ["optional", "element", "window", "document"] },
@@ -66,11 +63,10 @@ Cypress.Commands.add(
       name = null;
     }
 
-    const screenshotName = `argos/${name || cy.state("runnable").fullTitle()}`;
     Cypress.log({
       name: "argosScreenshot",
       displayName: `Argos Screenshot`,
-      message: screenshotName,
+      message: name,
     });
     // Inject styles
     cy.document().then((doc) => injectStyles(doc));
@@ -80,7 +76,7 @@ Cypress.Commands.add(
     cy.document().its("fonts.status").should("equal", "loaded");
 
     // Screenshot
-    cy.wrap(subject).screenshot(screenshotName, {
+    cy.wrap(subject).screenshot(name, {
       blackout: ['[data-visual-test="blackout"]'].concat(
         options.blackout || []
       ),