Git Product home page Git Product logo

sublimelinter-contrib-mypy's Introduction

SublimeLinter-contrib-mypy

Build Status

This linter plugin for SublimeLinter provides an interface to mypy. It will be used with files that have the "python" syntax.

Installation

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

Linter installation

Before using this plugin, you must ensure that mypy is installed on your system. To install mypy, do the following:

  1. Install Python and pip.

  2. Install mypy by typing the following in a terminal:

    [sudo] pip install mypy
    

Note: This plugin requires mypy 0.520 or later.

Linter configuration

In order for mypy to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured mypy, you can proceed to install the SublimeLinter-contrib-mypy 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 (Tools → Command Palette…) and select Package Control: Install Package. There may be a pause of a few seconds while Package Control fetches the list of available packages.

  2. When the package list appears, select SublimeLinter-contrib-mypy.

Settings

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

Following is a list of additional settings specific to this linter:

Setting Description
cache-dir The directory to store the cache in. Creates a sub-folder in your temporary directory if not specified.
follow-imports Whether imports should be followed and linted. The default is silent, but skip may also be used. The other options are not interesting.

All other args to mypy should be specified in the args list.

sublimelinter-contrib-mypy's People

Contributors

fichtefoll avatar fredcallaway avatar gerardroche avatar afrieder avatar kaste avatar alex20465 avatar gomzik avatar anishpatel avatar pirate avatar strml avatar lfuhr avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.