Skip to content

Commit

Permalink
Rename format.ts To articleFormat.ts (#12566)
Browse files Browse the repository at this point in the history
This matches the filename to the type, which is `ArticleFormat`.
  • Loading branch information
JamieB-gu authored Oct 17, 2024
1 parent 3029907 commit 651c255
Show file tree
Hide file tree
Showing 312 changed files with 441 additions and 361 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
ArticleFormat,
ArticleSpecial,
Pillar,
} from '../../src/lib/format';
} from '../../src/lib/articleFormat';
import {
palette as sourcePalette,
space,
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/.storybook/decorators/themeDecorator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
type StoryContext,
type StrictArgs,
} from '@storybook/react';
import { ArticleFormat } from '../../src/lib/format';
import { ArticleFormat } from '../../src/lib/articleFormat';
import type { CSSProperties } from 'react';

const darkStoryCss = css`
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/.storybook/mocks/paletteDeclarations.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ArticleFormat } from '../../src/lib/format';
import { ArticleFormat } from '../../src/lib/articleFormat';
import { paletteDeclarations } from '../../src/palette';

/**
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/.storybook/toolbar/globalColourScheme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
ArticleDesign,
Pillar,
type ArticleFormat,
} from '../../src/lib/format';
} from '../../src/lib/articleFormat';

const defaultFormat: ArticleFormat = {
display: ArticleDisplay.Standard,
Expand Down
6 changes: 5 additions & 1 deletion dotcom-rendering/fixtures/manual/guideAtom.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { ArticleDesign, ArticleDisplay, Pillar } from '../../src/lib/format';
import {
ArticleDesign,
ArticleDisplay,
Pillar,
} from '../../src/lib/articleFormat';

export const defaultStoryExpanded = {
id: 'a76d998e-d4b0-4d00-8afb-773eddb4064c',
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/fixtures/manual/key-events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {
ArticleDisplay,
type ArticleFormat,
Pillar,
} from '../../src/lib/format';
} from '../../src/lib/articleFormat';

export interface KeyEventCard {
id: string;
Expand Down
6 changes: 5 additions & 1 deletion dotcom-rendering/fixtures/manual/trails-nav.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { ArticleDesign, ArticleDisplay, Pillar } from '../../src/lib/format';
import {
ArticleDesign,
ArticleDisplay,
Pillar,
} from '../../src/lib/articleFormat';
import type { TrailType } from '../../src/types/trails';

export const trails: [
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/fixtures/manual/trails.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {
ArticleDisplay,
type ArticleFormat,
Pillar,
} from '../../src/lib/format';
} from '../../src/lib/articleFormat';
import type { DCRFrontCard } from '../../src/types/front';
import { discussionApiUrl } from './discussionApiUrl';

Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/scripts/gen-stories/get-stories.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const CARD_TEMPLATE_HEADER = `
import { splitTheme } from '../../.storybook/decorators/splitThemeDecorator';
import { CardsWithDifferentThemes } from '../../src/components/Card/Card.stories';
import { ArticleDesign, ArticleDisplay, ArticleSpecial, Pillar } from '../../src/lib/format';
import { ArticleDesign, ArticleDisplay, ArticleSpecial, Pillar } from '../../src/lib/articleFormat';
// eslint-disable-next-line import/no-default-export -- we need a default here
export default {
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/AdSlot.web.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
until,
} from '@guardian/source/foundations';
import { Hide } from '@guardian/source/react-components';
import { ArticleDisplay } from '../lib/format';
import { ArticleDisplay } from '../lib/articleFormat';
import { getZIndex } from '../lib/getZIndex';
import { LABS_HEADER_HEIGHT } from '../lib/labs-constants';
import { palette as schemedPalette } from '../palette';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Global } from '@emotion/react';
import { StrictMode } from 'react';
import { AllEditorialNewslettersPageLayout } from '../layouts/AllEditorialNewslettersPageLayout';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { rootStyles } from '../lib/rootStyles';
import type { NavType } from '../model/extract-nav';
import type { DCRNewslettersPageType } from '../types/newslettersPage';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Answers.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { css } from '@emotion/react';
import { Radio, RadioGroup } from '@guardian/source/react-components';
import type { Meta, StoryObj } from '@storybook/react';
import { splitTheme } from '../../.storybook/decorators/splitThemeDecorator';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import {
CorrectSelectedAnswer,
IncorrectAnswer,
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Answers.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
textSans17,
} from '@guardian/source/foundations';
import { SvgCheckmark, SvgCross } from '@guardian/source/react-components';
import { ArticleSpecial, type ArticleTheme } from '../lib/format';
import { ArticleSpecial, type ArticleTheme } from '../lib/articleFormat';
import { palette as schemedPalette } from '../palette';

