GithubHelp home page GithubHelp logo

cqse / teamscale-cli Goto Github PK

View Code? Open in Web Editor NEW
8.0 8.0 6.0 1.59 MB

A Teamscale command line interface to integrate findings into text editors such as vim, emacs or sublime.

License: Apache License 2.0

Python 97.50% Vim Script 2.30% Makefile 0.20%
command-line-tool emacs software-quality sublime teamscale vim

teamscale-cli's People

Contributors

albertsteckermeier avatar alexrhein avatar anonymfx avatar bastihav avatar dependabot[bot] avatar dpagano avatar flamejam avatar heinemann-cqse avatar hummelb avatar jmflorezff avatar karottenreibe avatar ke-kx avatar macariel avatar mpdeimos avatar nihathrael avatar nkhater avatar sewe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

teamscale-cli's Issues

Improve Error Handling

There are several things that can go wrong when trying to run the CLI from an IDE. All of these are really hard to debug at the moment:

  • CLI might not be able to figure out where the Git root is
  • CLI might not be able to find its config file

In these cases, ATM we log unhelpful error messages like

No valid config found

Or

Invalid path to file in repository: None

These don't give any clue to the user as to what they misconfigured. This makes setting up the CLI a trial-and-error game where you move around files and change command line settings like a crazy person for 20 minutes until you find the right combination by accident.

Instead I'd like to do the following:

When the config file can't be found, log all paths where the CLI tried to search for one.

When the git repo root can't be found, log every folder that was checked and why it wasn't considered as a git root.

In both cases, please provide clear instructions how the user can fix the problem. E.g:

Please place the .teamscale-precommit.config file in the folder XYZ

Or

None of the following paths seem to contain a git repository:
/A/B/C
/A/B
/A
Please make sure the path you provided on the command line points to a file or folder inside the git repository.

We should in addition go through the other error handling in the plugin and make sure any other errors have helpful error messages.

Submodules don't work

The plugin apparently doesn't recognize the submodule itself as a valid git repo and it also doesn't recognize the parent. Thus precommit for files in the submodule doesn't work, even though you can enable submodule support in Teamscale

Travis CI would not build, libgit incompatibility

The build for python 2.7 (which is unsupported since about a month) is failing because the available libgit version is not matching the requirements of the pygit module.
This also happens for Python 3.4

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.