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.

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

Metadata fields improvements #45945

Merged
merged 4 commits into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/next/src/lib/metadata/default-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export const createDefaultMetadata = (): ResolvedMetadata => {
creator: null,
publisher: null,
robots: null,
manifest: null,
alternates: {
canonical: null,
languages: null,
Expand Down
11 changes: 9 additions & 2 deletions packages/next/src/lib/metadata/generate/basic.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@ export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) {
) : null}
<Meta name="description" content={metadata.description} />
<Meta name="application-name" content={metadata.applicationName} />
<Meta name="author" content={metadata.authors?.join(',')} />
{metadata.authors &&
metadata.authors.map((author, index) => (
<React.Fragment key={index}>
{author.url && <link rel="author" href={author.url.toString()} />}
<Meta name="author" content={author.name} />
</React.Fragment>
))}
<Meta name="manifest" content={metadata.manifest?.toString()} />
<Meta name="generator" content={metadata.generator} />
<Meta name="keywords" content={metadata.keywords?.join(',')} />
<Meta name="referrer" content={metadata.referrer} />
Expand Down Expand Up @@ -79,7 +86,7 @@ export function FormatDetectionMeta({
if (!formatDetection) return null
let content = ''
for (const key of formatDetectionKeys) {
if (formatDetection[key]) {
if (key in formatDetection) {
if (content) content += ', '
content += `${key}=no`
}
Expand Down
1 change: 1 addition & 0 deletions packages/next/src/lib/metadata/resolve-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ function merge(
case 'colorScheme':
case 'itunes':
case 'formatDetection':
case 'manifest':
// @ts-ignore TODO: support inferring
target[key] = source[key] || null
break
Expand Down
3 changes: 0 additions & 3 deletions packages/next/src/lib/metadata/types/manifest-types.ts

This file was deleted.

9 changes: 9 additions & 0 deletions packages/next/src/lib/metadata/types/metadata-interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,13 @@ interface Metadata {
*/
icons?: null | IconURL | Array<Icon> | Icons

/**
* The manifest.json file is the only file that every extension using WebExtension APIs must contain
*
* @type {null | string | URL}
*/
manifest?: null | string | URL

/**
* @example
* Example of Open Graph field:
Expand Down Expand Up @@ -293,6 +300,8 @@ interface ResolvedMetadata {

openGraph: null | ResolvedOpenGraph

manifest: null | string | URL

twitter: null | ResolvedTwitterMetadata

// common verification tokens
Expand Down
14 changes: 8 additions & 6 deletions test/e2e/app-dir/metadata/app/basic/page.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { Metadata } from 'next'
import Link from 'next/link'

export default function Page() {
Expand All @@ -14,22 +15,23 @@ export default function Page() {
)
}

export const metadata = {
export const metadata: Metadata = {
generator: 'next.js',
applicationName: 'test',
referrer: 'origin-when-crossorigin',
referrer: 'origin-when-cross-origin',
keywords: ['next.js', 'react', 'javascript'],
authors: ['John Doe', 'Jane Doe'],
authors: [{ name: 'huozhi' }, { name: 'tree', url: 'https://tree.com' }],
themeColor: 'cyan',
colorScheme: 'dark',
manifest: 'https://github.com/manifest.json',
viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no',
creator: 'shu',
publisher: 'vercel',
robots: 'index, follow',
alternates: {},
formatDetection: {
email: 'no',
address: 'no',
telephone: 'no',
email: false,
address: false,
telephone: false,
},
}
13 changes: 10 additions & 3 deletions test/e2e/app-dir/metadata/metadata.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,24 @@ createNextDescribe(
const browser = await next.browser('/basic')
await checkMetaNameContentPair(browser, 'generator', 'next.js')
await checkMetaNameContentPair(browser, 'application-name', 'test')
await checkMetaNameContentPair(
browser,
'manifest',
'https://github.com/manifest.json'
)

await checkMetaNameContentPair(
browser,
'referrer',
'origin-when-crossorigin'
'origin-when-cross-origin'
)
await checkMetaNameContentPair(
browser,
'keywords',
'next.js,react,javascript'
)
await checkMetaNameContentPair(browser, 'author', 'John Doe,Jane Doe')
await checkMetaNameContentPair(browser, 'author', ['huozhi', 'tree'])
await checkLink(browser, 'author', 'https://tree.com')
await checkMetaNameContentPair(browser, 'theme-color', 'cyan')
await checkMetaNameContentPair(browser, 'color-scheme', 'dark')
await checkMetaNameContentPair(
Expand Down Expand Up @@ -293,7 +300,7 @@ createNextDescribe(
await checkMetaNameContentPair(
browser,
'referrer',
'origin-when-crossorigin'
'origin-when-cross-origin'
)
await browser.back().waitForElementByCss('#index')
expect(await getTitle(browser)).toBe('index page')
Expand Down