// We export Radio wrapper styles to override Source Radio buttons to align
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Meta, StoryObj } from '@storybook/react';
import { splitTheme } from '../../.storybook/decorators/splitThemeDecorator';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { AppsEpic as AppsEpicComponent } from './AppsEpic.importable';

const meta = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Meta, StoryObj } from '@storybook/react';
import { splitTheme } from '../../.storybook/decorators/splitThemeDecorator';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { AppsFooter as AppsFooterComponent } from './AppsFooter.importable';

const meta = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { css } from '@emotion/react';
import type { ArticleFormat } from '../lib/format';
import type { ArticleFormat } from '../lib/articleFormat';
import { type RoleType } from '../types/content';
import { openLightboxForImageId } from './AppsLightboxImageStore.importable';
import type { Loading } from './CardPicture';
Expand Down
6 changes: 3 additions & 3 deletions dotcom-rendering/src/components/ArticleBody.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import {
remSpace,
textEgyptian17,
} from '@guardian/source/foundations';
import { ArticleRenderer } from '../lib/ArticleRenderer';
import type { EditionId } from '../lib/edition';
import {
ArticleDesign,
ArticleDisplay,
type ArticleFormat,
} from '../lib/format';
} from '../lib/articleFormat';
import { ArticleRenderer } from '../lib/ArticleRenderer';
import type { EditionId } from '../lib/edition';
import { decideLanguage, decideLanguageDirection } from '../lib/lang';
import { revealStyles } from '../lib/revealStyles';
import { palette as themePalette } from '../palette';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticleContainer.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { css } from '@emotion/react';
import { adSizes, constants } from '@guardian/commercial';
import { from, space, until } from '@guardian/source/foundations';
import { ArticleDesign, type ArticleFormat } from '../lib/format';
import { ArticleDesign, type ArticleFormat } from '../lib/articleFormat';
import { palette } from '../palette';
import { carrotAdStyles, labelStyles } from './AdSlot.web';

Expand Down
5 changes: 3 additions & 2 deletions dotcom-rendering/src/components/ArticleHeadline.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ import {
ArticleDesign,
ArticleDisplay,
ArticleSpecial,
formatToString,
getAllThemes,
Pillar,
} from '../lib/format';
import { formatToString, getAllThemes } from '../lib/format';
} from '../lib/articleFormat';
import { palette } from '../palette';
import { ArticleHeadline } from './ArticleHeadline';
import { Standfirst } from './Standfirst';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticleHeadline.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
type ArticleFormat,
ArticleSpecial,
Pillar,
} from '../lib/format';
} from '../lib/articleFormat';
import { getZIndex } from '../lib/getZIndex';
import { palette as themePalette } from '../palette';
import type { TagType } from '../types/tag';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { css } from '@emotion/react';
import type { Meta, StoryObj } from '@storybook/react';
import { allModes } from '../../.storybook/modes';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { palette } from '../palette';
import { ArticleLastUpdated } from './ArticleLastUpdated';

Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticleLastUpdated.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { css } from '@emotion/react';
import { timeAgo } from '@guardian/libs';
import { textSans15, textSansBold15 } from '@guardian/source/foundations';
import { ArticleDesign, type ArticleFormat } from '../lib/format';
import { ArticleDesign, type ArticleFormat } from '../lib/articleFormat';
import { palette } from '../palette';
import { Island } from './Island';
import { PulsingDot } from './PulsingDot.importable';
Expand Down
8 changes: 6 additions & 2 deletions dotcom-rendering/src/components/ArticleMeta.apps.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@ import type { Meta, StoryObj } from '@storybook/react';
import { leftColumnDecorator } from '../../.storybook/decorators/gridDecorators';
import { defaultFormats } from '../../.storybook/decorators/splitThemeDecorator';
import { allModes } from '../../.storybook/modes';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { getAllThemes } from '../lib/format';
import {
ArticleDesign,
ArticleDisplay,
getAllThemes,
Pillar,
} from '../lib/articleFormat';
import { ArticleMetaApps } from './ArticleMeta.apps';

