Skip to content
Sublime Text 3 plugin for CS-Script
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin - Issue #2: Add settings for disabling tooltip over gutter Aug 23, 2018
docs
images Preparation steps for publishing Mar 5, 2017
imports Issue #1: CS-Script Hangs Sublime Text for a Few Seconds Oct 31, 2017
messages
.no-sublime-package
Context.sublime-menu
Default.sublime-keymap
LICENSE Added third-party licences notice Mar 30, 2017
Main.sublime-menu Added handling of changed package name (cs-srcript-sublime) Feb 27, 2017
OtherLicenses.md
README.md
Terminal.sh Initial revision Feb 26, 2017
cs-script.py - Issue #2: Add settings for disabling tooltip over gutter (3) Aug 23, 2018
cs-script.sublime-commands
cs-script.sublime-settings - Issue #2: Add settings for disabling tooltip over gutter (2) Aug 23, 2018
messages.json

README.md

CS-Script.ST3

CS-Script (C# intellisense) plugin for Sublime Text 3. The true C# intellisense and script execution solution, based on CS-Script and Roslyn.

CS-Script is a Open Source script engine for C# that delivers Pythons scripting experience for C# syntax. This plugin is a port/rework of the popular Notepad++ plugin CS-Script.Npp.


Required minimum system configuration:

  • Windows: .NET (v4.0/4.5)
  • Linux/OSX: Mono (v4.6)

This page is a light version of the complete overview of the plugin full functionality, which can be found on Wiki. This includes

  • Detailed description of CS-Script functionality
  • Support for C# 6 on Windows
  • Notes on deployment on OS X
  • ...

Installation

Note the plugin was developed and tested against ST3 but not ST2.

Package Control

The plugin is yet to be submitted to the Package Control.

Manual

  • Remove the package, if installed, using Package Control.
  • Add a repository: https://github.com/oleg-shilo/cs-script-sublime.git
  • Install cs-script-sublime with Package Control.
  • Restart Sublime editor if required

You can also install the plugin by cloning cs-script-sublime repository into your Packages folder or manually placing the download package there.

Mac users may need to do one extra step - read these instructions.

Overview

Plugin

The plugin allows convenient editing and execution of the C# code (scripts) directly from the editor. It brings the true C# intellisense experience that typically comes with full scale IDEs. This includes the usual "Completion suggestions", "Go to Definition", "Find all references" and many other features that can be found in Visual Studio. In the heart of the plugin are two core components CS-Script and Roslyn.

Roslyn is an Open Source .NET code analysis and compilation service. It is the very same syntax engine that another popular intellisense solution is built around - OmniSharp. The CS-Script plugin intellisense features are quite similar to what OmniSharp can deliver except that this plugin is more tuned up for the execution of generic scripts written with C#, while OmniSharp is usually (while not always) a part of the various ASP.NET toolsets.

CS-Script

CS-Script is a portable Open Source CLR based scripting system, which uses ECMA-compliant C# as a programming language. It allows execution of C# code directly without the need for a dedicated compilation step. It is arguably the most mature C# scripting solution available today. It was developed in 2004, two years after the very first .NET release. And it was on the scene many years before the first public release in 2014 of MS own compilation service (Roslyn) that eventually would deliver some elements of C# scripting.

CS-Script is enormously influenced by the Python execution model. A single script file is sufficient to execute a C# routine without dealing with any C# project infrastructure or pre-compilation of C# code. It's also possible to import/include other scripts and assemblies (DLLs). CS-Script is not an interpreted but rather a statically typed compiled environment and as such, when combined with advanced Python-like caching, it delivers an ultimate performance not only comparable but identical to the performance of the fully compiled .NET application.

C# scripting with Sublime

CS-Script ST3 plugin allows convenient editing and execution of the C# code directly from the editor. A C# script is any ECMA-compliant C# code. While any other C# based runtimes require C# code to be compiled into assemblies CS-Script allows direct C# execution by generating the assemblies on-fly. Thus you don't need to have any script specific configuration for executing your script. A single script file is fully sufficient as it contains everything that CS-Script needs to know to execute the script.

When your C# script depend on other (source and compiled) C# source modules you can express this in your code in a very simple way via //css_inc * (include) or //css_ref * (reference) directives. These directives are conceptually similar to Python import *, which appear on top of the script. CS-Script has only a handful directives that are easy to remember. However if you forgot them you can always invoke "Show CS-Script Help" or "Show Plugin Help" command either from context menu or from "Command Palette".

Alternatively you can place the cursor on the directive (e.g. //css_re|f) and press F12 to trigger "Go To Definition" command to get the full information about the directive.

And of course you can find the complete CS-Script documentation on GigHub: https://github.com/oleg-shilo/cs-script/wiki

You can’t perform that action at this time.