Skip to content

Commit

Permalink
Version bump and Update docs (#33)
Browse files Browse the repository at this point in the history
* Tweaked the readme and changelog.

* Tweaks to the readme.

* 1.3.0
  • Loading branch information
TwitchBronBron authored Nov 21, 2018
1 parent 56ae10d commit a0fd1a5
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 9 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Change Log

## [1.2.2] - 2018-09-26

## [1.3.0] - 2018-11-20
- Added support for declarations and symbols
- Added support for go to definition
- Added ability to format hightlighted code without formatting the whole document.
- Added new launch setting called 'debugRootDir' that allows deploying a build file, while still debugging a source file.
- Added command for switching between xml and brs files for a component.
- Added support for conditional statements without the `then`.
- Breakpoints added after a debug session is launched are now correctly show as disabled.

## [1.2.2] - 2018-09-26
- Upgraded to brightscript-formatter version 1.3.0 which brings support for formatting conditional compile statements.

## [1.2.1] - 2018-09-26
Expand Down
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ A VSCode extension to support Roku's BrightScript language.

- Syntax highlighting
- Code formatting (provided by [brightscript-formatter](https://github.com/TwitchBronBron/brightscript-formatter))
- Debugging support - debug your source code running on the Roku device from within VSCode
- Publish directly from VSCode to a roku device (provided by [roku-deploy](https://github.com/TwitchBronBron/roku-deploy))
- Debugging support - Set breakpoints, launch and debug your source code running on the Roku device all from within VSCode
- Publish directly to a roku device from VSCode (provided by [roku-deploy](https://github.com/TwitchBronBron/roku-deploy))
- Basic symbol navigation for document and workspace ("APPLE/Ctrl + SHIFT + O" for document, "APPLE/Ctrl + T" for workspace)
- Goto definition (F12)
- Peek definition (Alt+F12)


## Requirements
Expand Down Expand Up @@ -75,6 +78,47 @@ then you would need change `rootDir` in your launch config to look like this:
}
```

## Special Cases

### Debug source files with Custom build process

If you have a build process that moves files from a source directory to an output directory, by default you will need to place breakpoints in the output directory's versions of the files.

**IF** your build process does not change line numbers between source files and built files, this extension will allow you to place breakpoints in your source files, and launch/run your built files. Pair this with vscode's task system, and you can build your code, then launch and debug your code with ease.

**Example:**
- src/
- main.brs
- language.brs
- manifest
- languages/
- english.brs
- french.brs
- dist/
- main.brs
- language.brs
- manifest

Here's a sample launch.json for this scenario:

```
{
"version": "0.2.0",
"configurations": [
{
"type": "brightscript",
"request": "launch",
"name": "BrightScript Debug: Launch",
"host": "192.168.1.100",
"password": "password",
"rootDir": "${workspaceFolder}/dist",
"debugRootDir": "${workspaceFolder}/src",
"preLaunchTask": "your-build-task-here"
}
]
}
```

## Extension Settings

Expand All @@ -86,7 +130,7 @@ This extension contributes the following settings:

## Known Issues

This is a brand new extension, so there are probably tons of edge cases that haven't been tested yet.
Click [here](https://github.com/TwitchBronBron/vscode-brightscript-language/issues) to see the list of known issues.

## Changelog
Click [here](https://github.com/TwitchBronBron/vscode-brightscript-language/blob/master/CHANGELOG.md) to see the changelog.
Click [here](https://github.com/TwitchBronBron/vscode-brightscript-language/blob/master/CHANGELOG.md) to see the changelog.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "brightscript",
"displayName": "BrightScript Language",
"version": "1.2.2",
"version": "1.3.0",
"publisher": "celsoaf",
"description": "Language support for Roku's BrightScript language.",
"author": {
Expand Down Expand Up @@ -112,7 +112,7 @@
"rootDir": {
"type": "string",
"description": "The root directory that contains your Roku project. This path should point to the folder containing your manifest file",
"default": true
"default": "${workspaceFolder}"
},
"debugRootDir": {
"type": "string",
Expand All @@ -126,7 +126,7 @@
},
"stopOnEntry": {
"type": "boolean",
"description": "Automatically stop program after launch.",
"description": "Have the debugger break on on the first line of the program after launch.",
"default": true
},
"retainStagingFolder": {
Expand Down

0 comments on commit a0fd1a5

Please sign in to comment.