accessibility-insights-web/packages
v-rakeshsh e9029ed13c
Breaking Change: migrate to node v20 (#7457)
#### Details

Update the code node version to node 20.x.x version. As lot of other
packages are using or going to use Node 20.x.x.

#### Pull request checklist
<!-- If a checklist item is not applicable to this change, write "n/a"
in the checkbox -->
- [ ] Addresses an existing issue: #0000
- [x] Ran `yarn fastpass`
- [x] Added/updated relevant unit test(s) (and ran `yarn test`)
- [x] Verified code coverage for the changes made. Check coverage report
at: `<rootDir>/test-results/unit/coverage`
- [x] PR title *AND* final merge commit title both start with a semantic
tag (`fix:`, `chore:`, `feat(feature-name):`, `refactor:`). See
`CONTRIBUTING.md`.
- [ ] (UI changes only) Added screenshots/GIFs to description above
- [ ] (UI changes only) Verified usability with NVDA/JAWS
2025-01-06 15:37:51 -05:00
..
axe-config chore: migrate to yarn v3 (#6519) 2023-03-22 17:19:17 -04:00
report Breaking Change: migrate to node v20 (#7457) 2025-01-06 15:37:51 -05:00
report-e2e-tests chore(deps-dev): Bump jest-file-snapshot from 0.5.0 to 0.7.0 (#7489) 2024-12-20 14:20:31 -05:00
ui Breaking Change: migrate to node v20 (#7457) 2025-01-06 15:37:51 -05:00
validator chore: migrate to yarn v3 (#6519) 2023-03-22 17:19:17 -04:00
README.md feat(remove-android): Update docs (#6755) 2023-06-23 15:38:29 -07:00

README.md

accessibility-insights-web packages

As of Oct 2020, this repository is an ad-hoc monorepo; /src contains code for multiple projects, and does not separate them as cleanly as we would like.

We plan to gradually convert the repository into a Yarn Workspaces based monorepo, similar to how accessibility-insights-service is structured.

Short-term (~Dec 2020) planned package layout

At minimum, we plan to use individual packages for each individually released project:

  • /packages/report: accessibility-insights-report (NPM package, primarily for consumption by accessibility-insights-service)
  • /packages/ui: accessibility-insights-ui (NPM package, primarily for consumption by accessibilityinsights.io)
  • /packages/web: Accessibility Insights for Web (browser extension)

We plan to move end-to-end tests of packages into separate packages, to better test "true" package API boundaries. For example:

  • /packages/report-e2e-tests: End-to-end tests of the report package APIs

Longer term (2021+) plans

Eventually, we could imagine wanting to combine accessibility-insights-service and accessibility-insights-web into one monorepo; we aren't sure whether we necessarily want to do this or not, but in the interest of keeping it easy, we want to lean towards using consistent decisions between the two of them for "directory layout", "which tools run repo-wide vs per-package", etc.

Current (July 2021) package layout

  • /packages/ui: current home of former /src/packages/accessibility-insights-ui/root
  • /packages/report: current home of former /src/reports/package/root
  • /package.json//src: current home of web and most of the build rules for ui/report