spec Log File Extension for Visual Studio Code

The extension is designed to assist a user in browsing spec log files with Visual Studio Code. The term log files here indicates files created when spec software is launched with -l option (e.g., fourc -l 20210414.tlog).

spec does not specify the filename extension of log files. While this VS Code extension by default treats .tlog as the file extension of log files (language identifier: spec-log), users can change the association by themselves. Read Language Support in Visual Studio Code (official document of VS Code) for further details.

What's spec?

spec is internationally recognized as the leading software for instrument control and data acquisition in X-ray diffraction experiments. It is used at more than 200 synchrotrons, industrial laboratories, universities and research facilities around the globe.

cited from CSS - Certified Scientific Software homepage.

Note that the extension is not the official one developed by Certified Scientific Software. Use GitHub issues for bug reports and feature requests about the extension.

Features

• Syntax highlighting
• Code navigation : prompts such as 1.FOURC> and scans are regarded as breadcrumbs.
  • Show all symbol definitions within a document
• Code folding : continous lines that only contains numbers or time are foldable, in addition to prompts.
• Document links : Make a file path in a scan header a clickable link. The path is relative to the workspace, not to the log file.

Tips

With this extension, one can show only the lines of spec prompts (i.e., what you typed) and hide the other lines. To do so, use "Fold Level 2" command or its equivalent Keyboard shortcut, Ctrl+K Ctrl+2 (Windows/Linux) or Command+K Command+2 (macOS).

Known Issues

See GitHub Issues.

Release Notes

See CHANGELOG.md.

Contributing

The extension is open to contributions. Create an issue in GitHub Issues for a bug report or a feature request. If you want to contribute code, please read CONTRIBUTING.md.