Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Review app to import govuk-frontend via local package #3491

Merged
merged 9 commits into from
May 4, 2023
Merged

Update Review app to import govuk-frontend via local package #3491

merged 9 commits into from
May 4, 2023

Commits on May 4, 2023

  1. Move package into package/dist

    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    b6c7416 View commit details
    Browse the repository at this point in the history

  2. Move src into package/src 

    This is in preparation for the `govuk-frontend` local workspace package to have access to source code, dependencies etc
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    d311d5c View commit details
    Browse the repository at this point in the history

  3. Use wrapper govuk-frontend package for workspaces 

    This change temporarily links `govuk-frontend` to ./package/src via the wrapper package’s package.json `exports` field

For compatibility `npm publish` can continue from ./package/dist where the published package.json still exists with the current `exports` unchanged
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    ebe3101 View commit details
    Browse the repository at this point in the history

  4. Update review app to “Import JavaScript using a bundler” 

    See docs: https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#import-javascript-using-a-bundler
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    d5d7f5d View commit details
    Browse the repository at this point in the history

  5. Move Gulp build tasks into govuk-frontend package

    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    723abb5 View commit details
    Browse the repository at this point in the history

  6. Set up separate scripts, styles, watch tasks etc for package 

    In preparation for build artifacts being deleted, package will need utility tasks to run (on watch) during development
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    c3044f8 View commit details
    Browse the repository at this point in the history

  7. Stop linting package files from review app 

    We ‘ve now split this task into 4x watchers:

1. Lint review app styles
2. Lint review app scripts
3. Build review app styles
4. Build review app scripts

With package getting its own tasks, watchers 1) and 2) no longer need to watch package files

Once the package build output has been removed from source, the review app will only need to watch package “dist” for changes not its entire source code
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    cc0b77a View commit details
    Browse the repository at this point in the history

  8. Move packages into npm workspaces structure 

    Moves `govuk-frontend` and the Review app packages into “packages”

https://docs.npmjs.com/cli/v9/using-npm/workspaces#defining-workspaces
    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    102601e View commit details
    Browse the repository at this point in the history

  9. Add README (and symlinks) to explain src move

    @colinrotherham
    colinrotherham committed May 4, 2023
    Configuration menu
    Copy the full SHA
    6d9eb1a View commit details
    Browse the repository at this point in the history