search

essenciary / PkgSearch.jl

A Julia REPL utility for package discovery
MIT License
29 stars 2 forks source link

Missing packages from search #1

Open timholy opened 8 years ago

timholy commented 8 years ago

First, thanks very much for this package!

I was just kicking the tires on its "discovery" capabilities for unregistered packages, and noticed the following apparent misses among my own packages (which are obviously natural candidates for me to try):

essenciary commented 8 years ago

@timholy Thanks for reporting, let me check.

essenciary commented 8 years ago

@timholy I've checked the database and the packages have not been imported. The issue being that:

  1. they are not official packages. That is they're not part of METADATA. These are included by default.
  2. a GitHub search is performed, looking for Julia repos and looking for the text "Pkg." in the README. The GitHub search is a bit naive at the moment. Basically, I needed a way to somehow separate "installable" packages from "regular" Julia scripts. Hence I assumed that there will be some installation instructions, either in the form of Pkg.add(...) or Pkg.clone(...). Your packages READMEs don't include either.

Do you have any ideas on how to extend the search to differentiate packages from plain scripts? I'd be happy to extend the search to include it.

essenciary commented 8 years ago

Another naive way of performing the search, but possibly better, would be to search for all Julia repos but only keep the ones ending in ".jl"?

timholy commented 8 years ago

I like the idea of keeping the ".jl" ones. (Speaking of which, this repo should be renamed PkgSearch.jl.)

timholy commented 8 years ago

You could also check for repos that have a test folder?

tkelman commented 8 years ago

The test we use on Travis for language: julia is if the repo has a file at src/PkgName.jl, where PkgName is the repo name, minus the trailing .jl if present. Not sure if github search is capable of expressing this easily.

essenciary commented 8 years ago

I've updated the GitHub search to look for Julia repos named with ".jl" - this seems to be a convention that's applied consistently. Yes, good point, I've renamed my packages as well 👍

So it definitely indexed a lot more this time, some problems still present, I'll keep digging.

essenciary commented 8 years ago

@tkelman Good one thanks, I'll give it a try to see if it works.