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

  • 1.1.0
  • github.​com
  • github.​com
  • 2 months ago
  • 15 minutes ago
  • 9 months ago

Installs

  • Total 68
  • Win 46
  • OS X 16
  • Linux 6
Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4
Windows 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 0 1 0 0 0 4 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 1 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
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 0 0 0 1 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 values: "possible-unclosed-comment" or error codes like: ["282", "283"].

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!