Skip to content

Latest commit

 

History

History
 
 

packages

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

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