WSTEAM1-1453 Update imports to resolve all import/no-relative-packages errors

[Louis-Matsika]

Resolves JIRA [1453]

Overall changes

Update imports to fix all occurences of Relative import from another package is not allowed error to help unblock Upgrade eslint-config-airbnb to 19.0.4

list of files that need to be updated as listed in Jira: paper doc

Code changes

for each file listed:
updated import statments to use nextjs module aliases # Instead of relative pathing ../../../

our current aliases are:

      ['#app', './src/app'],
      ['#contexts', './src/app/contexts'],
      ['#components', './src/app/legacy/components'],
      ['#containers', './src/app/legacy/containers'],
      ['#data', './data'],
      ['#hooks', './src/app/hooks'],
      ['#lib', './src/app/lib'],
      ['#psammead', './src/app/legacy/psammead'],
      ['#models', './src/app/models'],
      ['#pages', './src/app/pages'],
      ['#testHelpers', './src/testHelpers'],
      ['#server', './src/server'],
      ['#storybook', './.storybook'],

A new Alias: ['#src', './src'] has been created that should allow access to every file in /src. allowing for some paths that previously couldn’t be updated to now be amended e.g /src/testHelpers

A new Alias: ['#next', './ws-nextjs-app'] has been created that should allow access to every file in /ws-nextjs-app. allowing for some paths that previously couldn’t be updated to now be amended e.g /ws-nextjs-app/pages/[service]/live/[id]/Post/types

Testing

see github checks on this commit, expand the linting checks & search for Relative import from another package is not allowed. no results should come up as these errors should be fixed now

Helpful Links

Add Links to useful resources related to this PR if applicable.

Nextjs module aliases docs

Coding Standards

Repository use guidelines

[Louis-Matsika]

import routes from '.'; seems to need to be above the alias imports from below, however the linter doesn't like this.

To get both the linter passing and path aliasing to work I had to use this command // eslint-disable-next-line import/order

I looked if there are other instances of this exact command in Simorgh, there isn't. but there are many instances of commands similar that start with eslint-disable-next-line…

There is however an instance of a command to disable the import order for a whole file /* eslint-disable import/order */ in src/server/utilities/customMetrics/index.test.ts

The imports from #app and #psammead in this file specifically didn’t get flagged for needing an alias in Karina's PR #12206 that shows where errors for Relative import from another package is not allowed. are. if we don’t want to use this // eslint-disable-next-line import/order workaround we i don’t think we have to. Just thought I’d change them to use aliases anyway.

We could leave these imports as they were previously and I think they still might not show up when linting, as they weren't flagged before?

Don’t know how people feel about this?

[karinathomasbbc]

I have confirmed that upgrading eslint-config-airbnb to 19.0.4 no longer contains any import/no-relative-packages - see https://github.com/bbc/simorgh/actions/runs/12277526136/job/34257105857?pr=12224, expand the linting & search for import/no-relative-packages

I will now revert 374e0da