Merge pull request #18 from WTFAcademy/dev

update doc

.github/workflows/relesae.yaml

@@ -32,7 +32,7 @@ jobs:
         id: changesets
         uses: changesets/action@v1
         with:
-          publish: pnpm run build:lib && pnpm -w run release
+          publish: pnpm run build:lib && pnpm changeset publish
         env:
           GITHUB_TOKEN: ${{ secrets.SOLIVE_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

apps/demo/craco.config.js

@@ -1,5 +1,5 @@
 const cracoAlias = require("craco-alias");
-const webpack = require("webpack");
+const nodeExternals = require('webpack-node-externals');
 
 module.exports = {
   style: {
@@ -21,34 +21,8 @@ module.exports = {
   ],
   webpack: {
     configure: (webpackConfig, { env, paths }) => {
-      // eslint-disable-next-line no-param-reassign
-      webpackConfig.resolve.fallback = {
-        "http": require.resolve("stream-http"),
-        "https": require.resolve("https-browserify"),
-        "zlib": require.resolve("browserify-zlib"),
-        "stream": require.resolve("stream-browserify"),
-        "events": require.resolve("events/"),
-        "crypto": require.resolve("crypto-browserify"),
-        "assert": require.resolve("assert/"),
-        "buffer": require.resolve("buffer/"),
-        "util": require.resolve("util/"),
-        "path": require.resolve("path-browserify"),
-        "tty": require.resolve("tty-browserify"),
-        "os": require.resolve("os-browserify/browser"),
-        "punycode": require.resolve("punycode/"),
-        "fs": false,
-        "url": require.resolve("url/"),
-        "net": require.resolve("net-browserify"),
-        "child_process": false,
-        async_hooks: false,
-        rawBody: false,
-      };
-
-      webpackConfig.plugins.push(
-        new webpack.ProvidePlugin({
-          Buffer: ["buffer", "Buffer"]
-        })
-      );
+      webpackConfig.externalsPresets = {node: true};
+      webpackConfig.externals = [nodeExternals()];
       return webpackConfig;
     }
   }

apps/demo/package.json

@@ -56,6 +56,7 @@
     "tailwindcss": "npm:@tailwindcss/postcss7-compat@^2.2.17",
     "tty-browserify": "^0.0.1",
     "url": "^0.11.0",
-    "util": "^0.12.5"
+    "util": "^0.12.5",
+    "webpack-node-externals": "^3.0.0"
   }
 }

apps/doc/docs/expansion/index.mdx

@@ -3,3 +3,10 @@ title: 扩展
 sidebar_position: 3
 hide_title: true
 ---
+
+## 扩展
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
+

apps/doc/docs/get-started.mdx

@@ -15,21 +15,21 @@ import TabItem from '@theme/TabItem';
 <TabItem value="npm" label="Npm">
 
 ```sh
-npm install solive
+npm install solive-core
 ```
 
 </TabItem>
 <TabItem value="Yarn" label="Yarn">
 
 ```sh
-yarn add solive
+yarn add solive-core
 ```
 
 </TabItem>
 <TabItem value="Pnpm" label="Pnpm">
 
 ```sh
-pnpm install solive
+pnpm install solive-core
 ```
 
 </TabItem>
@@ -44,42 +44,16 @@ pnpm install solive
 
 ```js
 // 使用craco配置：
-const webpack = require("webpack");
+const nodeExternals = require('webpack-node-externals');
 
 module.exports = {
   // ...
   webpack: {
-    configure: (webpackConfig, { env, paths }) => {
-      // eslint-disable-next-line no-param-reassign
-      webpackConfig.resolve.fallback = {
-        "http": require.resolve("stream-http"),
-        "https": require.resolve("https-browserify"),
-        "zlib": require.resolve("browserify-zlib"),
-        "stream": require.resolve("stream-browserify"),
-        "events": require.resolve("events/"),
-        "crypto": require.resolve("crypto-browserify"),
-        "assert": require.resolve("assert/"),
-        "buffer": require.resolve("buffer/"),
-        "util": require.resolve("util/"),
-        "path": require.resolve("path-browserify"),
-        "tty": require.resolve("tty-browserify"),
-        "os": require.resolve("os-browserify/browser"),
-        "punycode": require.resolve("punycode/"),
-        "fs": false,
-        "url": require.resolve("url/"),
-        "net": require.resolve("net-browserify"),
-        "child_process": false,
-        async_hooks: false,
-        rawBody: false,
-      };
-
-      webpackConfig.plugins.push(
-        new webpack.ProvidePlugin({
-          Buffer: ["buffer", "Buffer"]
-        })
-      );
-      return webpackConfig;
-    }
+     configure: (webpackConfig, { env, paths }) => {
+          webpackConfig.externalsPresets = {node: true};
+          webpackConfig.externals = [nodeExternals()];
+          return webpackConfig;
+     }
   }
 };
 

apps/next_demo/src/pages/index.tsx

@@ -1,26 +1,29 @@
-import dynamic from "next/dynamic";
+import dynamic from 'next/dynamic';
 
-import "solive-core/dist/index.css";
+import 'solive-core/dist/index.css';
 
 const Editor = dynamic(
-  () => {
-    return import("solive-core");
-  },
-  { ssr: false }
+  () => import('solive-core'),
+  { ssr: false },
 );
 
 export default function Home() {
   return (
     <main>
-      <Editor id="1" modelInfos={
+      <Editor
+        id="1"
+        modelInfos={
         [
           {
             filename: '_Storage.sol',
+            // eslint-disable-next-line max-len
             value: "// SPDX-License-Identifier: GPL-3.0\n\npragma solidity >=0.7.0 <0.9.0;\n\n/**\n * @title Storage\n * @dev Store & retrieve value in a variable\n * @custom:dev-run-script ./scripts/deploy_with_ethers.ts\n */\ncontract Storage {\n\n    uint256 number;\n\n    /**\n     * @dev Store value in variable\n     * @param num value to store\n     */\n    function store(uint256 num) public {\n        number = num;\n    }\n\n    /**\n     * @dev Return value \n     * @return value of 'number'\n     */\n    function retrieve() public view returns (uint256){\n        return number;\n    }\n}",
-            language: "solidity" as any,
-          }
+            language: 'solidity' as any,
+          },
         ]
-      } height="500px" />
+      }
+        height="500px"
+      />
     </main>
-  )
+  );
 }