pre-commit.com icon indicating copy to clipboard operation
pre-commit.com copied to clipboard

Implement libraries.io support for pre-commit

Open asottile opened this issue 5 years ago • 9 comments

  • https://github.com/librariesio/libraries.io/blob/master/docs/add-a-package-manager.md
  • can likely use all-repos.json and maybe(?) take some inspiration from the go implementation for libraries.io (since the distribution mechanism is similar)

asottile avatar May 19 '20 22:05 asottile

have a look at this commit, i used the all-repos.json file and parsed all attributes of the hooks (fallback are the default values listed on pre-commit.com).

let me know if this is what you've imagined and if you have comments on it.

paulhfischer avatar Dec 19 '20 15:12 paulhfischer

looks like a good start! I imagine the version information would be useful as well -- is there a second mechanism for parsing .pre-commit-config.yaml from consuming repositories? to be honest I can't remember why this was useful (I think it was so a third party could integrate with showing packaging mappings / use)

asottile avatar Dec 22 '20 03:12 asottile

the reason why i commented out the self.version method is because libraries.io then automatic gets the latest tag (either you define your one version or it uses git tags. this can also be seen in the compatibility matrix). this is similar to the emacs-packages.

not sure if i understood you correct regarding consuming repositories: do you mean parsing the additional_dependencies-field? i can add this for all languages that are listed in libraries.io (node, python via pypi, go). Here's an example of what i mean:

{
    "https://github.com/pre-commit/mirrors-coffeelint": [
        {
            "id": "coffeelint",
            "name": "coffeelint",
            "entry": "coffeelint",
            "language": "node",
            "files": "\\.(js|coffee)$",
            "args": [],
            "additional_dependencies": ["[email protected]"],
            "minimum_pre_commit_version": "0.7.0"
        }
    ]
}

would return the following in self.dependencies:

[
    {
        project_name: 'coffeelint',
        requirements: 2.1.0,
        kind: 'runtime',
        platform: 'npm'
    }
]

paulhfischer avatar Dec 22 '20 08:12 paulhfischer

ah no not additional_dependencies (though maybe that's worth doing too? idk?) -- I was thinking more like if you looked at https://github.com/asottile/t for example it would have dependencies on github.com/pre-commit/pre-commit-hooks, ... based on its consuming .pre-commit-config.yaml

I don't know how that gets represented in libraries.io though 🤔

asottile avatar Dec 22 '20 15:12 asottile

oh ok, if i understood the documentation correct, this is done by bibliothecary (if you log in to libraries.io, this will check your repositories for dependencies). i added pre-commit to bibliothecary here.

paulhfischer avatar Dec 22 '20 16:12 paulhfischer

neat, that looks good -- though you'll want to skip repo: meta and repo: local

asottile avatar Dec 22 '20 16:12 asottile

neat, that looks good -- though you'll want to skip repo: meta and repo: local

yeah thanks, i'm going to to change this.

paulhfischer avatar Dec 22 '20 16:12 paulhfischer

i just tried adding the parsing of additional_dependencies, but encountered two problems:

  1. most languages have multiple package managers in libraries.io, but we are required to specify which one the dependency uses. it would be possible to search for the corresponding package manager in libraries.io, but this would be quite expensive and might cause errors if the same name is specified in multiple package managers
  2. the dependencies wouldn't be consistent, as not all additional_dependencies can be found on libraries.io, which kind of ruins the purpose imo

let me know what you think about adding this or if you have any suggestions

paulhfischer avatar Dec 22 '20 17:12 paulhfischer

feel free to skip additional_dependencies 👍

asottile avatar Dec 22 '20 19:12 asottile