Cleanup webpack example configs (#606)

* Remove Buffer/process plugins

* Adjust

* Cleanup README

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## master
+
+Changes:
+
+- Adjust webpack example config (cleanups, remove unneeded plugins)
+
+
 ## 1.0.1 Jan 29, 2022
 
 **Breaking change** The `Ledger` export from `@polkadot/ui-keyring` has been removed. For users of this class, import it directly from `@polkadot/hw-ledger`

README.md

@@ -30,5 +30,4 @@ Additionally some shared libraries, that is not dependent on any framework -
 In addition to the above packages, there are examples available for intergation  of `ui-keyring`, `ui-settings` & the relevant `*-identicon` package. These are
 
 - [example-react](packages/example-react) - start with `yarn example:react` and view on `http://localhost:8080`
-- [example-reactnative](packages/exampleReactNative) - start with `yarn example:rn:packager` to start the packager service and then either `yarn example:rn:android` or `yarn example:rn:ios` in another terminal
 - [example-vue](packages/example-vue) - start with `yarn example:vue` and view on `http://localhost:8080`

package.json

@@ -19,13 +19,8 @@
     "build:release": "polkadot-ci-ghact-build",
     "build:rollup": "polkadot-exec-rollup --config",
     "clean": "polkadot-dev-clean-build",
-    "demo:identicon:react": "yarn build && webpack-serve --config packages/react-identicon/webpack.config.js --content packages/react-identicon --port 8080",
-    "demo:identicon:vue": "yarn build && webpack-serve --config packages/vue-identicon/webpack.config.js --content packages/vue-identicon --port 8080",
-    "example:react": "yarn build && cd packages/example-react && webpack --config webpack.config.js",
-    "example:rn:android": "cd packages/exampleReactNative && yarn android",
-    "example:rn:ios": "cd packages/exampleReactNative && cd ios && pod install && cd .. && yarn ios",
-    "example:rn:packager": "yarn build && cd packages/exampleReactNative && yarn copy-workspace-packages && yarn start",
-    "example:vue": "yarn build && cd packages/example-vue && webpack --config webpack.config.js",
+    "example:react": "yarn build && cd packages/example-react && webpack --config webpack.config.cjs",
+    "example:vue": "yarn build && cd packages/example-vue && webpack --config webpack.config.cjs",
     "lint": "polkadot-dev-run-lint",
     "postinstall": "polkadot-dev-yarn-only",
     "test": "polkadot-dev-run-test --coverage --runInBand",

packages/example-react/webpack.config.cjs

@@ -3,7 +3,6 @@
 
 const path = require('path');
 const { WebpackPluginServe } = require('webpack-plugin-serve');
-const webpack = require('webpack');
 
 module.exports = {
   context: __dirname,
@@ -37,12 +36,6 @@ module.exports = {
       port: 8080,
       progress: false, // since we have hmr off, disable
       static: __dirname
-    }),
-    new webpack.ProvidePlugin({
-      Buffer: ['buffer', 'Buffer']
-    }),
-    new webpack.ProvidePlugin({
-      process: 'process/browser'
     })
   ],
   resolve: {
@@ -51,14 +44,11 @@ module.exports = {
       '@polkadot/ui-keyring': path.resolve(__dirname, '../ui-keyring/build'),
       '@polkadot/ui-settings': path.resolve(__dirname, '../ui-settings/build'),
       '@polkadot/ui-shared': path.resolve(__dirname, '../ui-shared/build'),
-      'process/browser': require.resolve('process/browser'),
       'react/jsx-runtime': require.resolve('react/jsx-runtime')
     },
     extensions: ['.js', '.ts', '.tsx'],
-    fallback: {
-      buffer: require.resolve('buffer'),
-      stream: require.resolve('stream-browserify')
-    }
+    fallback: {}
   },
+  target: 'web',
   watch: true
 };

packages/example-vue/webpack.config.cjs

@@ -2,9 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 const path = require('path');
-const VueLoaderPlugin = require('vue-loader/lib/plugin');
 const { WebpackPluginServe } = require('webpack-plugin-serve');
-const webpack = require('webpack');
 
 module.exports = {
   context: __dirname,
@@ -22,10 +20,6 @@ module.exports = {
             options: require('../../babel.config.cjs')
           }
         ]
-      },
-      {
-        loader: 'vue-loader',
-        test: /\.vue$/
       }
     ]
   },
@@ -42,13 +36,6 @@ module.exports = {
       port: 8080,
       progress: false, // since we have hmr off, disable
       static: __dirname
-    }),
-    new VueLoaderPlugin(),
-    new webpack.ProvidePlugin({
-      Buffer: ['buffer', 'Buffer']
-    }),
-    new webpack.ProvidePlugin({
-      process: 'process/browser'
     })
   ],
   resolve: {
@@ -56,10 +43,10 @@ module.exports = {
       '@polkadot/ui-keyring': path.resolve(__dirname, '../ui-keyring/build'),
       '@polkadot/ui-settings': path.resolve(__dirname, '../ui-settings/build'),
       '@polkadot/ui-shared': path.resolve(__dirname, '../ui-shared/build'),
-      '@polkadot/vue-identicon': path.resolve(__dirname, '../vue-identicon/build'),
-      'process/browser': require.resolve('process/browser')
+      '@polkadot/vue-identicon': path.resolve(__dirname, '../vue-identicon/build')
     },
     extensions: ['.js', '.ts', '.tsx']
   },
+  target: 'web',
   watch: true
 };

packages/react-identicon/src/Demo.tsx

