Enforce relative imports when importing from core (#1616)

* Use relative imports instead of aliasing to core

* Changeset

.changeset/stupid-gifts-grab.md

@@ -0,0 +1,5 @@
+---
+'@guardian/commercial': minor
+---
+
+Use relative imports when importing from core

.eslintrc.js

@@ -19,6 +19,18 @@ module.exports = {
 		'no-use-before-define': ['error', { functions: true, classes: true }],
 		'import/exports-last': 'error',
 		'no-else-return': 'error',
+		'no-restricted-imports': [
+			'error',
+			{
+				patterns: [
+					{
+						group: ['core/*'],
+						message:
+							'Paths starting with “core”, are forbidden. Please use a relative path instead',
+					},
+				],
+			},
+		],
 	},
 	overrides: [
 		{

playwright/tests/merchandising-high.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@playwright/test';
-import { isDefined } from 'core/types';
+import { isDefined } from '../../src/core/types';
 import { breakpoints } from '../fixtures/breakpoints';
 import { articles, blogs } from '../fixtures/pages';
 import type { GuPage } from '../fixtures/pages/Page';

playwright/tests/merchandising.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@playwright/test';
-import { isDefined } from 'core/types';
+import { isDefined } from '../../src/core/types';
 import { breakpoints } from '../fixtures/breakpoints';
 import { articles, blogs } from '../fixtures/pages';
 import type { GuPage } from '../fixtures/pages/Page';

playwright/tests/mostpop.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@playwright/test';
-import { isDefined } from 'core/types';
+import { isDefined } from '../../src/core/types';
 import { testAtBreakpoints } from '../fixtures/breakpoints';
 import { articles, blogs } from '../fixtures/pages';
 import type { GuPage } from '../fixtures/pages/Page';

src/core/lib/video-interscroller-progress.ts

@@ -1,5 +1,5 @@
 import { once } from 'lodash-es';
-import { checkConsent as checkConsentForReporting } from 'core/send-commercial-metrics';
+import { checkConsent as checkConsentForReporting } from '../send-commercial-metrics';
 
 const endpoint = window.guardian.config.page.isDev
 	? '//logs.code.dev-guardianapis.com/log'

src/core/messenger/background.ts

@@ -1,14 +1,14 @@
 import { isObject } from '@guardian/libs';
-import {
-	initVideoProgressReporting,
-	updateVideoProgress,
-} from 'core/lib/video-interscroller-progress';
-import type { RegisterListener } from 'core/messenger';
 import fastdom from 'utils/fastdom-promise';
 import {
 	renderAdvertLabel,
 	renderStickyScrollForMoreLabel,
 } from '../../events/render-advert-label';
+import {
+	initVideoProgressReporting,
+	updateVideoProgress,
+} from '../lib/video-interscroller-progress';
+import type { RegisterListener } from '../messenger';
 
 const isGallery = window.guardian.config.page.contentType === 'Gallery';
 

src/core/messenger/disable-refresh.ts

@@ -1,5 +1,5 @@
-import type { RegisterListener } from 'core/messenger';
 import { dfpEnv } from '../../lib/dfp/dfp-env';
+import type { RegisterListener } from '../messenger';
 
 // This message is intended to be used with a DFP creative wrapper.
 // For reference, the wrapper will post a message, with an iFrameId, like so:

src/core/messenger/full-width.ts

@@ -1,6 +1,6 @@
 import { isBoolean } from '@guardian/libs';
 import fastdom from 'fastdom';
-import type { RegisterListener } from 'core/messenger';
+import type { RegisterListener } from '../messenger';
 
 const fullWidth = (fullWidth: boolean, slotContainer: HTMLElement) =>
 	fastdom.mutate(() => {

src/core/messenger/get-page-targeting.ts

@@ -1,4 +1,4 @@
-import type { RegisterListener } from 'core/messenger';
+import type { RegisterListener } from '../messenger';
 
 /**
  * Register a listener for iframes to request shared ad targeting

src/core/messenger/get-page-url.ts

@@ -1,4 +1,4 @@
-import type { RegisterListener } from 'core/messenger';
+import type { RegisterListener } from '../messenger';
 
 const init = (register: RegisterListener): void => {
 	register(

src/core/messenger/get-stylesheet.ts

@@ -1,5 +1,5 @@
 import { isObject } from '@guardian/libs';
-import type { RegisterListener } from 'core/messenger';
+import type { RegisterListener } from '../messenger';
 
 interface StylesheetSpecs {
 	selector: string;

src/core/messenger/measure-ad-load.ts

@@ -1,6 +1,6 @@
 import { isObject, isString } from '@guardian/libs';
-import { EventTimer } from 'core/event-timer';
-import type { RegisterListener } from 'core/messenger';
+import { EventTimer } from '../event-timer';
+import type { RegisterListener } from '../messenger';
 
 // This message is intended to be used with a GAM creative wrapper.
 // For reference, the wrapper will post a message, like so:

src/core/messenger/passback-refresh.ts

@@ -1,7 +1,7 @@
 import { isString } from '@guardian/libs';
-import type { RegisterListener } from 'core/messenger';
 import { refreshAdvert } from '../../display/load-advert';
 import { getAdvertById } from '../../lib/dfp/get-advert-by-id';
+import type { RegisterListener } from '../messenger';
 
 const passbackRefresh = (specs: string, adSlot: HTMLElement) => {
 	const advert = getAdvertById(adSlot.id);

src/core/messenger/passback.ts

@@ -1,11 +1,11 @@
 import { log } from '@guardian/libs';
 import { breakpoints } from '@guardian/source/foundations';
-import { adSizes } from 'core/ad-sizes';
-import type { RegisterListener } from 'core/messenger';
 import { getCurrentBreakpoint } from 'lib/detect/detect-breakpoint';
 import { getAdvertById } from 'lib/dfp/get-advert-by-id';
 import fastdom from 'utils/fastdom-promise';
 import { adSlotIdPrefix } from '../../lib/dfp/dfp-env-globals';
+import { adSizes } from '../ad-sizes';
+import type { RegisterListener } from '../messenger';
 
 type PassbackMessagePayload = { source: string };
 

src/core/messenger/resize.ts

@@ -1,6 +1,6 @@
 import { isObject, isString } from '@guardian/libs';
-import type { RegisterListener } from 'core/messenger';
 import fastdom from 'utils/fastdom-promise';
+import type { RegisterListener } from '../messenger';
 
 interface Styles {
 	width?: string;

src/core/messenger/scroll.ts

@@ -1,8 +1,8 @@
-import type { RegisterListener } from 'core/messenger';
 import type { Viewport } from 'lib/detect/detect-viewport';
 import { getViewport } from 'lib/detect/detect-viewport';
 import { addEventListener } from 'lib/events';
 import fastdom from 'utils/fastdom-promise';
+import type { RegisterListener } from '../messenger';
 
 type Respond = (...args: unknown[]) => void;
 

src/core/messenger/type.ts

@@ -1,6 +1,6 @@
 import { isString } from '@guardian/libs';
-import type { RegisterListener } from 'core/messenger';
 import fastdom from 'utils/fastdom-promise';
+import type { RegisterListener } from '../messenger';
 
 const setType = (adSlotType: string, adSlot: Element) =>
 	fastdom.mutate(() => {

src/core/messenger/viewport.ts

@@ -1,7 +1,7 @@
-import type { RegisterPersistentListener, RespondProxy } from 'core/messenger';
 import { getViewport } from 'lib/detect/detect-viewport';
 import type { Viewport } from 'lib/detect/detect-viewport';
 import fastdom from 'utils/fastdom-promise';
+import type { RegisterPersistentListener, RespondProxy } from '../messenger';
 
 type IFrameMapValue = {
 	node: HTMLIFrameElement;

src/define/Advert.spec.ts

@@ -1,5 +1,5 @@
-import type * as AdSizesType from 'core/ad-sizes';
-import { slotSizeMappings as slotSizeMappings_ } from 'core/ad-sizes';
+import type * as AdSizesType from '../core/ad-sizes';
+import { slotSizeMappings as slotSizeMappings_ } from '../core/ad-sizes';
 import { _, Advert, findSmallestAdHeightForSlot } from './Advert';
 
 const { getSlotSizeMapping } = _;

src/define/Advert.ts

@@ -1,13 +1,13 @@
 import { breakpoints as sourceBreakpoints } from '@guardian/source/foundations';
-import type { AdSize, SizeMapping, SlotName } from 'core/ad-sizes';
+import fastdom from 'utils/fastdom-promise';
 import {
 	createAdSize,
 	findAppliedSizesForBreakpoint,
 	slotSizeMappings,
-} from 'core/ad-sizes';
-import { concatSizeMappings } from 'core/create-ad-slot';
-import type { Breakpoint } from 'core/lib/breakpoint';
-import fastdom from 'utils/fastdom-promise';
+} from '../core/ad-sizes';
+import type { AdSize, SizeMapping, SlotName } from '../core/ad-sizes';
+import { concatSizeMappings } from '../core/create-ad-slot';
+import type { Breakpoint } from '../core/lib/breakpoint';
 import { breakpointNameToAttribute } from '../lib/breakpoint-name-to-attribute';
 import type { HeaderBiddingSize } from '../lib/header-bidding/prebid-types';
 import { buildGoogletagSizeMapping, defineSlot } from './define-slot';

src/define/create-advert.ts

@@ -1,5 +1,5 @@
 import { log } from '@guardian/libs';
-import type { SizeMapping } from 'core/ad-sizes';
+import type { SizeMapping } from '../core/ad-sizes';
 import { reportError } from '../utils/report-error';
 import { Advert } from './Advert';
 

src/define/define-slot.spec.ts

@@ -1,6 +1,6 @@
-import type { SizeMapping } from 'core/ad-sizes';
-import { adSizes, createAdSize } from 'core/ad-sizes';
 import { toGoogleTagSize } from 'utils/googletag-ad-size';
+import type { SizeMapping } from '../core/ad-sizes';
+import { adSizes, createAdSize } from '../core/ad-sizes';
 import {
 	buildGoogletagSizeMapping,
 	collectSizes,

src/define/define-slot.ts

@@ -1,9 +1,9 @@
 import { breakpoints as sourceBreakpoints } from '@guardian/source/foundations';
 import { once } from 'lodash-es';
 import { EventTimer } from 'core';
-import type { SizeMapping, SlotName } from 'core/ad-sizes';
 import { toGoogleTagSize } from 'utils/googletag-ad-size';
 import { getUrlVars } from 'utils/url';
+import type { SizeMapping, SlotName } from '../core/ad-sizes';
 import { initSlotIas } from './init-slot-ias';
 
 const breakpointViewports: Record<keyof SizeMapping, [number, number]> = {

src/display/load-advert.ts

@@ -1,5 +1,5 @@
 import fastdom from 'fastdom';
-import { EventTimer } from 'core/event-timer';
+import { EventTimer } from '../core/event-timer';
 import type { Advert } from '../define/Advert';
 import { stripDfpAdPrefixFrom } from '../lib/header-bidding/utils';
 import { refreshBidsForAd, requestBidsForAd } from './request-bids';

src/display/request-bids.ts

@@ -1,4 +1,4 @@
-import type { AdSize } from 'core/ad-sizes';
+import type { AdSize } from '../core/ad-sizes';
 import type { Advert } from '../define/Advert';
 import { a9 } from '../lib/header-bidding/a9/a9';
 import { prebid } from '../lib/header-bidding/prebid/prebid';

src/events/on-slot-load.ts

@@ -1,4 +1,4 @@
-import { postMessage } from 'core/messenger/post-message';
+import { postMessage } from '../core/messenger/post-message';
 import { getAdvertById } from '../lib/dfp/get-advert-by-id';
 
 const host = `${window.location.protocol}//${window.location.host}`;

src/events/on-slot-render.ts

@@ -1,6 +1,6 @@
 import { isString } from '@guardian/libs';
-import type { AdSize } from 'core/ad-sizes';
-import { createAdSize } from 'core/ad-sizes';
+import type { AdSize } from '../core/ad-sizes';
+import { createAdSize } from '../core/ad-sizes';
 import { getAdvertById } from '../lib/dfp/get-advert-by-id';
 import { reportError } from '../utils/report-error';
 import { emptyAdvert } from './empty-advert';

src/events/on-slot-viewable.ts

@@ -1,9 +1,9 @@
 import { log } from '@guardian/libs';
 import { EventTimer } from 'core';
-import { outstreamSizes } from 'core/ad-sizes';
-import { AD_LABEL_HEIGHT } from 'core/constants/ad-label-height';
 import fastdom from 'utils/fastdom-promise';
 import { getUrlVars } from 'utils/url';
+import { outstreamSizes } from '../core/ad-sizes';
+import { AD_LABEL_HEIGHT } from '../core/constants/ad-label-height';
 import type { Advert } from '../define/Advert';
 import { isAdSize } from '../define/Advert';
 import { enableLazyLoad } from '../display/lazy-load';

src/events/render-advert.ts

@@ -1,6 +1,6 @@
-import { adSizes } from 'core/ad-sizes';
 import { $$ } from 'utils/$$';
 import fastdom from 'utils/fastdom-promise';
+import { adSizes } from '../core/ad-sizes';
 import type { Advert } from '../define/Advert';
 import { getAdIframe } from '../lib/dfp/get-ad-iframe';
 import { reportError } from '../utils/report-error';

src/experiments/utils.ts

@@ -1,5 +1,5 @@
 import { bypassCoreWebVitalsSampling } from '@guardian/core-web-vitals';
-import { bypassCommercialMetricsSampling } from 'core/send-commercial-metrics';
+import { bypassCommercialMetricsSampling } from '../core/send-commercial-metrics';
 
 export const bypassMetricsSampling = (): void => {
 	void bypassCommercialMetricsSampling();

src/init/consented.ts

@@ -1,5 +1,4 @@
 import { log } from '@guardian/libs';
-import { EventTimer } from 'core/event-timer';
 import { adFreeSlotRemove } from 'init/consented/ad-free-slot-remove';
 import { init as initComscore } from 'init/consented/comscore';
 import { initFillSlotListener } from 'init/consented/fill-slot-listener';
@@ -19,6 +18,7 @@ import { init as setAdTestInLabelsCookie } from 'init/shared/set-adtest-in-label
 import { init as prepareAdVerification } from 'lib/ad-verification/prepare-ad-verification';
 import { commercialFeatures } from 'lib/commercial-features';
 import { adSlotIdPrefix } from 'lib/dfp/dfp-env-globals';
+import { EventTimer } from '../core/event-timer';
 import { reportError } from '../utils/report-error';
 import { catchErrorsAndReport } from '../utils/robust';
 import { initDfpListeners } from './consented/dfp-listeners';

src/init/consented/ipsos-mori.ts

@@ -5,7 +5,7 @@ import {
 	log,
 	onConsent,
 } from '@guardian/libs';
-import { ipsosMoriStub } from 'core/__vendor/ipsos-mori';
+import { ipsosMoriStub } from '../../core/__vendor/ipsos-mori';
 
 const loadIpsosScript = (locale: 'au' | 'uk') => {
 	ipsosMoriStub();

src/init/consented/messenger.ts

@@ -1,17 +1,17 @@
-import { init as initMessenger } from 'core/messenger';
-import { init as background } from 'core/messenger/background';
-import { init as disableRefresh } from 'core/messenger/disable-refresh';
-import { init as fullwidth } from 'core/messenger/full-width';
-import { init as initGetPageTargeting } from 'core/messenger/get-page-targeting';
-import { init as initGetPageUrl } from 'core/messenger/get-page-url';
-import { init as getStyles } from 'core/messenger/get-stylesheet';
-import { init as initMeasureAdLoad } from 'core/messenger/measure-ad-load';
-import { init as passback } from 'core/messenger/passback';
-import { init as passbackRefresh } from 'core/messenger/passback-refresh';
-import { init as resize } from 'core/messenger/resize';
-import { init as scroll } from 'core/messenger/scroll';
-import { init as type } from 'core/messenger/type';
-import { init as viewport } from 'core/messenger/viewport';
+import { init as initMessenger } from '../../core/messenger';
+import { init as background } from '../../core/messenger/background';
+import { init as disableRefresh } from '../../core/messenger/disable-refresh';
+import { init as fullwidth } from '../../core/messenger/full-width';
+import { init as initGetPageTargeting } from '../../core/messenger/get-page-targeting';
+import { init as initGetPageUrl } from '../../core/messenger/get-page-url';
+import { init as getStyles } from '../../core/messenger/get-stylesheet';
+import { init as initMeasureAdLoad } from '../../core/messenger/measure-ad-load';
+import { init as passback } from '../../core/messenger/passback';
+import { init as passbackRefresh } from '../../core/messenger/passback-refresh';
+import { init as resize } from '../../core/messenger/resize';
+import { init as scroll } from '../../core/messenger/scroll';
+import { init as type } from '../../core/messenger/type';
+import { init as viewport } from '../../core/messenger/viewport';
 
 /**
  * Messenger gets to skip the promise chain and run immediately.

src/init/consented/prepare-a9.ts

@@ -1,9 +1,9 @@
 import { getConsentFor, log, onConsent } from '@guardian/libs';
 import { once } from 'lodash-es';
-import { a9Apstag } from 'core/__vendor/a9-apstag';
 import { commercialFeatures } from 'lib/commercial-features';
 import { isGoogleProxy } from 'lib/detect/detect-google-proxy';
 import { isInCanada } from 'utils/geo-utils';
+import { a9Apstag } from '../../core/__vendor/a9-apstag';
 import { a9 } from '../../lib/header-bidding/a9/a9';
 import { shouldIncludeOnlyA9 } from '../../lib/header-bidding/utils';
 

src/init/consented/prepare-googletag.spec.ts

@@ -1,9 +1,9 @@
 import type { ConsentState, USNATConsentState } from '@guardian/libs';
 import { getConsentFor, loadScript, onConsent } from '@guardian/libs';
-import type * as AdSizesType from 'core/ad-sizes';
 import { commercialFeatures } from 'lib/commercial-features';
 import _config from 'lib/config';
 import { getCurrentBreakpoint as getCurrentBreakpoint_ } from 'lib/detect/detect-breakpoint';
+import type * as AdSizesType from '../../core/ad-sizes';
 import { loadAdvert } from '../../display/load-advert';
 import { dfpEnv } from '../../lib/dfp/dfp-env';
 import { init as prepareGoogletag } from './prepare-googletag';

src/init/consented/prepare-googletag.ts

@@ -1,9 +1,9 @@
 import type { ConsentState } from '@guardian/libs';
 import { getConsentFor, loadScript, log, onConsent } from '@guardian/libs';
-import { EventTimer } from 'core/event-timer';
 import { getPageTargeting } from 'lib/build-page-targeting';
 import { commercialFeatures } from 'lib/commercial-features';
 import { getGoogleTagId, isUserLoggedInOktaRefactor } from 'lib/identity/api';
+import { EventTimer } from '../../core/event-timer';
 import { removeSlots } from './remove-slots';
 import { fillStaticAdvertSlots } from './static-ad-slots';
 

src/init/consented/prepare-permutive.ts

@@ -1,5 +1,5 @@
-import type { Edition } from 'core/types';
 import type { Config, PageConfig, Permutive, UserConfig } from 'types/global';
+import type { Edition } from '../../core/types';
 import { reportError } from '../../utils/report-error';
 
 interface PermutivePageConfig {

src/init/consented/static-ad-slots.ts

@@ -1,13 +1,13 @@
 import { isNonNullable, log } from '@guardian/libs';
-import type { SizeMapping } from 'core/ad-sizes';
-import { adSizes, createAdSize } from 'core/ad-sizes';
 import { isUserInVariant } from 'experiments/ab';
 import { mpuWhenNoEpic } from 'experiments/tests/mpu-when-no-epic';
 import { setupPrebidOnce } from 'init/consented/prepare-prebid';
 import { removeDisabledSlots } from 'init/consented/remove-slots';
 import { commercialFeatures } from 'lib/commercial-features';
 import { getCurrentBreakpoint } from 'lib/detect/detect-breakpoint';
 import { isInUk, isInUsa } from 'utils/geo-utils';
+import { adSizes, createAdSize } from '../../core/ad-sizes';
+import type { SizeMapping } from '../../core/ad-sizes';
 import { createAdvert } from '../../define/create-advert';
 import { displayAds } from '../../display/display-ads';
 import { displayLazyAds } from '../../display/display-lazy-ads';