Skip to content

clean_tags

clean_tags(pkg)

Remove tags from a package that point to empty versions.

Parameters:

Name Type Description Default
pkg str

The name of the npm package.

 required

Returns:

Type Description
OneOf[Issue, List[str]]

A OneOf containing a summary of removed tags or an Issue.
Source code in m/npm/clean_tags.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
def clean_tags(pkg: str) -> OneOf[Issue, List[str]]:
    """Remove tags from a package that point to empty versions.

    Args:
        pkg: The name of the npm package.

    Returns:
        A `OneOf` containing a summary of removed tags or an Issue.
    """
    return one_of(lambda: [
        summary
        for tag_map in get_dist_tags(pkg)
        for summary in remove_tags(pkg, find_empty_tags(tag_map))
    ])

find_empty_tags(tag_map)

Create a set containing the npm tags that are empty.

Parameters:

Name Type Description Default
tag_map Dict[str, str]

A dictionary mapping npm tags to versions.

 required

Returns:

Type Description
Set[str]

A set of npm tags that map to empty strings.
Source code in m/npm/clean_tags.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def find_empty_tags(tag_map: Dict[str, str]) -> Set[str]:
    """Create a set containing the npm tags that are empty.

    Args:
        tag_map: A dictionary mapping npm tags to versions.

    Returns:
        A set of npm tags that map to empty strings.
    """
    return {
        tag_name
        for tag_name, version in tag_map.items()
        if not version
    }

remove_tags(pkg, tags)

Call npm dist-tag to remove npm tags.

See https://docs.npmjs.com/cli/v8/commands/npm-dist-tag

Parameters:

Name Type Description Default
pkg str

The npm package.

 required
tags Set[str]

A set containing the tags to remove.

 required

Returns:

Type Description
OneOf[Issue, List[str]]

A OneOf containing a list of the output for each removed tag or an
OneOf[Issue, List[str]]

issue with a summary.
Source code in m/npm/clean_tags.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def remove_tags(pkg: str, tags: Set[str]) -> OneOf[Issue, List[str]]:
    """Call `npm dist-tag` to remove npm tags.

    See https://docs.npmjs.com/cli/v8/commands/npm-dist-tag

    Args:
        pkg: The npm package.
        tags: A set containing the tags to remove.

    Returns:
        A `OneOf` containing a list of the output for each removed tag or an
        issue with a summary.
    """
    issues: List[Issue] = []
    removed: List[str] = []
    for tag in tags:
        cmd_result = remove_dist_tag(pkg, tag)
        if cmd_result.is_bad:
            issues.append(cast(Issue, cmd_result.value))
        else:
            removed.append(cast(str, cmd_result.value))
    if issues:
        return issue('dist-tag rm issues', context={
            'issues': issues,
            'removed': removed,
        })
    return Good(removed)