merge: pull request #161 from paulrberg/staging

docs: roll v1.7.0
WalletConnect · Sep 14, 2021 · 83299e4 · 83299e4
2 parents abff6a9 + 4ce79be
commit 83299e4
Show file tree

Hide file tree

Showing 59 changed files with 13,609 additions and 9,391 deletions.
diff --git a/.commitlintrc.js b/.commitlintrc.js
diff --git a/.commitlintrc.yaml b/.commitlintrc.yaml
@@ -0,0 +1,2 @@
+extends:
+  - "@commitlint/config-conventional"
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -1,11 +1,11 @@
 extends:
-  - eslint:recommended
-  - plugin:@typescript-eslint/eslint-recommended
-  - plugin:@typescript-eslint/recommended
-  - prettier/@typescript-eslint
+  - "eslint:recommended"
+  - "plugin:@typescript-eslint/eslint-recommended"
+  - "plugin:@typescript-eslint/recommended"
+  - "prettier"
 parser: "@typescript-eslint/parser"
 parserOptions:
-  project: tsconfig.json
+  project: "tsconfig.json"
 plugins:
   - "@typescript-eslint"
 root: true

diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -74,11 +74,11 @@ Community leaders will follow these Community Impact Guidelines in determining t
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+available at https://contributor-covenant.org/version/2/0/code_of_conduct.html.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
+[homepage]: https://contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+https://contributor-covenant.org/faq. Translations are available at https://contributor-covenant.org/translations.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml
@@ -0,0 +1,39 @@
+name: "Continuous Integration"
+
+env:
+  GH_OAUTH_TOKEN: ${{ secrets.GH_OAUTH_TOKEN }}
+
+on:
+  push:
+    branches:
+      - "develop"
+      - "staging"
+  pull_request:
+    branches:
+      - "develop"
+      - "staging"
+
+jobs:
+  integration:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v2"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v2"
+        with:
+          cache: "yarn"
+          node-version: "16"
+
+      - name: "Install dependencies"
+        run: "yarn install --immutable"
+
+      - name: "Lint code"
+        run: "yarn lint"
+
+      - name: "Run unit tests"
+        run: "yarn test:unit"
+
+      - name: "Run integration tests"
+        run: "yarn test:integration"
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,7 @@
 # generic folders
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
 build/
 coverage/
 dist/

diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn dlx commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn dlx lint-staged
diff --git a/.huskyrc b/.huskyrc
diff --git a/.jest/setup.js b/.jest/setup.js
@@ -1 +1 @@
-jest.setTimeout(120000);
+jest.setTimeout(180000);
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,5 @@
+{
+  "*.{js,json,md,sol,ts}": [
+    "prettier --config ./.prettierrc --write"
+  ]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,6 @@
 # folders
 dist/
 node_modules/
+
+# files
+*.hbs
diff --git a/.prettierrc b/.prettierrc
@@ -1,17 +1,9 @@
 {
   "arrowParens": "avoid",
   "bracketSpacing": true,
-  "endOfLine":"auto",
+  "endOfLine": "auto",
   "printWidth": 120,
   "singleQuote": false,
   "tabWidth": 2,
-  "trailingComma": "all",
-  "overrides": [
-    {
-      "files": "*.sol",
-      "options": {
-        "tabWidth": 4
-      }
-    }
-  ]
+  "trailingComma": "all"
 }
diff --git a/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs b/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
diff --git a/.yarn/releases/yarn-3.0.2.cjs b/.yarn/releases/yarn-3.0.2.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
+
+yarnPath: .yarn/releases/yarn-3.0.2.cjs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,60 +5,87 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.7.0] - 2021-09-14
+
+### Added
+
+- New links in the default Vue template
+- User info in the wallet button with ENS support via [PR #146](https://github.com/paulrberg/create-eth-app/pull/146)
+
+### Changed
+
+- Change `module` to `commonjs` in `tsconfig.json`
+- Rename `NETWORK_NAME` variable to `NETWORK`
+- Replace the "Disconnect Wallet" label with the user info
+- Set initial version of default React and Vue templates to "1.0.0"
+- Sort imports
+- Upgrade dependencies in default React and Vue templates
+- Wrap `web3Modal` instance in `useMemo` hook
+
+### Fixed
+
+- Parsing of GITHUB_REF when it has a prefix like `refs/heads/`
+
+### Removed
+
+- Bespoke configuration for Solidity in `.prettierrc`
+- Redundant `nohoist` field in top-level `package.json`, which fixes [issue #139](https://github.com/paulrberg/create-eth-app/issues/139)
+- The "www" prefix from links in the default Vue template
+
 ## [1.6.5] - 2021-05-26
 
 ### Fixed
 
-- Install core.js missing dependency in vue handlebars template, which fixes [issue #104](https://github.com/paulrberg/create-eth-app/issues/104)
+- Install `core.js` missing dependency in vue handlebars template, which fixes [issue #104](https://github.com/paulrberg/create-eth-app/issues/104)
 
 ## [1.6.4] - 2021-05-25
 
 ### Fixed
 
-- Yarn workspaces command issue, as patched by @heronblade via [pull request 134](https://github.com/paulrberg/create-eth-app/pull/134)
+- Yarn workspaces command issue, as patched by @heronblade via [PR #134](https://github.com/paulrberg/create-eth-app/pull/134)
 
 ## [1.6.3] - 2021-05-14
 
 ### Fixed
 
-- Warning caused by duplicate "body" tag, which fixes [issue #55](https://github.com/paulrberg/create-eth-app/issues/55)
+- Warning caused by duplicate `body` tag, which fixes [issue #55](https://github.com/paulrberg/create-eth-app/issues/55)
 
 ## [1.6.2] - 2020-12-20
 
 ### Fixed
 
-- The infinite re-render bug, as reported and patched by @gasolin with [pull request #92](https://github.com/paulrberg/create-eth-app/pull/92)
+- The infinite re-render bug, as reported and patched by @gasolin with [PR #92](https://github.com/paulrberg/create-eth-app/pull/92)
 
 ## [1.6.1] - 2020-11-20
 
 ### Added
 
-- Balancer template, as per [pull request #98](https://github.com/PaulRBerg/create-eth-app/pull/98)
-- mStable template, as per [pull request #97](https://github.com/PaulRBerg/create-eth-app/pull/97)
-- [Internal] Comprehensive unit and integration tests with good coverage of the repo, as per [pull request #86](https://github.com/PaulRBerg/create-eth-app/pull/86)
+- Balancer template, as per [PR #98](https://github.com/PaulRBerg/create-eth-app/pull/98)
+- mStable template, as per [PR #97](https://github.com/PaulRBerg/create-eth-app/pull/97)
+- [Internal] Comprehensive unit and integration tests with good coverage of the repo, as per [PR #86](https://github.com/PaulRBerg/create-eth-app/pull/86)
 - [Internal] New [env.ts](https://github.com/PaulRBerg/create-eth-app/tree/v1.6.1/src/helpers/env.ts) helper that deals with environment variable management
 
 ### Changed
 
 - Refactor web3Modal code as a React Hook, [courtesy](https://github.com/PaulRBerg/create-eth-app/pull/79) of @gasolin
-- Renamed "dist" to "build" in Vue.js templates, as per [pull request #77](https://github.com/PaulRBerg/create-eth-app/pull/77)
-- Strict version tags for the download urls, as per [pull request #76](https://github.com/PaulRBerg/create-eth-app/pull/76)
-- Upgraded dependencies, both ours and the react and vue template ones
-- [Internal] Rename many of the helpers, e.g. "isFolderEmpty" to "directories"
+- Rename "dist" to "build" in Vue.js templates, as per [PR #77](https://github.com/PaulRBerg/create-eth-app/pull/77)
+- Strict version tags for the download urls, as per [PR #76](https://github.com/PaulRBerg/create-eth-app/pull/76)
+- Upgrade dependencies, both ours and the react and vue template ones
+- [Internal] Rename many of the helpers, e.g. `isFolderEmpty` to `directories`
 - [Internal] Upgrade to TypeScript v4
 - [Internal] Use ESlint instead of TSLint and fix [issue #74](https://github.com/PaulRBerg/create-eth-app/issues/74)
 - [Internal] Use @vercel/ncc instead of @zeit/ncc and fix [issue #21](https://github.com/PaulRBerg/create-eth-app/issues/21)
 
 ### Fixed
 
-- Duplicated comment about Infura, [courtesy](https://github.com/PaulRBerg/create-eth-app/pull/84) of @gasolin
+- Duplicate comment about Infura, [courtesy](https://github.com/PaulRBerg/create-eth-app/pull/84) of @gasolin
 - [Internal] [Issue #56](https://github.com/PaulRBerg/create-eth-app/issues/56) by setting up CI on GitHub Actions
 
 ## [1.5.0] - 2020-09-14
 
 ### Added
 
-- Simple integration of web3Modal to React templates, as per [pull request #63](https://github.com/PaulRBerg/create-eth-app/pull/63)
+- Simple integration of web3Modal to React templates, as per [PR #63](https://github.com/PaulRBerg/create-eth-app/pull/63)
 
 ## [1.4.1] - 2020-09-03
 
@@ -70,17 +97,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- New IPFS deployment script allowing publishing of apps with `yarn ipfs`, as per [pull request #58](https://github.com/PaulRBerg/create-eth-app/pull/58)
+- New IPFS deployment script allowing publishing of apps with `yarn ipfs`, as per [PR #58](https://github.com/PaulRBerg/create-eth-app/pull/58)
 
 ### Changed
 
-- React template component styling has been updated to use [styled-components](https://styled-components.com/), as per [pull request #51](https://github.com/PaulRBerg/create-eth-app/pull/51)
-- The location of subgraph query definitions has been updated, as per [pull request #50](https://github.com/PaulRBerg/create-eth-app/pull/50)
-- The @uniswap/sdk version has been updated to v3.0.2, as per [pull request #52](https://github.com/PaulRBerg/create-eth-app/pull/52)
+- Update React template component styling to use [styled-components](https://styled-components.com/), as per [PR #51](https://github.com/PaulRBerg/create-eth-app/pull/51)
+- Update the location of subgraph query definitions, as per [PR #50](https://github.com/PaulRBerg/create-eth-app/pull/50)
+- Update the `@uniswap/sdk` version to v3.0.2, as per [PR #52](https://github.com/PaulRBerg/create-eth-app/pull/52)
 
 ### Fixed
 
-- Incorrect package names in certain templates' READMEs fixed, as per [pull request #54](https://github.com/PaulRBerg/create-eth-app/pull/54)
+- Incorrect package names in certain templates' READMEs fixed, as per [PR #54](https://github.com/PaulRBerg/create-eth-app/pull/54)
 
 ## [1.3.1] - 2020-07-30
 
@@ -90,7 +117,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Bug in Aave template, as per [pull request #46](https://github.com/PaulRBerg/create-eth-app/pull/46)
+- Bug in Aave template, as per [PR #46](https://github.com/PaulRBerg/create-eth-app/pull/46)
 - Incorrect paths in .gitignore, as per [5eabf30](https://github.com/PaulRBerg/create-eth-app/commit/5eabf30a664b68b66b28754e542b791b598249bd)
 
 ### Removed
@@ -109,7 +136,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [handlebars.js](https://handlebarsjs.com/) as per [issue #30](https://github.com/PaulRBerg/create-eth-app/issues/30)
 - Make Uniswap v2 the default template when passing `--template uniswap`
 - Upgrade to ethers v5
-- Use only "dependencies" in the frontend app package instead of both "dependencies" and "devDependencies"
+- Use only `dependencies` in the frontend app package instead of both `dependencies` and `devDependencies`
 - (Contributors) Define the branch whence the templates are pulled as an editable property
 
 ### Fixed
@@ -118,7 +145,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-- The duplicated React and Vue.js code from the "templates" folder
+- The duplicated React and Vue.js code from the `templates` folder
 
 ## [1.2.0] - 2020-05-09
 
@@ -130,14 +157,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Bring [the default template](https://github.com/paulrberg/cea-template) into this repository
-- Move the "isUrlOk" function from `templates.js` to its bespoke file
+- Move the `isUrlOk` function from `templates.js` to its bespoke file
 - Rename the Sablier template from "sablier" to "sablier-v1"
-- Reorganise the React templates under a new subfolder called "react"
+- Reorganise the React templates under a new directory called "react"
 - Swap the Create React App labels with Create Eth App labels in the default template
 
 ### Removed
 
-- The "downloadAndExtractTemplate" function in `templates.js`
+- The `downloadAndExtractTemplate` function in `templates.js`
 - The "packages" section in the [README](/README.md)
 
 ## [1.1.1] - 2020-05-09
@@ -163,7 +190,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Set "module" to "ES2015" and "skipLibCheck" to "false" in the root `tsconfig.json`
+- Set `module` to `ES2015` and `skipLibCheck` to `false` in the root `tsconfig.json`
 
 ### Fixed
 
@@ -176,6 +203,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial release of the tool
 - The default template
 
+[1.7.0]: https://github.com/paulrberg/create-eth-app/compare/v1.6.5...v1.7.0
 [1.6.5]: https://github.com/paulrberg/create-eth-app/compare/v1.6.4...v1.6.5
 [1.6.4]: https://github.com/paulrberg/create-eth-app/compare/v1.6.3...v1.6.4
 [1.6.3]: https://github.com/paulrberg/create-eth-app/compare/v1.6.2...v1.6.3

diff --git a/README.md b/README.md
@@ -159,7 +159,7 @@ But Ethereum is a large ecosystem. Here are a few common cases where you might w
 - If you want **write smart contracts and also build a frontend app**, consider [using the
   Truffle React Box](https://github.com/truffle-box/react-box)
 - If you want to write smart contracts and keep the frontend app in the same repository but **React isn't your cup of tea**, consider [using the Embark framework](https://github.com/embarklabs/embark)
-- If you need to use a complex state container like Redux, consider [using Drizzle](https://www.trufflesuite.com/drizzle)
+- If you need to use a complex state container like Redux, consider [using Drizzle](https://trufflesuite.com/drizzle)
 
 For alternatives to React in particular, read the [official Create React App
 documentation](https://github.com/facebook/create-react-app/blob/master/README.md#popular-alternatives).

diff --git a/handlebars/react/packages/react-app/README.md.hbs b/handlebars/react/packages/react-app/README.md.hbs
@@ -1,6 +1,6 @@
 # {{ title }}
 
-This package is a fork of the default template provided by [Create React App](https://github.com/facebook/create-react-app).
+This package is a fork of the default app built with [Create React App](https://github.com/facebook/create-react-app).
 
 ## Available Scripts