Merge pull request #224 from trufflesuite/develop

`2.5.0` release into `master`

Author: acuarica

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## PR description
+
+<!-- Enter PR description here -->
+
+## Documentation
+
+- [ ] I thought about documentation and added the `doc-change-required` label to this PR if documentation updates are required.

.github/workflows/core-ci-checks.yml

@@ -26,4 +26,4 @@ jobs:
         run: yarn eslint
 
       - name: Tests
-        run: yarn test
+        run: yarn test:int

.github/workflows/publish.yml

@@ -61,7 +61,7 @@ jobs:
         run: yarn install --immutable --immutable-cache --check-cache
 
       - name: run tests
-        run: yarn test
+        run: yarn test:int
 
       - name: update metadata in package.json
         uses: onlyutkarsh/[email protected]

.mocharc.js

@@ -0,0 +1,50 @@
+/**
+ * This configuration[1] is used when `mocha` is invoked directly
+ * from the command line.
+ *
+ * Note that this configuration does not affect tests
+ * when they are executed through `runTests`.
+ *
+ * [1] https://mochajs.org/#configuring-mocha-nodejs
+ */
+module.exports = {
+  /**
+   * From `mocha -h`
+   *
+   * ```txt
+   * --require, -r                    Require module      [array] [default: (none)]
+   * ```
+   */
+  require: [
+    // We use `ts-node/register`[1] to run our tests without compiling them.
+    //
+    // [1] https://typestrong.org/ts-node/docs/recipes/mocha/#mocha-7-and-newer.
+    'ts-node/register',
+
+    // This option is used to provide a drop-in replacement for the `vscode` module.
+    // When running `mocha` tests without a VS Code Development Extension Host[1],
+    // the `vscode` module is not available, so we need to provide a test replacement.
+    //
+    // See `test/vscode-register.ts` for more details on how this is implemented.
+    //
+    // This answer[2]'s 'bonus track' section was used as a inspiration for this method,
+    // to run code before the tests begin.
+    //
+    // [1] https://code.visualstudio.com/api/working-with-extensions/testing-extension
+    // [2] https://stackoverflow.com/questions/10561598/global-before-and-beforeeach-for-mocha/51152004#51152004
+    'test/vscode-register.ts',
+  ],
+
+  /**
+   * From `mocha -h`
+   *
+   * ```txt
+   * spec  One or more files, directories, or globs to test
+   *                                                    [array] [default: ["test"]]
+   * ```
+   */
+  spec: [
+    // These are the same test files covered by the VS Code Host test runner.
+    'test/**/*.test.ts',
+  ],
+};

.vscodeignore

@@ -3,18 +3,15 @@
 .vscode/**
 .vscode-test/**
 coverage/**
-drizzleUI/**
 node_modules/**
 out/**
 !out/src/mscorlib.js
 !out/src/Nethereum.Generators.DuoCode.js
 !out/src/extension.js
 !out/src/debugger.js
-!out/src/web3ProviderResolver.js
 !out/src/checkTruffleConfigTemplate.js
 src/**
 test/**
-ui-test/**
 .editorconfig
 .gitignore
 .npmignore
@@ -23,6 +20,7 @@ ui-test/**
 **/*.map
 **/*.ts
 **/webpack.*.js
+**/.mocharc.js
 **/coverconfig.json
 .husky/**
 **/GitVersion.yml

CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to the "Truffle for VSCode" extension will be documented in this file.
 
+## 2.5.0 - _Haiku_ 😈
+
+This release has improved support to debug over a forked network and working with multiple Truffle projects in the same workspace.
+The brand new Walkthrough helps users to explore and discover the main features of the extension.
+Moreover, it has some bug fixes, internal optimisations, and code refactor for better maintainability.
+
+Give it a try and let us know what you think!
+
+### What's Changed
+
+- Ability to debug over a forked network [\#186](https://github.com/trufflesuite/vscode-ext/pull/186) ([xhulz](https://github.com/xhulz))
+- Use `contracts_directory` from Truffle config in `Create Contract` command [\#193](https://github.com/trufflesuite/vscode-ext/pull/193) ([acuarica](https://github.com/acuarica))
+- Fix Command Palette display filter for Build/Deploy/Create Contracts commands [\#192](https://github.com/trufflesuite/vscode-ext/pull/192) ([acuarica](https://github.com/acuarica))
+- Add support to run out tests without VS Code Development Extension Host [\#191](https://github.com/trufflesuite/vscode-ext/pull/191) ([acuarica](https://github.com/acuarica))
+- Add support for multiple Truffle config files [\#181](https://github.com/trufflesuite/vscode-ext/pull/181) ([acuarica](https://github.com/acuarica))
+- Honor the `contract_build_directory` property in Deployments view [\#179](https://github.com/trufflesuite/vscode-ext/pull/179) ([acuarica](https://github.com/acuarica))
+- Ability to compile a single contract [\#177](https://github.com/trufflesuite/vscode-ext/pull/177) ([xhulz](https://github.com/xhulz))
+- Dashboard link has added to dashboard view panel [\#172](https://github.com/trufflesuite/vscode-ext/pull/172) ([xhulz](https://github.com/xhulz))
+- Debug only works with Ganache Development Instance [\#170](https://github.com/trufflesuite/vscode-ext/pull/170) ([xhulz](https://github.com/xhulz))
+- Add a Walkthrough on the Getting Started splash [\#148](https://github.com/trufflesuite/vscode-ext/pull/148) ([acuarica](https://github.com/acuarica))
+- Replace `open` package with `vscode.env.openExternal` [\#195](https://github.com/trufflesuite/vscode-ext/pull/195) ([acuarica](https://github.com/acuarica))
+- Always use the embedded Debug Adapter [\#218](https://github.com/trufflesuite/vscode-ext/pull/218) ([acuarica](https://github.com/acuarica))
+
 ## 2.4.0 - _Goblins_ 😈
 
 This release has some fixes around internal optimisations for our CI/Linting and cleanup of code where we were seeing issues with building contracts in mono repos etc.

README.md

@@ -142,7 +142,8 @@ besu: {
 
 ## Development
 
-We welcome pull requests. To get started, just fork this repo, clone it locally, and run:
+We welcome pull requests.
+To get started, just fork this repo, clone it locally, and run:
 
 ```shell
 # Install
@@ -151,6 +152,9 @@ yarn install
 
 # Test
 yarn test
+
+# Integration Test
+yarn test:int
 ```
 
 There are more docs online at the VS Code website on how to develop plugins at the [VS Code Docs - Extension API](https://code.visualstudio.com/api).