Skip to content

feat(manual): add troubleshooting.md #314

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Feb 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,22 +218,7 @@ Setup steps:

## Troubleshooting

Common issues:

- Path to the language server is incorrect
- Node.js is not installed
- Language server wasn't built properly

### Logs Location

The language server generates logs that can help diagnose issues:

- For standalone server: logs are written to `dist/tact-language-server.log` in the language server directory
- For VS Code extension: logs can be found in:
- Windows: `%USERPROFILE%\.vscode\extensions\tact-[version]\dist\tact-language-server.log`
- macOS/Linux: `~/.vscode/extensions/tact-[version]/dist/tact-language-server.log`

For more help, please [open an issue](https://github.com/tact-lang/tact-language-server/issues).
See [TROUBLESHOOTING.md](./docs/manual/troubleshooting.md).

# License

Expand Down
92 changes: 92 additions & 0 deletions docs/manual/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Troubleshooting Guide

This guide helps you resolve common issues with the Tact Language VS Code extension and Language Server in general.

## Common Issues

### Extension Not Working

If the extension is not working as expected:

1. Make sure you have the latest version of VS Code installed
2. Try reloading VS Code (Command Palette > **`Developer: Reload Window`**)
3. Check the extension is enabled (**Extensions** view > search for "Tact")
4. Check if any other Tact extensions are disabled to avoid conflicts

### Standard Library Not Found

If you see the error "Tact standard library is missing! Try installing dependencies with 'yarn/npm install' or specify
`tact.stdlib.path` in settings":

1. First, try installing dependencies in your project:

```bash
yarn install
# or
npm install
```

2. If this doesn't help, try set `tact.stdlib.path` in settings:

- Open VS Code **Settings**
- Search for **"Tact: General › Stdlib Path"**
- Set the path to your stdlib directory

3. After making any changes:
- Reload VS Code window (Command Palette > **`Developer: Reload Window`**)
- Or restart VS Code completely

### Installing Previous Version

If you encounter issues with the latest version, you can install a previous version:

1. Open Command Palette in VS Code (`Ctrl+Shift+P` / `Cmd+Shift+P`)
2. Type and select **"Extensions: Install Specific Version of Extension..."**
3. Select "Tact Language" from the list
4. Choose the version you want to install from the dropdown
5. VS Code will automatically uninstall current version and install the selected one

To prevent automatic updates:

- Open VS Code **Settings**
- Search for **"Extensions: Auto Update"**
- Uncheck the option to disable automatic updates
- Or add this to your settings.json:
```json
"extensions.autoUpdate": false
```

### Finding Logs

The language server generates logs that can help diagnose issues:

For VS Code extension, logs can be found in:

- Windows: `%USERPROFILE%\.vscode\extensions\tonstudio.vscode-tact-[version]\dist\tact-language-server.log`
- macOS/Linux: `~/.vscode/extensions/tonstudio.vscode-tact-[version]/dist/tact-language-server.log`

Also, you can view extension logs directly in VS Code:

1. Open **"View > Output"** menu (or press `Ctrl+Shift+U` / `Cmd+Shift+U`)
2. Select **"Tact"** from the dropdown menu in the Output panel

These logs are helpful when reporting issues on GitHub.

## Reporting Issues

If you encounter an issue not covered here:

1. Check the [GitHub Issues](https://github.com/tact-lang/tact-vscode/issues) to see if it's already reported
2. If not, create a new issue with:
- VS Code version
- Extension version
- Steps to reproduce
- Error messages (if any)
- Logs from the language server (see above)
- Logs from the extension (see above)
- Your project's configuration files

## Getting Help

- Ask questions in the [Tact Language Group](https://t.me/tactlang)
- Check the [Tact Documentation](https://docs.tact-lang.org)