Fix: process is undefined error (#178)

rohit-gohri · May 14, 2022 · 4bfde6e · 4bfde6e · vercel · May 14, 2022
1 parent 692c5ba
commit 4bfde6e
Show file tree

Hide file tree

Showing 10 changed files with 1,745 additions and 1,719 deletions.
diff --git a/.changeset/tasty-lions-glow.md b/.changeset/tasty-lions-glow.md
@@ -0,0 +1,5 @@
+---
+'docusaurus-theme-redoc': patch
+---
+
+Add back node-polyfill to fix client errors
diff --git a/package.json b/package.json
@@ -13,7 +13,8 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "lint:fix": "yarn lint --fix",
     "release": "yarn build:packages && changeset publish --no-git-tag",
-    "start": "yarn build && yarn workspace redocusaurus-website run start",
+    "serve": "yarn workspace redocusaurus-website run serve",
+    "start": "yarn build:packages && yarn workspace redocusaurus-website run start",
     "test": "echo \"Error: no test specified\" && exit 1",
     "version": "changeset version && yarn install --no-immutable && sh scripts/combine-changelog.sh",
     "prepare": "husky install"
@@ -36,11 +37,11 @@
   },
   "homepage": "https://github.com/rohit-gohri/redocusaurus#readme",
   "devDependencies": {
-    "@changesets/changelog-github": "^0.4.3",
-    "@changesets/cli": "^2.21.1",
+    "@changesets/changelog-github": "^0.4.4",
+    "@changesets/cli": "^2.22.0",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
-    "concurrently": "^7.0.0",
+    "concurrently": "^7.1.0",
     "eslint": "^8.11.0",
     "eslint-config-airbnb-typescript": "^16.1.1",
     "eslint-config-prettier": "^8.5.0",
@@ -52,7 +53,7 @@
     "husky": "^7.0.4",
     "lint-staged": "^12.3.5",
     "prettier": "2.5.1",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.4"
   },
   "engines": {
     "node": ">=14"

diff --git a/packages/docusaurus-plugin-redoc/package.json b/packages/docusaurus-plugin-redoc/package.json
@@ -19,8 +19,6 @@
     "src"
   ],
   "keywords": [
-    "redoc",
-    "api-doc",
     "docusaurus",
     "docusaurus-plugin"
   ],

diff --git a/packages/docusaurus-theme-redoc/package.json b/packages/docusaurus-theme-redoc/package.json
@@ -22,8 +22,6 @@
     "url": "git+https://github.com/rohit-gohri/redocusaurus.git"
   },
   "keywords": [
-    "redoc",
-    "api-doc",
     "docusaurus",
     "docusaurus-theme"
   ],
@@ -39,21 +37,20 @@
     "clsx": "^1.1.1",
     "copyfiles": "^2.4.1",
     "lodash": "^4.17.21",
-    "mobx": "^6.3.13",
+    "mobx": "^6.5.0",
     "redoc": "2.0.0-rc.69",
-    "styled-components": "^5.3.3",
-    "to-arraybuffer": "^1.0.1"
+    "styled-components": "^5.3.5"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^2.0.0-beta.20",
     "@docusaurus/theme-classic": "^2.0.0-beta.20",
-    "@types/lodash": "^4.14.179",
-    "@types/react-dom": "^17.0.13",
+    "@types/lodash": "^4.14.182",
+    "@types/react-dom": "^17.0.17",
     "@types/react-router-dom": "^5.3.3",