@@ -1,54 +0,0 @@
-// Copyright 2017-2022 @polkadot/react-identicon authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import React from 'react';
-import ReactDOM from 'react-dom';
-
-import { encodeAddress, randomAsU8a } from '@polkadot/util-crypto';
-
-import { Identicon } from '.';
-
-const THEMES = ['beachball', 'polkadot', 'substrate'];
-
-export default class Demo extends React.PureComponent {
-  public override render (): React.ReactNode {
-    const identities: string[] = [];
-
-    while (identities.length !== 50) {
-      identities.push(
-        encodeAddress(randomAsU8a(32))
-      );
-    }
-
-    return (
-      <div>
-        <div>
-          {identities.map((value, index): React.ReactNode => (
-            <Identicon
-              key={value.toString()}
-              theme={THEMES[index % THEMES.length] as 'empty'}
-              value={value}
-            />
-          ))}
-        </div>
-        <div>
-          {THEMES.map((theme): React.ReactNode => (
-            <Identicon
-              key={theme}
-              theme={theme as 'empty'}
-              value='5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'
-            />
-          ))}
-        </div>
-      </div>
-    );
-  }
-}
-
-const rootElement = document.getElementById('demo');
-
-if (!rootElement) {
-  throw new Error('Unable to find element with id \'demo\'');
-}
-
-ReactDOM.render(<Demo />, rootElement);

packages/react-identicon/webpack.config.js

@@ -1,45 +0,0 @@
-// Copyright 2017-2022 @polkadot/react-identicon authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-const path = require('path');
-const webpack = require('webpack');
-const ENV = process.env.NODE_ENV || 'development';
-const isProd = ENV === 'production';
-
-module.exports = {
-  context: __dirname,
-  devtool: isProd ? 'source-map' : 'eval-cheap-source-map',
-  entry: './src/Demo.tsx',
-  mode: ENV,
-  module: {
-    rules: [
-      {
-        exclude: /(node_modules)/,
-        test: /\.(js|ts|tsx)$/,
-        use: [
-          'babel-loader'
-        ]
-      }
-    ]
-  },
-  output: {
-    filename: './Demo.js',
-    path: path.join(__dirname, 'build')
-  },
-  plugins: [
-    new webpack.ProvidePlugin({
-      Buffer: ['buffer', 'Buffer']
-    }),
-    new webpack.ProvidePlugin({
-      process: 'process/browser'
-    })
-  ],
-  resolve: {
-    alias: {
-      '@polkadot/ui-settings': path.resolve(__dirname, '../ui-settings/build'),
-      '@polkadot/ui-shared': path.resolve(__dirname, '../ui-shared/build'),
-      'process/browser': require.resolve('process/browser')
-    },
-    extensions: ['.js', '.jsx', '.ts', '.tsx']
-  }
-};

packages/vue-identicon/src/Demo.ts

@@ -1,40 +0,0 @@
-// Copyright 2017-2022 @polkadot/vue-identicon authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import Vue, { VNode } from 'vue';
-
-import Identicon from './index';
-
-interface Data {
-  address: string;
-  size: number;
-}
-
-/**
- * @name Demo
- * @description Demo component
- */
-const Demo = Vue.extend({
-  components: {
-    Identicon
-  },
-  data: function (): Data {
-    return {
-      address: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
-      size: 128
-    };
-  },
-  name: 'Demo',
-  template: `
-    <div id="demo">
-      <Identicon :size="size" :theme="'polkadot'" :value="address" />
-      <Identicon :size="size" :theme="'substrate'" :value="address" />
-      <Identicon :size="size" :theme="'beachball'" :value="address" />
-      <Identicon :size="size" :theme="'empty'" />
-    </div>
-  `
-});
-
-new Vue({
-  render: (h): VNode => h(Demo)
-}).$mount('#demo');

packages/vue-identicon/webpack.config.js

@@ -1,50 +0,0 @@
-// Copyright 2017-2022 @polkadot/react-identicon authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-const path = require('path');
-const VueLoaderPlugin = require('vue-loader/lib/plugin');
-const webpack = require('webpack');
-const ENV = process.env.NODE_ENV || 'development';
-const isProd = ENV === 'production';
-
-module.exports = {
-  context: __dirname,
-  devtool: isProd ? 'source-map' : 'eval-cheap-source-map',
-  entry: './src/Demo.ts',
-  mode: ENV,
-  module: {
-    rules: [
-      {
-        exclude: /(node_modules)/,
-        test: /\.(js|ts)$/,
-        use: [
-          'babel-loader'
-        ]
-      },
-      {
-        loader: 'vue-loader',
-        test: /\.vue$/
-      }
-    ]
-  },
-  output: {
-    filename: './demo.js',
-    path: path.join(__dirname, 'build')
-  },
-  plugins: [
-    new VueLoaderPlugin(),
-    new webpack.ProvidePlugin({
-      Buffer: ['buffer', 'Buffer']
-    }),
-    new webpack.ProvidePlugin({
-      process: 'process/browser'
-    })
-  ],
-  resolve: {
-    alias: {
-      '@polkadot/ui-shared': path.resolve(__dirname, '../ui-shared/build'),
-      'process/browser': require.resolve('process/browser')
-    },
-    extensions: ['.js', '.ts']
-  }
-};

tsconfig.eslint.json

@@ -6,6 +6,7 @@
   },
   "include": [
     "packages/**/src/**/*",
+    "packages/**/*.cjs",
     "packages/**/*.js"
   ],
   "exclude": [