Skip to content

feat(core): promote siteConfig.storage to stable + add future.v4.siteStorageNamespacing flag [Codex] #11798

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.

Sign up for GitHub

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

Closed
slorber wants to merge 9 commits into from
Closed

feat(core): promote siteConfig.storage to stable + add future.v4.siteStorageNamespacing flag [Codex] #11798

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e1dc883
Mark storage API stable and add v4 siteStorageNamespacing flag (AI-as…
slorber Mar 12, 2026
243bfd3
refactor: apply lint autofix
slorber Mar 12, 2026
8d08145
chore: trigger CI (AI-assisted)
slorber Mar 12, 2026
8aa1710
Address PR review feedback on storage promotion (AI-assisted)
slorber Mar 12, 2026
dc8684e
Fix Joi typing for removed future.experimental_storage (AI-assisted)
slorber Mar 12, 2026
6fbdf1b
refactor(core): simplify storage partial config typing (AI-assisted)
slorber Mar 12, 2026
c4dd8ce
refactor(core): replace Joi pattern workaround for legacy storage key…
slorber Mar 12, 2026
3c96284
refactor(core): inline future legacy storage typing and simplify name…
slorber Mar 12, 2026
dabe71a
test(core): move storage config tests out of future and cover namespa…
slorber Mar 12, 2026
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
10 changes: 8 additions & 2 deletions packages/docusaurus-types/src/config.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export type FasterConfig = {
export type FutureV4Config = {
removeLegacyPostBuildHeadAttribute: boolean;
useCssCascadeLayers: boolean;
siteStorageNamespacing: boolean;
};

// VCS (Version Control System) info about a given change, e.g., a git commit.
Expand Down Expand Up @@ -96,8 +97,6 @@ export type FutureConfig = {

experimental_faster: FasterConfig;

experimental_storage: StorageConfig;

experimental_vcs: VcsConfig;

/**
Expand Down Expand Up @@ -180,6 +179,13 @@ export type DocusaurusConfig = {
* Similar to Remix future flags, see https://remix.run/blog/future-flags
*/
future: FutureConfig;
/**
* Site-wide browser storage options that theme authors should strive to
* respect.
*
* @see https://docusaurus.io/docs/api/docusaurus-config#storage
*/
storage: StorageConfig;
/**
* This option adds `<meta name="robots" content="noindex, nofollow">` to
* every page to tell search engines to avoid indexing your site.
Expand Down
90 changes: 50 additions & 40 deletions packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,14 @@ exports[`loadSiteConfig website with .cjs siteConfig 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -73,6 +70,10 @@ exports[`loadSiteConfig website with .cjs siteConfig 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -105,17 +106,14 @@ exports[`loadSiteConfig website with ts + js config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -158,6 +156,10 @@ exports[`loadSiteConfig website with ts + js config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -190,17 +192,14 @@ exports[`loadSiteConfig website with valid JS CJS config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -243,6 +242,10 @@ exports[`loadSiteConfig website with valid JS CJS config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -275,17 +278,14 @@ exports[`loadSiteConfig website with valid JS ESM config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -328,6 +328,10 @@ exports[`loadSiteConfig website with valid JS ESM config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -360,17 +364,14 @@ exports[`loadSiteConfig website with valid TypeScript CJS config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -413,6 +414,10 @@ exports[`loadSiteConfig website with valid TypeScript CJS config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -445,17 +450,14 @@ exports[`loadSiteConfig website with valid TypeScript ESM config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -498,6 +500,10 @@ exports[`loadSiteConfig website with valid TypeScript ESM config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "",
"themeConfig": {},
Expand Down Expand Up @@ -530,17 +536,14 @@ exports[`loadSiteConfig website with valid async config 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -585,6 +588,10 @@ exports[`loadSiteConfig website with valid async config 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "Hello World",
"themeConfig": {},
Expand Down Expand Up @@ -617,17 +624,14 @@ exports[`loadSiteConfig website with valid async config creator function 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -672,6 +676,10 @@ exports[`loadSiteConfig website with valid async config creator function 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "Hello World",
"themeConfig": {},
Expand Down Expand Up @@ -704,17 +712,14 @@ exports[`loadSiteConfig website with valid config creator function 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -759,6 +764,10 @@ exports[`loadSiteConfig website with valid config creator function 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "Hello World",
"themeConfig": {},
Expand Down Expand Up @@ -794,17 +803,14 @@ exports[`loadSiteConfig website with valid siteConfig 1`] = `
"swcJsMinimizer": false,
},
"experimental_router": "browser",
"experimental_storage": {
"namespace": false,
"type": "localStorage",
},
"experimental_vcs": {
"getFileCreationInfo": [Function],
"getFileLastUpdateInfo": [Function],
"initialize": [Function],
},
"v4": {
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
},
},
Expand Down Expand Up @@ -857,6 +863,10 @@ exports[`loadSiteConfig website with valid siteConfig 1`] = `
"staticDirectories": [
"static",
],
"storage": {
"namespace": false,
"type": "localStorage",
},
"stylesheets": [],
"tagline": "Hello World",
"themeConfig": {},
Expand Down
Loading
Loading