-    "@types/rtlcss": "^3.1.2",
-    "@types/styled-components": "^5.1.24",
+    "@types/rtlcss": "^3.1.4",
+    "@types/styled-components": "^5.1.25",
     "nodemon": "^2.0.15",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.4"
   },
   "engines": {
     "node": ">=14"

diff --git a/packages/docusaurus-theme-redoc/src/index.ts b/packages/docusaurus-theme-redoc/src/index.ts
@@ -16,21 +16,18 @@ export default function redocTheme(
     name: 'docusaurus-theme-redoc',
     configureWebpack(_config, isServer) {
       return {
-        resolve: {
-          fallback: {
-            tty: false,
-          },
-        },
         plugins: [
+          new webpack.NormalModuleReplacementPlugin(
+            /^tty$/,
+            require.resolve('./tty'),
+          ),
           new webpack.DefinePlugin({
             'process.versions.node': JSON.stringify(
               process.versions.node || '0.0.0',
             ),
+            'process.platform': JSON.stringify(''),
+            'process.env': JSON.stringify({}),
           }),
-          new webpack.NormalModuleReplacementPlugin(
-            /^redoc$/,
-            require.resolve('redoc/bundles/redoc.browser.lib'),
-          ),
           ...(isServer
             ? [
                 new webpack.NormalModuleReplacementPlugin(

diff --git a/packages/docusaurus-theme-redoc/src/tty.ts b/packages/docusaurus-theme-redoc/src/tty.ts
@@ -0,0 +1 @@
+export const isatty = () => false;
diff --git a/packages/redocusaurus/Readme.md b/packages/redocusaurus/Readme.md
@@ -1,4 +1,4 @@
-# [Redocusaurus](https://github.com/rohit-gohri/redocusaurus)
+# [Redocusaurus](https://redocusaurus.vercel.app/)
 
 ![npm](https://img.shields.io/npm/v/redocusaurus?style=flat-square)
 
@@ -8,69 +8,85 @@
 
 1. Install redocusaurus:
 
-   ```sh
-   npm i --save redocusaurus
-   ```
+  ```sh
+  npm i --save redocusaurus
+  # OR
+  yarn add redocusaurus
+  ```
 
 1. Add it as a preset to your docusaurus config and pass options:
 
    - Pass it a path to a local OpenAPI YAML file
 
-     ```js
-     // docusaurus.config.js
-
-     module.exports = {
-       // ...
-       presets: [
-         [
-           'redocusaurus',
-           {
-             specs: [
-               {
-                 spec: 'openapi.yaml',
-               },
-             ],
-           },
-         ],
-       ],
-       // ...
-     };
-     ```
-
-   - Pass it a OpenAPI spec URL
-
-     ```js
-     // docusaurus.config.js
-
-     module.exports = {
-       // ...
-       presets: [
-         [
-           'redocusaurus',
-           {
-             specs: [
-               {
-                 spec: 'https://redocly.github.io/redoc/openapi.yaml',
-               },
-             ],
-           },
-         ],
-       ],
-       // ...
-     };
-     ```
-
-The API Doc will be available by default at `/api/` path. To customize it see [full plugin options](../docusaurus-plugin-redoc/Readme.md).
+    ```js
+    // docusaurus.config.js
+
+    module.exports = {
+      // ...
+      presets: [
+        [
+          'redocusaurus',
+          {
+            // Plugin Options for loading OpenAPI files
+            specs: [
+              {
+                spec: 'openapi/openapi.yaml',
+                route: '/api/',
+              },
+            ],
+            // Theme Options for modifying how redoc renders them
+            theme: {
+              // Change with your site colors
+              primaryColor: '#1890ff',
+            },
+          },
+        ],
+      ],
+      // ...
+    };
+    ```
+
+- OR Pass it a OpenAPI spec URL
+
+    ```js
+    // docusaurus.config.js
+
+    module.exports = {
+      // ...
+      presets: [
+        [
+          'redocusaurus',
+          {
+            // Plugin Options for loading OpenAPI files
+            specs: [
+              {
+                spec: 'https://redocly.github.io/redoc/openapi.yaml',
+                route: '/api/',
+              },
+            ],
+            // Theme Options for modifying how redoc renders them
+            theme: {
+              // Change with your site colors
+              primaryColor: '#1890ff',
+            },
+          },
+        ],
+      ],
+      // ...
+    };
+    ```
+
+The API Doc will be available at the route specified (`/api/` in the example above). To customize it see [full plugin options](https://redocusaurus.vercel.app/docs/getting-started/plugin-options).
 
 ### Options
 
 #### specs
 
-Pass it an array of plugin options, see [docusaurus-plugin-redoc](../docusaurus-plugin-redoc/Readme.md) for individual option details.
+Pass it an array of plugin options, see [docusaurus-plugin-redoc](https://redocusaurus.vercel.app/docs/getting-started/plugin-options) for individual option details.
 
 #### theme
 
-Pass options to customize the theme, see [docusaurus-theme-redoc](../docusaurus-theme-redoc/Readme.md) for individual option details.
+Pass options to customize the theme, see [docusaurus-theme-redoc](https://redocusaurus.vercel.app/docs/getting-started/theme-options) for individual option details.
 
 ## Docs
 

diff --git a/packages/redocusaurus/package.json b/packages/redocusaurus/package.json
@@ -27,7 +27,9 @@
   "keywords": [
     "redoc",
     "openapi",
-    "documentations",
+    "api",
+    "swagger",
+    "documentation",
     "api-doc",
     "docusaurus",
     "docusaurus-preset"

diff --git a/website/package.json b/website/package.json
@@ -30,8 +30,8 @@
     "redocusaurus": "^1.0.3"
   },
   "devDependencies": {
-    "@percy/cli": "^1.0.0-beta.76",
-    "@types/react": "^17.0.39"
+    "@percy/cli": "^1.1.4",
+    "@types/react": "^17.0.45"
   },
   "browserslist": {
     "production": [