ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-epcomp

by veelo ST3

SublimeLinter plugin for epcomp from the Prospero Extended Pascal compiler.

Details

Installs

  • Total 18
  • Win 13
  • OS X 4
  • Linux 1
May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11
Windows 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 1 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0
OS X 0 2 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-epcomp

Build Status

This linter plugin for SublimeLinter provides an interface to epcomp, the Prospero Extended Pascal 3.2 compiler. It will be used with files that have the “pascal” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that Prospero Extended Pascal is installed on your system. Currently it is not easy to get hold of this legacy commercial compiler, but if you are interested in this linter, you probably already have access to it. The compiler does the linting.

Note: This plugin requires epcomp from Prospero Extended Pascal v3.2.07 or later.

Linter configuration

In order for epcomp to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. This can be done in two ways:

  1. Read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation. Or:

  2. Select Tools -> SublimeLinter -> Open User Settings and locate the "user": "linter": "epcomp": section, then add the "epbin" entry, like so:

    "epcomp": {
        "@disable": false,
        "args": [],
        "epbin": "C:\\extpas32\\bin",
        "excludes": []
    }
    

    Note the use of escaped backslashes. Trailing backslashes are optional. Restart Sublime Text for this setting to take effect.

Once you have installed and configured epcomp, you can proceed to install the SublimeLinter-contrib-epcomp plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type epcomp. Among the entries you should see SublimeLinter-contrib-epcomp. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-contrib-epcomp provides its own settings.

Setting Description Inline Setting
options A list of options to pass to epcomp.
epbin Optional path to the epcomp binary, see above. Not available as project setting.
ignore Ignore warnings. Supported value: possible-unclosed-comment.

Implementing per-project settings

Typically you will want to configure the linter with the same options as the compiler, on a per-project basis. This can be conveniently accomplished in your project settings using Settings Tokens.

For example, let’s say the interface files of your project are in the subdirectory source\obj:

  • If you have not already created a project in Sublime Text, select Project -> Save Project As....

  • Select Project -> Edit Project.

  • At the top level of the project’s JSON data, add the following:

    "SublimeLinter":
    {
        "linters":
        {
            "epcomp":
            {
                "options": ["-i${project}\\source\\obj", "-o${project}\\source\\obj"]
            }
        }
    }
    
  • Save the file.

Any time you edit the project and change a linter’s settings, all open files that use that linter will be re-linted to reflect the new settings.

Ignoring warnings per-file

The message Warning: possible unclosed comment can be ignored on a global or project level with the following setting:

"ignore": "possible-unclosed-comment"

The same can be accomplished per individual file by adding the following line in your code:

{[SublimeLinter epcomp-ignore:possible-unclosed-comment]}

or

{[SublimeLinter epcomp-ignore:282]}

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!