feat: create clarinet-sdk testing boilerplate (#1158)

* feat: create clarinet-sdk testing boilerplate

* refactor: remvoe useless shebang

* fix: typo in components/clarinet-sdk/src-ts/bin/index.ts

Co-authored-by: janniks <[email protected]>

---------

Co-authored-by: janniks <[email protected]>

Author: hugocaillard

components/clarinet-sdk/README.md

@@ -45,134 +45,35 @@ It's also possible to provide the path to the manifest like so:
 
 ## Tests
 
-> Note: A bit of boilerplate is needed to setup the testing environment. Soon it will be handled by the clarinet-cli.
-
-The SDK can be used to write unit-tests for Clarinet projects.  
-Make sure you are in directory with a Clarinet.toml file and the associated Clarity smart contracts:
-
-```sh
-cd ./my-project
-ls # here you should see the Clarinet.toml file
-```
+The SDK can be used to write unit tests for Clarinet projects.  
 
-Let's initialize the Node.js project:
-```sh
-npm init -y # the -y option sets default properties
-npm install @hirosystems/clarinet-sdk @stacks/transactions vite vitest vitest-environment-clarinet
-```
-
-Update the package.json file scripts to handle tests:
-```json
-  "scripts": {
-    "test": "vitest run",
-    "test:coverage": "vitest run -- --coverage true"
-  },
-```
+You'll need to have Node.js (>= 18) and NPM setup. If you are not sure how to set it up, [Volta](https://volta.sh/) is a nice tool to get started.
 
-The `./.gitignore` file also needs to be updated, add the following lines at the end. It is especially important to ignore `node_modules`.
-```
-logs
-*.log
-npm-debug.log*
-coverage
-*.info
-node_modules
-```
+In the terminal, run `node --version` to make sure it's available and up to date.
 
-A config file is needed for Vitest to use the clarinet-environment.
-Create the file `vitest.config.js` with the following content:
-```js
-/// <reference types="vitest" />
-
-import { defineConfig } from "vite";
-import { vitestSetupFilePath, getClarinetVitestsArgv } from "@hirosystems/clarinet-sdk/vitest";
-
-export default defineConfig({
-  test: {
-    environment: "clarinet",
-    singleThread: true,
-    setupFiles: [vitestSetupFilePath],
-    environmentOptions: {
-      clarinet: getClarinetVitestsArgv(),
-    },
-  },
-});
-```
+> Note: A bit of boilerplate is needed to setup the testing environment. Soon it will be handled by the clarinet-cli.
 
-The set up is ready, let's write the first test. Create a test file in the `unit-tests` directory:
+Open your terminal and go to a new or existing Clarinet project:
 
 ```sh
-mkdir unit-tests
-touch unit-tests/my-contract.test.js
-```
-
-```js
-// unit-tests/my-contract.test.js
-import { describe, it, expect } from "vitest";
-import { Cl } from "@stacks/transactions";
-
-describe("test counter ONE", () => {
-  const accounts = vm.getAccounts();
-  const w1 = accounts.get("wallet_1");
-  if (!w1) throw new Error("wallet_1 does not exist");
-
-  it("adds two numbers", () => {
-    const callAdd = vm.callPublicFn("my-contract", "add", [Cl.uint(21), Cl.uint(21)], w1);
-    expect(callAdd.result).toBeOk(Cl.uint(42));
-  });
-});
-
+cd my-project
+ls # you should see a Clarinet.toml file in the list
 ```
 
-### Notes: 
+Run the following command to setup the testing framework:
 
-- This code assumes that you have a contract called `my-contract` with a method `add`.
-```clar
-;; contracts/my-contract.clar
-(define-public (add (n1 uint) (n2 uint))
-  (ok (+ n1 n2))
-)
+```sh
+npx @hirosystems/clarinet-sdk
 ```
 
-- You may need to disable the deno extension if it's activated in `.vscode/settings.json`.
+Visit the [clarity starter project](https://github.com/hirosystems/clarity-starter/tree/170224c9dd3bde185f194a9036c5970f44c596cd) to see the testing framework in action.
 
 
 ### Type checking
 
-You can use TypeScript to write test by installing it and setting up the `tsconfig.json`.
-
-```sh
-npm install typescript
-touch tsconfig.json
-```
-
-```json
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["ESNext"],
-    "skipLibCheck": true,
-
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-
-    "strict": true,
-    "noImplicitAny": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "include": ["node_modules/@hirosystems/clarinet-sdk/vitest-helpers/src", "unit-tests"]
-}
-
-```
+We recommend to use TypeScript to write the unit tests, but it's also possible to do it with JavaScript. To do so, rename your test files to `.test.js` instead of `.test.ts`. You can also delete the `tsconfig.json` and uninstall typescript with `npm uninstall typescript`. 
 
-If you want to write your test in JavaScript but still have a certain level of type safety and autocompletion, VSCode can help you with that. You can create a basic `jsconfig.json` file:
+Note: If you want to write your test in JavaScript but still have a certain level of type safety and autocompletion, VSCode can help you with that. You can create a basic `jsconfig.json` file:
 
 ```json
 {