search

apjanke / vscode-octave-hacking

VS Code extension for GNU Octave programming
https://marketplace.visualstudio.com/items?itemName=apjanke.octave-hacking
MIT License
11 stars 3 forks source link
octave vscode-extension

readme

Octave Hacking

Octave Hacking is an attempt to turn VS Code into a decent IDE for GNU Octave.

Features

Installation

To install Octave Hacking in your VS Code, get it on the Visual Studio Code Marketplace, or search for "octave hacking" in the Extensions tab of VS Code.

Debugging

Octave Hacking does not support debugging Octave inside VS Code. For that, I recommend you install the Octave Debugger extension by Paulo Silva.

Examples

Screenshot of Octave Hacking VS Code extension

Code navigation!

Screencast of Octave Hacking navigation using Outline View

Snippets!

Screencast of Octave Hacking snippets in action

Compatibility

This extension may conflict with the Matlab extensions in the VS Code Marketplace. I’ve found that when I have the Matlab extensions installed, even when they are disabled, sometimes Octave Hacking will not activate when opening a .m file. I'm looking in to this. In the mean time, if you’re having trouble getting Octave Hacking to work, try uninstalling (not just deactivating) any Matlab VS Code extensions.

Background

GNU Octave is a scientific programming language for numerical analysis that is largely compatible with MATLAB. It is free software, cross-platform, and has pervasive support for arrays.

The Octave Hacking extension may be particularly useful to Mac users, because the Octave GUI for newer versions of Octave (5.x and 6.x) does not work correctly on macOS. VS Code with this extension and a debugging extension could be a good substitute.

Extension Settings

Nothing yet.

License

Octave Hacking is published under the open-source MIT License.

The original TextMate Octave grammar on which Octave Hacking's syntax is based is published under a custom, but (I think) MIT-compatible license. That TextMate grammar license text is:

Permission to copy, use, modify, sell and distribute this
software is granted. This software is provided "as is" without
express or implied warranty, and with no claim as to its
suitability for any purpose.

Author

Octave Hacking is written by Andrew Janke. The project home page is https://github.com/apjanke/vscode-octave-hacking.

Thank you to the GNU Octave folks for writing Octave!

Octave Hacking logo produced by funny.pho.to's Matrix Image Generator, based on the original Octave logo by the Octave Developers.

The grammar for syntax highlighting is a lightly customized version of the TextMate Octave.tmLanguage grammar.

Andrew is also the maintainer of Octave.app, a "native Mac app" distribution of GNU Octave. The Octave Hacking VS Code extension is compatible with Octave.app.

Contributing

Development happens on GitHub at https://github.com/apjanke/vscode-octave-hacking.

Bug reports, feature requests, and bugfix PRs are welcome. For other changes, like adding new features or code design changes, please post an issue in the issue tracker on GitHub to discuss it first.