Skip to content

Commit

Permalink
Merge branch 'main' into test-guidepup-badge
Browse files Browse the repository at this point in the history
  • Loading branch information
mfranzke authored Aug 9, 2024
2 parents d5c7554 + 0e131c4 commit 47696ff
Show file tree
Hide file tree
Showing 17 changed files with 338 additions and 590 deletions.
74 changes: 37 additions & 37 deletions .config/.jscpd.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,57 +4,57 @@
"minTokens": 65,
"ignore": [
".history/**",
"**/__snapshots__/**",
"**/.github/**",
"**/.idea/**",
"**/.next/**",
"**/.nuxt/**",
"**/.output/**",
"**/.vscode/**",
"**/build/**",
"**/public/**",
"**/dist/**",
"**/*-example/index.html",
"**/*-showcase/index.html",
"**/*.spec.tsx",
"**/**config.ts",
"**/angular-*/**/main.ts",
"**/angular.json",
"**/build-outputs/**",
"**/build-showcases/**",
"**/output/**",
"**/node_modules/**",
"**/__snapshots__/**",
"**/test-results/**",
"**/*.spec.tsx",
"**/.next/**",
"**/.github/**",
"**/build/**",
"**/dist/**",
"**/docs/**",
"**/generated/**",
"**/navigation-items.ts",
"**/node_modules/**",
"**/output/**",
"**/patternhub/**/components/**",
"**/*-example/index.html",
"**/*-showcase/index.html",
"**/angular.json",
"**/tsconfig.json",
"**/angular-*/**/main.ts",
"**/playwright-report/**",
"**/public/**",
"**/README.md",
"**/generated/**",
"showcases/shared/*.json",
"showcases/patternhub/out/**",
"showcases/**/results/**",
"**/test-results/**",
"**/tests/**",
"**/tsconfig.json",
"packages/components/src/components/**/*.spec.tsx",
"packages/components/src/components/**/index.html",
"packages/components/src/components/notification/notification.lite.tsx",
"showcases/react-showcase/src/components/notification/index.tsx",
"packages/components/src/components/checkbox/checkbox.lite.tsx",
"showcases/react-showcase/src/components/checkbox/index.tsx",
"packages/components/src/components/notification/notification.lite.tsx",
"packages/components/src/components/radio/radio.lite.tsx",
"showcases/react-showcase/src/components/radio/index.tsx",
"showcases/react-showcase/src/components/radio/index.tsx",
"showcases/react-showcase/src/components/notification/index.tsx",
"showcases/next-showcase/pages/_app.tsx",
"showcases/vue-showcase/src/components/form/Form.vue",
"showcases/angular-showcase/.angular/cache/**",
"showcases/angular-ssr-showcase/.angular/cache/**",
"packages/components/src/components/**/*.spec.tsx",
"packages/components/src/components/tag/tag.spec.tsx",
"**/**config.ts",
"**/navigation-items.ts",
"showcases/angular-showcase/.angular/cache",
"packages/foundations/assets/icons/functional/fonts/**",
"**/playwright-report/**",
"packages/foundations/src",
"**/.output/**",
"**/.nuxt/**",
"showcases/**/results/**",
"showcases/angular-showcase/.angular/cache",
"showcases/angular-showcase/.angular/cache/**",
"showcases/angular-ssr-showcase/.angular/cache/**",
"showcases/next-showcase/pages/_app.tsx",
"showcases/nuxt-showcase/**",
"**/tests/**"
"showcases/patternhub/out/**",
"showcases/react-showcase/src/components/checkbox/index.tsx",
"showcases/react-showcase/src/components/notification/index.tsx",
"showcases/react-showcase/src/components/notification/index.tsx",
"showcases/react-showcase/src/components/radio/index.tsx",
"showcases/react-showcase/src/components/radio/index.tsx",
"showcases/shared/*.json",
"showcases/vue-showcase/src/components/form/Form.vue"
],
"absolute": true
}
22 changes: 22 additions & 0 deletions docs/how-to-develop-a-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,25 @@ We have multiple tests you should update:
2. Showcase Test: `showcases/e2e/my-awesome-component/showcase-my-awesome-component.spec.ts`. Test the styling in a specific framework here and also the functionality/events.

To run all tests/update the screenshots you need `Docker`. More information here: `e2e/README.md`.

## Manually Accessibility Review

After creating a component and writing all test, we need some manually third party accessibility review to prove that the component is stable. This process is internal and will be handled by a team specialized in accessibility testing.
During this process you should track the progress of this manual test inside `showcases/shared/_accessibility-review.json`.
Add a new entry like this:

```json
{
"name": "button",
"status": "REVIEW",
"date": "2023-11-23"
},
```

You should change the `date` prop when the first manual test starts or when it gets any update.

The `status` can be:

- `REVIEW`, if the manual accessibility review should happen
- `PROGRESS`, if there are any open issues after the test
- `DONE`, if the component passed the accessibility review
6 changes: 3 additions & 3 deletions output/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@
"test:components": "playwright test -c playwright.config.ts"
},
"dependencies": {
"vue": "^3.4.36"
"vue": "^3.4.37"
},
"devDependencies": {
"@playwright/experimental-ct-vue": "1.46.0",
"@vitejs/plugin-vue": "^5.1.2",
"replace-in-file": "^8.1.0",
"tsx": "^4.16.5",
"tsx": "^4.17.0",
"typescript": "^5.4.5",
"vite": "^5.3.5",
"vite": "^5.4.0",
"vue-tsc": "^2.0.29"
},
"publishConfig": {
Expand Down
Loading

0 comments on commit 47696ff

Please sign in to comment.