comparing ea43c7dc95a84aad7012fb596f1244ad091a6b99 and main on anil.recoil.org/xdge

+17 -1

.gitignore

···

       1
       1
       -
       _build

     

       1
       1
       +
       # OCaml build artifacts

     

       2
       2
       +
       _build/

     

       3
       3
       +
       *.install

     

       4
       4
       +
       *.merlin

     

       5
       5
       +
       

     

       6
       6
       +
       # Third-party sources (fetch locally with opam source)

     

       7
       7
       +
       third_party/

     

       8
       8
       +
       

     

       9
       9
       +
       # Editor and OS files

     

       10
       10
       +
       .DS_Store

     

       11
       11
       +
       *.swp

     

       12
       12
       +
       *~

     

       13
       13
       +
       .vscode/

     

       14
       14
       +
       .idea/

     

       15
       15
       +
       

     

       16
       16
       +
       # Opam local switch

     

       17
       17
       +
       _opam/

+6 -1

.tangled/workflows/build.yml

···

       2
       2
        
         - event: ["push", "pull_request"]

     

       3
       3
        
           branch: ["main"]

     

       4
       4
        
       

     

       5
       5
       +
       engine: nixery

     

       6
       6
       +
       

     

       5
       7
        
       dependencies:

     

       6
       8
        
         nixpkgs:

     

       7
       9
        
           - shell

     
···

       34
       36
        
              opam install . --confirm-level=unsafe-yes --deps-only

     

       35
       37
        
         - name: build

     

       36
       38
        
           command: |

     

       37
       37
       -
              opam exec -- dune build --verbose

     

       39
       39
       +
              opam exec -- dune build

     

       40
       40
       +
         - name: switch-test

     

       41
       41
       +
           command: |

     

       42
       42
       +
              opam install . --confirm-level=unsafe-yes --deps-only --with-test

     

       38
       43
        
         - name: test

     

       39
       44
        
           command: |

     

       40
       45
        
              opam exec -- dune runtest --verbose

+10

CHANGES.md

···

       1
       1
       +
       v1.1.0 (dev)

     

       2
       2
       +
       ------------

     

       3
       3
       +
       

     

       4
       4
       +
       - Remove dependency on `eio_main` for library (@avsm).

     

       5
       5
       +
         Thanks to @Alizter for the workaround in https://github.com/ocaml/dune/issues/12821).

     

       6
       6
       +
       

     

       7
       7
       +
       v1.0.0 (2025-11-29)

     

       8
       8
       +
       -------------------

     

       9
       9
       +
       

     

       10
       10
       +
       - Initial public release (@avsm)

+75

README.md

