Enhance the structure of our repository

[romaricpascal]

What

We're reorganising the files in our repository to have a better to work with. See the issues for details about each move and its reason.

Why

A better structure for our repository allows us to:

• acknowledge its monorepo nature (having both our library and the review app, alongside various helpers),
• provide better isolation between the different parts of the project
• avoid future breaking changes should we need dependencies
• limit our use of relative paths when importing from each part of the project.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

v5

Beta Give feedback

1. Split project into separate app, config, lib and tasks packages #2886
   assurance consistency interoperability +3
2. Move src and built package files under the same package #3547
   4 of 4
   tooling +1
3. Make the review app consume govuk-frontend #3548
   2 of 2
   +0
4. Make sure the docs folder is up to date with new structure #3639
   3 of 3
   +0
   

Future changes

Beta Give feedback

1. Add default “npm run build” for project (with docs updates) #3725
   documentation tooling +2
2. Remove built govuk-frontend from committed files #3498
   consistency dependencies interoperability +3
   
3. Investigate using the packages folder convention #3490
   consistency +1
   

[colinrotherham]

Does committing ./package let other projects clone the repo (or use git submodules) to pull govuk-frontend and have all the files, pre-built, ready to go without needing an npm install or extra build steps?

• Namespace exports with 'govuk' #732
• Namespace nunjucks and components #1458

Can see a bit of history in older releases:

• Release v0.0.32 #791

<script src="{path-to-govuk-frontend}/all.js"></script>
<script>window.GOVUKFrontend.initAll()</script>

☝️ This release has details about the old namespaced package @govuk-frontend/frontend

[romaricpascal]

Didn't think of cloning/submodules to access the source (and cheers for the issue archeology 😄).

That said, cloning govuk-frontend (or using it as submodule) to access package may not give you what you expect. If you clone main at the moment, you'll get the package from the last release, not the package corresponding to the source in main.

[romaricpascal]

Linking #2886 to keep track of the related ongoing discussions around the reorganisation of ther repo :)