packagecontrol / packagecontrol/thecrawl

Repositories of schema v4 can have arbitrary includes

Open
#303 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

crawler discussion
Dominant language
Python
Stars
19
Forks
7
Avg merge
4h 53m
Merged PRs (30d)
14

Description

With regards to https://github.com/packagecontrol/thecrawl/blob/a42b390b4b90937a7637d635bbb939528b753d55/lib-spec.md?plain=1#L15

Any repository.json of schema v4 may include other repositories recursively via "includes": ["other-repository.json"].

{
  "$schema": "sublime://packagecontrol.io/schemas/repository",
  "schema_version": "4.0.0",
  "packages": [],
  "libraries": [ ... ],
  "includes": []
}

I haven't investigated the details, but as a general note (If it is already the case than please nevermind): The crawler should be able to fully crawl a repository and extract both, packages and libraries. The default channel for instance just includes a dependencies.json aka libraries.json with libraries into its main repository.json. Beyond that any (3rd-party?) repository may contain both as well. It should resolve any value of "includes": [] and include its content into results.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with lib-spec.md at the linked schema v4 reference and inspect how repository.json, including dependencies.json or libraries.json, is represented. Trace the default channel's includes example and determine how recursive includes should be resolved. Done means repositories can include arbitrary nested repositories and the results contain both packages and libraries from the included content.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.