const meta = {
Expand Down
7 changes: 5 additions & 2 deletions dotcom-rendering/src/components/ArticleMeta.apps.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ import { from, space, until } from '@guardian/source/foundations';
import { StraightLines } from '@guardian/source-development-kitchen/react-components';
import type { ReactNode } from 'react';
import { interactiveLegacyClasses } from '../layouts/lib/interactiveLegacyStyling';
import {
ArticleDesign,
ArticleDisplay,
type ArticleFormat,
} from '../lib/articleFormat';
import { getSoleContributor } from '../lib/byline';
import { ArticleDesign, ArticleDisplay } from '../lib/format';
import type { ArticleFormat } from '../lib/format';
import { palette as themePalette } from '../palette';
import type { Branding as BrandingType } from '../types/branding';
import type { TagType } from '../types/tag';
Expand Down
8 changes: 6 additions & 2 deletions dotcom-rendering/src/components/ArticleMeta.web.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ import type { Meta, StoryObj } from '@storybook/react';
import { leftColumnDecorator } from '../../.storybook/decorators/gridDecorators';
import { defaultFormats } from '../../.storybook/decorators/splitThemeDecorator';
import { allModes } from '../../.storybook/modes';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { getAllThemes } from '../lib/format';
import {
ArticleDesign,
ArticleDisplay,
getAllThemes,
Pillar,
} from '../lib/articleFormat';
import { palette } from '../palette';
import { ArticleMeta } from './ArticleMeta.web';

Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticleMeta.web.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { render } from '@testing-library/react';
import { interactiveLegacyClasses } from '../layouts/lib/interactiveLegacyStyling';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { ArticleMeta, shouldShowContributor } from './ArticleMeta.web';
import { ConfigProvider } from './ConfigContext';

Expand Down
4 changes: 2 additions & 2 deletions dotcom-rendering/src/components/ArticleMeta.web.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import { css } from '@emotion/react';
import { between, from, space, until } from '@guardian/source/foundations';
import { StraightLines } from '@guardian/source-development-kitchen/react-components';
import { interactiveLegacyClasses } from '../layouts/lib/interactiveLegacyStyling';
import { getSoleContributor } from '../lib/byline';
import {
ArticleDesign,
ArticleDisplay,
type ArticleFormat,
ArticleSpecial,
} from '../lib/format';
} from '../lib/articleFormat';
import { getSoleContributor } from '../lib/byline';
import { palette as themePalette } from '../palette';
import type { Branding as BrandingType } from '../types/branding';
import type { TagType } from '../types/tag';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticlePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Global } from '@emotion/react';
import { StrictMode } from 'react';
import { DecideLayout } from '../layouts/DecideLayout';
import { buildAdTargeting } from '../lib/ad-targeting';
import { ArticleDesign, type ArticleFormat } from '../lib/format';
import { ArticleDesign, type ArticleFormat } from '../lib/articleFormat';
import { rootStyles } from '../lib/rootStyles';
import { filterABTestSwitches } from '../model/enhance-switches';
import type { NavType } from '../model/extract-nav';
Expand Down
4 changes: 2 additions & 2 deletions dotcom-rendering/src/components/ArticleTitle.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import {
ArticleDesign,
ArticleDisplay,
ArticleSpecial,
getAllThemes,
Pillar,
} from '../lib/format';
import { getAllThemes } from '../lib/format';
} from '../lib/articleFormat';
import { ArticleTitle } from './ArticleTitle';

const meta = {
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/ArticleTitle.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { css } from '@emotion/react';
import { from } from '@guardian/source/foundations';
import { ArticleDisplay, type ArticleFormat } from '../lib/format';
import { ArticleDisplay, type ArticleFormat } from '../lib/articleFormat';
import type { TagType } from '../types/tag';
import { SeriesSectionLink } from './SeriesSectionLink';

Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Avatar.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
ArticleSpecial,
type ArticleTheme,
Pillar,
} from '../lib/format';
} from '../lib/articleFormat';
import { Avatar } from './Avatar';

