test: e2e tests

.github/workflows/ci.yml

@@ -67,14 +67,16 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: 'pnpm'
 
       - name: Install deps
         run: pnpm install
 
-      - name: Run E2E
+      - name: Build docs
         run: pnpm run docs:build:ci
 
+      - name: Run e2e
+        run: pnpm run docs:test:e2e:run
+
   lint:
     runs-on: ubuntu-latest
     name: 'Lint: node-18, ubuntu-latest'

cypress/e2e/api.cy.ts

@@ -0,0 +1,43 @@
+describe('API Test', () => {
+  it('navigates to the api index search', () => {
+    // given
+    cy.visit('/');
+
+    // when
+    cy.get('a').contains('API').click();
+
+    // then
+    cy.url().should('include', '/api/');
+    cy.contains('API Reference');
+  });
+
+  describe('API Reference', () => {
+    beforeEach(() => {
+      // given
+      cy.visit('/api/');
+    });
+
+    it('should at least list more than 7 modules', () => {
+      cy.get('.api-group').should('have.length.above', 7);
+    });
+
+    it('should include at least 1 element in each module', () => {
+      cy.get('.api-group').each(($el) => {
+        cy.wrap($el).get('li a[href]').should('have.length.above', 0);
+      });
+    });
+
+    it('should not have dead links', () => {
+      cy.get('.api-group li').each(($el) => {
+        const text = $el.find('a').text();
+        const link = $el.find('a').attr('href');
+
+        cy.visit(`/api/${link}`);
+
+        cy.get('h2').should('include.text', text);
+        cy.get('h1').should('not.include.text', 'PAGE NOT FOUND');
+        cy.go('back');
+      });
+    });
+  });
+});

cypress/e2e/guide.cy.ts

@@ -0,0 +1,13 @@
+describe('Guide Test', () => {
+  it('navigates to the getting started section', () => {
+    // given
+    cy.visit('/');
+
+    // when
+    cy.get('a').contains('Get Started').click();
+
+    // then
+    cy.url().should('include', '/guide/');
+    cy.contains('Getting Started');
+  });
+});

cypress/tsconfig.json

@@ -1,8 +1,11 @@
 {
   "compilerOptions": {
     "target": "ES5",
-    "lib": ["ES5", "DOM"],
-    "types": ["cypress"]
+    "lib": ["ES2015", "DOM"],
+    "types": ["cypress"],
+    "esModuleInterop": true,
+    "noEmit": true,
+    "resolveJsonModule": true
   },
   "include": ["**/*.ts"]
 }

tsconfig.json

@@ -15,7 +15,8 @@
     // "noImplicitAny": true,
     // "noImplicitThis": true,
     "useUnknownInCatchVariables": true,
-    "stripInternal": true
+    "stripInternal": true,
+    "baseUrl": "."
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules"]