JuliaCI/PkgTemplates.jl

check if name is similar to existing package?

Open

#292 opened on May 9, 2021

View on GitHub
 (6 comments) (5 reactions) (0 assignees)Julia (697 stars) (112 forks)batch import
help wantednew-feature

Description

One can use

using RegistryCI
using RegistryCI.AutoMerge
function is_far_from_existing_names(name)
    path_to_registry = joinpath(DEPOT_PATH[1], "registries", "General")
    all_pkg_names = AutoMerge.get_all_non_jll_package_names(path_to_registry)
    return AutoMerge.meets_distance_check(name, all_pkg_names)
end

to check if a proposed package name will pass AutoMerge's check about package names (as documented in the General registry's README, https://github.com/JuliaRegistries/General#automatic-merging-of-pull-requests).

I thought it could be helpful if PkgTemplates (perhaps optionally) runs this check at package-creation time. It could also support multiple registries (although obviously AutoMerge for General only looks at General, it can still be good to know if there are similar names in another registry you are using), e.g.

using RegistryCI
using RegistryCI.AutoMerge
function is_far_from_existing_names(name)
    names = String[]
    for registry in readdir(joinpath(DEPOT_PATH[1], "registries"); join=true)
        append!(names, AutoMerge.get_all_non_jll_package_names(registry))
    end
    return AutoMerge.meets_distance_check(name, names)
end

(Perhaps we should add a real API for this in RegistryCI though, if it's going to be used programatically)

Contributor guide

Tech stack
None
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia programmingPkgTemplates usageRegistryCI knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Implement a check in PkgTemplates that uses RegistryCI.AutoMerge functions to verify if a proposed package name is similar to existing names in the General registry (and optionally other registries). Look at the RegistryCI source for AutoMerge.get all non jll package names and AutoMerge.meets distance check. Consider adding a simple toggle to enable the check during template generation. The issue suggests optionally supporting multiple registries. Review existing PkgTemplates code structure for where to add this feature.