const meta = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
getAllDesigns,
getAllThemes,
Pillar,
} from '../lib/format';
} from '../lib/articleFormat';
import { BlockquoteBlockComponent } from './BlockquoteBlockComponent';

const meta = {
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Blocks.amp.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { css } from '@emotion/react';
import { palette, text, textSans12 } from '@guardian/source/foundations';
import type { ArticleTheme } from '../lib/articleFormat';
import { blockLink } from '../lib/block-link.amp';
import type { EditionId } from '../lib/edition';
import { findBlockAdSlots } from '../lib/find-adslots.amp';
import type { ArticleTheme } from '../lib/format';
import { pillarPalette_DO_NOT_USE } from '../lib/pillars';
import type { CommercialProperties } from '../types/commercial';
import type { Switches } from '../types/config';
Expand Down
4 changes: 2 additions & 2 deletions dotcom-rendering/src/components/BodyArticle.amp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ import { css } from '@emotion/react';
import { palette, text, textSans12, until } from '@guardian/source/foundations';
import React from 'react';
import { buildAdTargeting } from '../lib/ad-targeting';
import { findAdSlots } from '../lib/find-adslots.amp';
import {
ArticleDesign,
type ArticleTheme,
decideDesign,
decideTheme,
ArticleDesign as Design,
ArticleSpecial as Special,
} from '../lib/format';
} from '../lib/articleFormat';
import { findAdSlots } from '../lib/find-adslots.amp';
import { pillarPalette_DO_NOT_USE } from '../lib/pillars';
import { getSharingUrls } from '../lib/sharing-urls';
import { insertDisclaimerElement } from '../model/enhance-disclaimer';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/BodyLiveblog.amp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
textSans12,
} from '@guardian/source/foundations';
import { buildAdTargeting } from '../lib/ad-targeting';
import { decideTheme } from '../lib/format';
import { decideTheme } from '../lib/articleFormat';
import { getSharingUrls } from '../lib/sharing-urls';
import RefreshIcon from '../static/icons/refresh.svg';
import type { AMPArticleModel } from '../types/article.amp';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Branding.amp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { css } from '@emotion/react';
import { isUndefined } from '@guardian/libs';
import { textSans12 } from '@guardian/source/foundations';
import React from 'react';
import type { ArticleTheme } from '../lib/articleFormat';
import { isEditionId } from '../lib/edition';
import type { ArticleTheme } from '../lib/format';
import { neutralBorder, pillarPalette_DO_NOT_USE } from '../lib/pillars';
import { editionRegionClasses } from '../lib/region-classes.amp';
import type { Branding as BrandingType } from '../types/branding';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/Branding.importable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
ArticleDesign,
type ArticleFormat,
ArticleSpecial,
} from '../lib/format';
} from '../lib/articleFormat';
import { getOphanComponents } from '../lib/labs';
import { palette } from '../palette';
import type { Branding as BrandingType } from '../types/branding';
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/BylineLink.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { render } from '@testing-library/react';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/articleFormat';
import { getContributorTagsForToken } from '../lib/byline';
import { ArticleDesign, ArticleDisplay, Pillar } from '../lib/format';
import type { TagType } from '../types/tag';
import {
bylineAsTokens,
Expand Down
2 changes: 1 addition & 1 deletion dotcom-rendering/src/components/BylineLink.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { isString } from '@guardian/libs';
import { Hide } from '@guardian/source/react-components';
import { DottedLines } from '@guardian/source-development-kitchen/react-components';
import { ArticleDesign, type ArticleFormat } from '../lib/articleFormat';
import {
getBylineComponentsFromTokens,
getSoleContributor,
isContributor,
} from '../lib/byline';
import { ArticleDesign, type ArticleFormat } from '../lib/format';
import { palette as themePalette } from '../palette';
import type { TagType } from '../types/tag';
import { useConfig } from './ConfigContext';
Expand Down
Loading

0 comments on commit 651c255

Please sign in to comment.