diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index e194da10..47a3380d 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -24,10 +24,10 @@ jobs: with: node-version: 20 - - uses: pnpm/action-setup@v3 + - uses: pnpm/action-setup@v4 name: Install pnpm with: - version: 9 + version: 9.15.4 run_install: false - name: Get pnpm store directory @@ -42,7 +42,7 @@ jobs: restore-keys: ${{ runner.os }}-pnpm-store- - name: Install dependencies - run: pnpm install --frozen-lockfile + run: pnpm install - name: Build website run: pnpm build diff --git a/.github/workflows/release-extension.yml b/.github/workflows/release-extension.yml index 42c99665..4f40e17a 100644 --- a/.github/workflows/release-extension.yml +++ b/.github/workflows/release-extension.yml @@ -25,9 +25,9 @@ jobs: node-version: 20 - name: Install pnpm - uses: pnpm/action-setup@v3 + uses: pnpm/action-setup@v4 with: - version: 9 + version: 9.15.4 run_install: false - name: Get pnpm store directory @@ -43,7 +43,7 @@ jobs: - name: Install dependencies and vsce run: | - pnpm install --frozen-lockfile + pnpm install pnpm install -g vsce - name: Build extension diff --git a/.github/workflows/test-deploy-docs.yml b/.github/workflows/test-deploy-docs.yml index 38f3f966..563a2966 100644 --- a/.github/workflows/test-deploy-docs.yml +++ b/.github/workflows/test-deploy-docs.yml @@ -24,10 +24,10 @@ jobs: with: node-version: 20 - - uses: pnpm/action-setup@v3 + - uses: pnpm/action-setup@v4 name: Install pnpm with: - version: 9 + version: 9.15.4 run_install: false - name: Get pnpm store directory @@ -42,7 +42,7 @@ jobs: restore-keys: ${{ runner.os }}-pnpm-store- - name: Install dependencies - run: pnpm install --frozen-lockfile + run: pnpm install - name: Test build website id: build diff --git a/docs/docs/features/scout-github-action.md b/docs/docs/features/scout-github-action.md index 5ccc3bac..a782af42 100644 --- a/docs/docs/features/scout-github-action.md +++ b/docs/docs/features/scout-github-action.md @@ -36,6 +36,15 @@ jobs: - uses: mshick/add-pr-comment@v2.8.2 with: message-path: ${{ github.workspace }}/report.md + + # Optional: Add the following step to block the merge of the commit if Scout finds any issues. + + - name: Check for error + run: | + if [ -f "${{ github.workspace }}/FAIL" ]; then + echo "Error: Scout found issues." + exit 1 + fi ``` ## Considerations diff --git a/docs/docs/features/vs-code-extension.md b/docs/docs/features/vs-code-extension.md index 46f92015..92ccc1e5 100644 --- a/docs/docs/features/vs-code-extension.md +++ b/docs/docs/features/vs-code-extension.md @@ -8,7 +8,21 @@ Add Scout to your development workspace with our VS Code extension and run Scout ![Scout VS Code extension.](../../static/img/vscode-extension.png) -:warning: To ensure the extension runs properly, make sure that you open the directory containing your smart contract, rather than the entire project. For example, if your smart contracts are located in `myproject/contracts`, and you want to work on the `token` contract while using the Scout VS Code Extension, open `myproject/contracts/token`. +## Usage + +Once installed and enabled, the Scout Audit item appears in your VS Code status bar. + +![Scout VS Code extension.](../../static/img/scout-extension-status-bar.png) + +When you open a file that Scout can analyze, the Scout Audit item becomes enabled. Clicking it initiates the execution of Scout. + +The Scout Audit Output window provides additional details, such as relevant dependencies detected, the workspace being analyzed, and any errors encountered during execution. + +![Scout VS Code extension.](../../static/img/scout-extension-output.png) + +All findings from Scout are displayed in the Problems window. + +![Scout VS Code extension.](../../static/img/scout-extension-findings-tab.png) :bulb: Tip: To see the errors highlighted in your code, we recommend installing the [Error Lens Extension](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens). diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 630748be..47832f37 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -29,6 +29,6 @@ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } -.cardDescription_PWke { +.cardContainer_fWXF p { display: none; } \ No newline at end of file diff --git a/docs/static/img/scout-extension-findings-tab.png b/docs/static/img/scout-extension-findings-tab.png new file mode 100644 index 00000000..7fb382bf Binary files /dev/null and b/docs/static/img/scout-extension-findings-tab.png differ diff --git a/docs/static/img/scout-extension-output.png b/docs/static/img/scout-extension-output.png new file mode 100644 index 00000000..11a86278 Binary files /dev/null and b/docs/static/img/scout-extension-output.png differ diff --git a/docs/static/img/scout-extension-status-bar.png b/docs/static/img/scout-extension-status-bar.png new file mode 100644 index 00000000..dd19fe67 Binary files /dev/null and b/docs/static/img/scout-extension-status-bar.png differ