pathlint 0.0.24

Lint the PATH environment variable against declarative ordering rules.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/ShortArrow/pathlint/main/schemas/sort.schema.json",
  "title": "SortPlan",
  "description": "Proposed PATH reordering from `pathlint sort --dry-run`, carrying the original and sorted entries plus the move list.",
  "type": "object",
  "required": [
    "moves",
    "notes",
    "original",
    "sorted"
  ],
  "properties": {
    "moves": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/EntryMove"
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/SortNote"
      }
    },
    "original": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sorted": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "definitions": {
    "EntryMove": {
      "description": "One entry's movement from old to new index. Only emitted when the entry actually moved; entries that stayed in place do not generate a `EntryMove`.",
      "type": "object",
      "required": [
        "entry",
        "from",
        "reason",
        "to"
      ],
      "properties": {
        "entry": {
          "type": "string"
        },
        "from": {
          "type": "integer",
          "format": "uint",
          "minimum": 0.0
        },
        "reason": {
          "description": "Why the entry moved — names a command for which this entry is now preferred over the one it overtook. Free-form, single short sentence; meant for the human view.",
          "type": "string"
        },
        "to": {
          "type": "integer",
          "format": "uint",
          "minimum": 0.0
        }
      }
    },
    "SortNote": {
      "description": "Non-blocking observation about a `[[expect]]` rule. The current PATH cannot satisfy `prefer` (no PATH entry matches any preferred source), so `sort` cannot fix it by reordering — the user has to install the missing tool or adjust the rule. Surfaced so the human view can include it as an \"fyi\" line below the diff.",
      "oneOf": [
        {
          "description": "`prefer` is non-empty but no PATH entry currently matches any of the listed sources, so reordering cannot fix this rule.",
          "type": "object",
          "required": [
            "command",
            "kind",
            "prefer"
          ],
          "properties": {
            "command": {
              "type": "string"
            },
            "kind": {
              "type": "string",
              "enum": [
                "unsatisfiable_prefer"
              ]
            },
            "prefer": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ]
    }
  }
}