···

       1
       1
       +
       # xdge - XDG Base Directory Specification for Eio

     

       2
       2
       +
       

     

       3
       3
       +
       This library implements the [XDG Base Directory

     

       4
       4
       +
       Specification](https://specifications.freedesktop.org/basedir-spec/latest/) for

     

       5
       5
       +
       OCaml applications using the [Eio](https://github.com/ocaml-multicore/eio)

     

       6
       6
       +
       effects-based I/O library.

     

       7
       7
       +
       

     

       8
       8
       +
       ## What is XDG?

     

       9
       9
       +
       

     

       10
       10
       +
       The XDG Base Directory Specification defines standard locations for user-specific files on Unix-like systems, keeping home directories clean and organized:

     

       11
       11
       +
       

     

       12
       12
       +
       - Config (`~/.config/app`): User preferences and settings

     

       13
       13
       +
       - Data (`~/.local/share/app`): Persistent application data

     

       14
       14
       +
       - Cache (`~/.cache/app`): Non-essential cached data (safe to delete)

     

       15
       15
       +
       - State (`~/.local/state/app`): Logs, history, and runtime state

     

       16
       16
       +
       - Runtime (`$XDG_RUNTIME_DIR/app`): Sockets, pipes, and session-bound files

     

       17
       17
       +
       

     

       18
       18
       +
       The specification also defines system-wide search paths (`/etc/xdg`,

     

       19
       19
       +
       `/usr/share`) and a precedence system using environment variables

     

       20
       20
       +
       (`XDG_CONFIG_HOME`, `XDG_DATA_HOME`, and so on).

     

       21
       21
       +
       

     

       22
       22
       +
       ## Why Eio?

     

       23
       23
       +
       

     

       24
       24
       +
       Eio uses a **capability-based** approach to I/O where filesystem access must be

     

       25
       25
       +
       explicitly passed to functions. This design aligns naturally with XDG directory

     

       26
       26
       +
       management. For example:

     

       27
       27
       +
       

     

       28
       28
       +
       ```ocaml

     

       29
       29
       +
       (* Filesystem access is an explicit capability *)

     

       30
       30
       +
       let xdg = Xdge.create env#fs "myapp"

     

       31
       31
       +
       ```

     

       32
       32
       +
       

     

       33
       33
       +
       The capability model provides the benefit that code that needs filesystem

     

       34
       34
       +
       access must receive the `fs` capability, with no hidden global state or ambient

     

       35
       35
       +
       authority. The `Eio.Path.t` type returned by xdge encapsulates both the

     

       36
       36
       +
       filesystem capability and the path, preventing path traversal outside the

     

       37
       37
       +
       granted capability. Applications can restrict filesystem access by passing a

     

       38
       38
       +
       sandboxed `fs` capability, and xdge respects those boundaries.

     

       39
       39
       +
       

     

       40
       40
       +
       ## Usage

     

       41
       41
       +
       

     

       42
       42
       +
       ```ocaml

     

       43
       43
       +
       Eio_main.run @@ fun env ->

     

       44
       44
       +
         let xdg = Xdge.create env#fs "myapp" in

     

       45
       45
       +
       

     

       46
       46
       +
         (* Access XDG directories as Eio paths *)

     

       47
       47
       +
         let config = Xdge.config_dir xdg in

     

       48
       48
       +
         let data = Xdge.data_dir xdg in

     

       49
       49
       +
       

     

       50
       50
       +
         (* Search for files following XDG precedence *)

     

       51
       51
       +
         match Xdge.find_config_file xdg "settings.json" with

     

       52
       52
       +
         | Some path -> (* use path *)

     

       53
       53
       +
         | None -> (* use defaults *)

     

       54
       54
       +
       ```

     

       55
       55
       +
       

     

       56
       56
       +
       For CLI applications, xdge provides Cmdliner terms that handle environment

     

       57
       57
       +
       variable precedence and command-line overrides:

     

       58
       58
       +
       

     

       59
       59
       +
       ```ocaml

     

       60
       60
       +
       let () =

     

       61
       61
       +
         Eio_main.run @@ fun env ->

     

       62
       62
       +
         let term = Xdge.Cmd.term "myapp" env#fs () in

     

       63
       63
       +
         (* Generates --config-dir, --data-dir, etc. flags *)

     

       64
       64
       +
         (* Respects MYAPP_CONFIG_DIR > XDG_CONFIG_HOME > default *)

     

       65
       65
       +
       ```

     

       66
       66
       +
       

     

       67
       67
       +
       ## Installation

     

       68
       68
       +
       

     

       69
       69
       +
       ```

     

       70
       70
       +
       opam install xdge

     

       71
       71
       +
       ```

     

       72
       72
       +
       

     

       73
       73
       +
       ## License

     

       74
       74
       +
       

     

       75
       75
       +
       ISC

+4

dune

···

       1
       1
       +
       (alias

     

       2
       2
       +
        (name default)

     

       3
       3
       +
        (deps

     

       4
       4
       +
         (alias_rec lib/all)))

+4 -3

dune-project

···

       8
       8
        
       (authors "Anil Madhavapeddy")

     

       9
       9
        
       (homepage "https://tangled.sh/@anil.recoil.org/xdge")

     

       10
       10
        
       (maintainers "Anil Madhavapeddy <anil@recoil.org>")

     

       11
       11
       -
       (bug_reports "https://tangled.sh/@anil.recoil.org/xgde/issues")

     

       11
       11
       +
       (bug_reports "https://tangled.sh/@anil.recoil.org/xdge/issues")

     

       12
       12
        
       (maintenance_intent "(latest)")

     

       13
       13
        
       

     

       14
       14
        
       (package

     
···

       24
       24
        
         (ocaml (>= 5.1.0))

     

       25
       25
        
         (eio (>= 1.1))

     

       26
       26
        
         (cmdliner (>= 1.2.0))

     

       27
       27
       -
         (fmt (>= 0.11.0))

     

       27
       27
       +
         fmt

     

       28
       28
       +
         xdg

     

       29
       29
       +
         (eio_main :with-test)

     

       28
       30
        
         (odoc :with-doc)

     

       29
       29
       -
         (eio_main :with-test)

     

       30
       31
        
         (alcotest (and :with-test (>= 1.7.0)))))

+1 -1

lib/dune

···

       1
       1
        
       (library

     

       2
       2
        
        (public_name xdge)

     

       3
       3
        
        (name xdge)

     

       4
       4
       -
        (libraries eio eio_main xdg cmdliner fmt))

     

       4
       4
       +
        (libraries eio xdg unix cmdliner fmt))

+5

lib/xdge.ml

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       type source = Default | Env of string | Cmdline

     

       2
       7
        
       

     

       3
       8
        
       type t = {

+5

lib/xdge.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       (** XDG Base Directory Specification support with Eio capabilities

     

       2
       7
        
       

     

       3
       8
        
           This library provides an OCaml implementation of the XDG Base Directory

+5

test/test_paths.ml

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       let test_path_validation () =

     

       2
       7
        
         Printf.printf "Testing XDG path validation...\n";

     

       3
       8
        
         (* Test absolute path validation for environment variables *)

+4

test/test_paths.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

+5

test/xdg_example.ml

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

     

       5
       5
       +
       

     

       1
       6
        
       let run (xdg, cfg) =

     

       2
       7
        
         Fmt.pr "%a@.%a@.@.%a@.%a@."

     

       3
       8
        
           Fmt.(styled `Bold string)

+4

test/xdg_example.mli

···

       1
       1
       +
       (*---------------------------------------------------------------------------

     

       2
       2
       +
         Copyright (c) 2025 Anil Madhavapeddy <anil@recoil.org>. All rights reserved.

     

       3
       3
       +
         SPDX-License-Identifier: ISC

     

       4
       4
       +
        ---------------------------------------------------------------------------*)

+8 -15

xdge.opam

···

       7
       7
        
       authors: ["Anil Madhavapeddy"]

     

       8
       8
        
       license: "ISC"

     

       9
       9
        
       homepage: "https://tangled.sh/@anil.recoil.org/xdge"

     

       10
       10
       -
       bug-reports: "https://tangled.sh/@anil.recoil.org/xgde/issues"

     

       10
       10
       +
       bug-reports: "https://tangled.sh/@anil.recoil.org/xdge/issues"

     

       11
       11
        
       depends: [

     

       12
       12
        
         "dune" {>= "3.20"}

     

       13
       13
        
         "ocaml" {>= "5.1.0"}

     

       14
       14
        
         "eio" {>= "1.1"}

     

       15
       15
        
         "cmdliner" {>= "1.2.0"}

     

       16
       16
        
         "fmt" {>= "0.11.0"}

     

       17
       17
       -
         "odoc" {with-doc}

     

       17
       17
       +
         "xdg"

     

       18
       18
        
         "eio_main" {with-test}

     

       19
       19
       +
         "odoc" {with-doc}

     

       19
       20
        
         "alcotest" {with-test & >= "1.7.0"}

     

       20
       21
        
       ]

     

       22
       22
       +
       x-maintenance-intent: ["(latest)"]

     

       21
       23
        
       build: [

     

       22
       22
       -
         ["dune" "subst"] {dev}

     

       23
       23
       -
         [

     

       24
       24
       -
           "dune"

     

       25
       25
       -
           "build"

     

       26
       26
       -
           "-p"

     

       27
       27
       -
           name

     

       28
       28
       -
           "-j"

     

       29
       29
       -
           jobs

     

       30
       30
       -
           "@install"

     

       31
       31
       -
           "@runtest" {with-test}

     

       32
       32
       -
           "@doc" {with-doc}

     

       33
       33
       -
         ]

     

       24
       24
       +
         [ "dune" "subst"                                ] {dev}

     

       25
       25
       +
         [ "dune" "build" "-p" name "-j" jobs "@install" ]

     

       26
       26
       +
         [ "dune" "build" "-p" name "-j" jobs "runtest"  ] {with-test & opam-version >= "2.2"}

     

       27
       27
       +
         [ "dune" "build" "-p" name "-j" jobs "@doc"     ] {with-doc}

     

       34
       28
        
       ]

     

       35
       35
       -
       x-maintenance-intent: ["(latest)"]

+6

xdge.opam.template

···

       1
       1
       +
       build: [

     

       2
       2
       +
         [ "dune" "subst"                                ] {dev}

     

       3
       3
       +
         [ "dune" "build" "-p" name "-j" jobs "@install" ]

     

       4
       4
       +
         [ "dune" "build" "-p" name "-j" jobs "runtest"  ] {with-test & opam-version >= "2.2"}

     

       5
       5
       +
         [ "dune" "build" "-p" name "-j" jobs "@doc"     ] {with-doc}

     

       6
       6
       +
       ]

Compare changes