Unverified Commit 92aafcbc authored by Henrik Wenz's avatar Henrik Wenz Committed by GitHub

[Docs] Add config types to all examples (#40083)

<!--
Thanks for opening a PR! Your contribution is much appreciated.
In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->

## Summary

- Added jsdoc typing for all examples using `next.config.js`
- Added jsdoc typing for all examples using `tailwind.config.js`

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
parent e7e567b1
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
async rewrites() { async rewrites() {
return [ return [
......
/** @type {import('next').NextConfig} */
const withBundleAnalyzer = require('@next/bundle-analyzer')({ const withBundleAnalyzer = require('@next/bundle-analyzer')({
enabled: process.env.ANALYZE === 'true', enabled: process.env.ANALYZE === 'true',
}) })
/** @type {import('next').NextConfig} */
const nextConfig = { const nextConfig = {
// any configs you need // any configs you need
} }
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: ['./components/**/*.tsx', './pages/**/*.tsx'], content: ['./components/**/*.tsx', './pages/**/*.tsx'],
theme: { theme: {
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
mode: 'jit', mode: 'jit',
purge: ['./pages/**/*.js', './components/**/*.js'], purge: ['./pages/**/*.js', './components/**/*.js'],
......
/** @type {import('next').NextConfig} */
const withNextra = require('nextra')({ const withNextra = require('nextra')({
theme: 'nextra-theme-blog', theme: 'nextra-theme-blog',
themeConfig: './theme.config.js', themeConfig: './theme.config.js',
// optional: add `unstable_staticImage: true` to enable Nextra's auto image import // optional: add `unstable_staticImage: true` to enable Nextra's auto image import
}) })
/** @type {import('next').NextConfig} */
const nextConfig = { const nextConfig = {
// any configs you need // any configs you need
} }
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['cdn.builder.io'], domains: ['cdn.builder.io'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: ['./components/**/*.js', './pages/**/*.js'], content: ['./components/**/*.js', './pages/**/*.js'],
theme: { theme: {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
reactStrictMode: true, reactStrictMode: true,
async rewrites() { async rewrites() {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
loader: 'custom', loader: 'custom',
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['imgix.cosmicjs.com'], domains: ['imgix.cosmicjs.com'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['www.datocms-assets.com'], domains: ['www.datocms-assets.com'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: [process.env.NEXT_IMAGE_DOMAIN], domains: [process.env.NEXT_IMAGE_DOMAIN],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['static.ghost.org'], domains: ['static.ghost.org'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['media.graphcms.com'], domains: ['media.graphcms.com'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['b-cdn.net'], domains: ['b-cdn.net'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['images.prismic.io'], domains: ['images.prismic.io'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
experimental: { experimental: {
images: { images: {
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['localhost'], domains: ['localhost'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: ['./components/**/*.js', './pages/**/*.js'], content: ['./components/**/*.js', './pages/**/*.js'],
theme: { theme: {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['media.umbraco.io'], domains: ['media.umbraco.io'],
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
...@@ -5,6 +5,7 @@ if (!process.env.WORDPRESS_API_URL) { ...@@ -5,6 +5,7 @@ if (!process.env.WORDPRESS_API_URL) {
`) `)
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: [ domains: [
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
basePath: '/gh-pages-test', basePath: '/gh-pages-test',
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
async headers() { async headers() {
return [ return [
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
i18n: { i18n: {
locales: ['en', 'fr', 'nl'], locales: ['en', 'fr', 'nl'],
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
images: { images: {
domains: ['assets.vercel.com'], domains: ['assets.vercel.com'],
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
experimental: { experimental: {
modularizeImports: { modularizeImports: {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
experimental: { experimental: {
reactRemoveProperties: true, reactRemoveProperties: true,
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
// Uncomment the line below to enable basePath, pages and // Uncomment the line below to enable basePath, pages and
// redirects will then have a path prefix (`/app` in this case) // redirects will then have a path prefix (`/app` in this case)
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
experimental: { experimental: {
removeConsole: { removeConsole: {
......
/** @type {import("next").NextConfig} */ /** @type {import("next").NextConfig} */
const config = { module.exports = {
reactStrictMode: true, reactStrictMode: true,
} }
module.exports = config
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
async rewrites() { async rewrites() {
return [ return [
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: (config) => { webpack: (config) => {
config.module.rules.push({ config.module.rules.push({
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
output: 'standalone', output: 'standalone',
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
output: 'standalone', output: 'standalone',
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
distDir: '../.next', distDir: '../.next',
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
/* this needs to be set to false until a bug in the compression npm module gets fixed. /* this needs to be set to false until a bug in the compression npm module gets fixed.
reference: https://github.com/expressjs/compression/issues/122 reference: https://github.com/expressjs/compression/issues/122
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
i18n: { i18n: {
locales: ['en', 'de'], locales: ['en', 'de'],
......
const path = require('path') const path = require('path')
const CopyPlugin = require('copy-webpack-plugin') const CopyPlugin = require('copy-webpack-plugin')
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: (config) => { webpack: (config) => {
config.plugins.push( config.plugins.push(
......
const { locales, sourceLocale } = require('./lingui.config.js') const { locales, sourceLocale } = require('./lingui.config.js')
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
i18n: { i18n: {
locales, locales,
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
reactStrictMode: true, reactStrictMode: true,
} }
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
content: [ content: [
'./pages/**/*.{js,ts,jsx,tsx}', './pages/**/*.{js,ts,jsx,tsx}',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: (configuration) => { webpack: (configuration) => {
configuration.module.rules.push({ configuration.module.rules.push({
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: (config) => { webpack: (config) => {
config.resolve.alias = { config.resolve.alias = {
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
mode: 'jit', mode: 'jit',
purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'], purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'],
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: (config, { isServer }) => { webpack: (config, { isServer }) => {
if (isServer) { if (isServer) {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
reactStrictMode: true, reactStrictMode: true,
} }
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack: function (config) { webpack: function (config) {
config.externals = config.externals || {} config.externals = config.externals || {}
......
const colors = require('tailwindcss/colors') const colors = require('tailwindcss/colors')
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'], purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'],
darkMode: 'class', darkMode: 'class',
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack(config, options) { webpack(config, options) {
config.module.rules.push({ config.module.rules.push({
......
/** @type {import('tailwindcss').Config} */
module.exports = { module.exports = {
mode: 'jit', mode: 'jit',
purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'], purge: ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'],
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack(config) { webpack(config) {
config.output.webassemblyModuleFilename = 'static/wasm/[modulehash].wasm' config.output.webassemblyModuleFilename = 'static/wasm/[modulehash].wasm'
......
const path = require('path') const path = require('path')
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
webpack(config, { dev, isServer }) { webpack(config, { dev, isServer }) {
if (dev && !isServer) { if (dev && !isServer) {
......
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
basePath: '/blog', basePath: '/blog',
} }
const { BLOG_URL } = process.env const { BLOG_URL } = process.env
/** @type {import('next').NextConfig} */
module.exports = { module.exports = {
async rewrites() { async rewrites() {
return [ return [
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment