Skip to content

Implement libraries.io support for pre-commit #345

Open

Description

@asottile

Activity

  1. paulhfischer commented on Dec 19, 2020

    @paulhfischer
    Contributor

    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.

  2. asottile commented on Dec 22, 2020

    @asottile
    MemberAuthor

    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)

  3. paulhfischer commented on Dec 22, 2020

    @paulhfischer
    Contributor

    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": ["coffeelint@2.1.0"],
                "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'
        }
    ]
  4. asottile commented on Dec 22, 2020

    @asottile
    MemberAuthor

    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 🤔

  5. paulhfischer commented on Dec 22, 2020

    @paulhfischer
    Contributor

    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.

  6. asottile commented on Dec 22, 2020

    @asottile
    MemberAuthor

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

  7. paulhfischer commented on Dec 22, 2020

    @paulhfischer
    Contributor

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

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

  8. paulhfischer commented on Dec 22, 2020

    @paulhfischer
    Contributor

    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

  9. asottile commented on Dec 22, 2020

    @asottile
    MemberAuthor

    feel free to skip additional_dependencies 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions