refactor: mark a few client-side packages as side-effect-free (facebook#7085)

Josh-Cena · web-flow · commit e5bf59fd9b56 · 2022-04-09T09:08:18.000+08:00
* refactor: mark a few client-side packages as side-effect-free

* fix

* fix again

* fix...

* revert sideeffect

* revert

* fix again...

* properly fix

* fix

* properly fix
diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
@@ -3,6 +3,7 @@
   "version": "2.0.0-beta.18",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
+  "sideEffects": false,
   "exports": {
     "./client": "./lib/client/index.js",
     "./server": "./lib/server-export.js",
diff --git a/packages/docusaurus-theme-classic/src/theme-classic.d.ts b/packages/docusaurus-theme-classic/src/theme-classic.d.ts
@@ -879,7 +879,7 @@ declare module '@theme/ThemedImage' {
 }
 
 declare module '@theme/Details' {
-  import {Details, type DetailsProps} from '@docusaurus/theme-common';
+  import {Details, type DetailsProps} from '@docusaurus/theme-common/Details';
 
   export interface Props extends DetailsProps {}
   export default Details;
diff --git a/packages/docusaurus-theme-classic/src/theme/Details/index.tsx b/packages/docusaurus-theme-classic/src/theme/Details/index.tsx
@@ -7,7 +7,7 @@
 
 import React from 'react';
 import clsx from 'clsx';
-import {Details as DetailsGeneric} from '@docusaurus/theme-common';
+import {Details as DetailsGeneric} from '@docusaurus/theme-common/Details';
 import type {Props} from '@theme/Details';
 import styles from './styles.module.css';
 
diff --git a/packages/docusaurus-theme-common/Details.d.ts b/packages/docusaurus-theme-common/Details.d.ts
@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// `Details` is a separate export entry because of side-effects messing with CSS
+// insertion order. See https://github.com/facebook/docusaurus/pull/7085.
+// However, because TS doesn't recognize `exports` (also a problem in
+// `content-docs`), we have to manually create a stub.
+
+// eslint-disable-next-line import/named
+export {Details, type DetailsProps} from './lib/components/Details';
diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json
@@ -4,6 +4,14 @@
   "description": "Common code for Docusaurus themes.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
+  "sideEffects": [
+    "lib/components/Details/*",
+    "*.css"
+  ],
+  "exports": {
+    ".": "./lib/index.js",
+    "./Details": "./lib/components/Details/index.js"
+  },
   "scripts": {
     "build": "node copyUntypedFiles.mjs && tsc",
     "watch": "node copyUntypedFiles.mjs && tsc --watch"
diff --git a/packages/docusaurus-theme-common/src/index.ts b/packages/docusaurus-theme-common/src/index.ts
@@ -63,8 +63,6 @@ export {useLocationChange} from './utils/useLocationChange';
 
 export {useCollapsible, Collapsible} from './components/Collapsible';
 
-export {Details, type DetailsProps} from './components/Details';
-
 export {
   useDocsPreferredVersion,
   useDocsPreferredVersionByPluginId,
diff --git a/packages/docusaurus-theme-common/tsconfig.json b/packages/docusaurus-theme-common/tsconfig.json
@@ -8,5 +8,6 @@
     "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
-  }
+  },
+  "include": ["src"]
 }
diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json
@@ -4,6 +4,9 @@
   "description": "Docusaurus live code block component.",
   "main": "lib/index.js",
   "types": "src/theme-live-codeblock.d.ts",
+  "sideEffects": [
+    "lib/theme/Playground/*"
+  ],
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json
@@ -3,6 +3,9 @@
   "version": "2.0.0-beta.18",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
+  "sideEffects": [
+    "*.css"
+  ],
   "exports": {
     "./client": "./lib/client/index.js",
     ".": "./lib/index.js"
diff --git a/packages/docusaurus-utils-common/package.json b/packages/docusaurus-utils-common/package.json
@@ -4,6 +4,7 @@
   "description": "Common (Node/Browser) utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
+  "sideEffects": false,
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch"

Original file line number	Diff line number	Diff line change
`@@ -879,7 +879,7 @@ declare module '@theme/ThemedImage' {`
`879`	`879`	`}`
`880`	`880`
`881`	`881`	`declare module '@theme/Details' {`
`882`		`- import {Details, type DetailsProps} from '@docusaurus/theme-common';`
	`882`	`+ import {Details, type DetailsProps} from '@docusaurus/theme-common/Details';`
`883`	`883`
`884`	`884`	`export interface Props extends DetailsProps {}`
`885`	`885`	`export default Details;`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@`
`8`	`8`	`"declarationMap": true,`
`9`	`9`	`"rootDir": "src",`
`10`	`10`	`"outDir": "lib"`
`11`		`- }`
	`11`	`+ },`
	`12`	`+ "include": ["src"]`
`12`	`13`	`}`