skywind3000 / skywind3000/z.lua

Avoid polluting $HOME by following XDG Base Directory Specification

Open
#27 12 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
3.1k
Forks
148
PR merge metrics
No merged PRs in 30d

Description

By default z.lua writes into ~/.zlua. This pollutes the home directory.

In Unix, writing in a specified config folder is preferable. Traditionally ~/.config/ serves this purpose.

In Windows %LOCALAPPDATA% serves this purpose.

In MacOS ~/Library/Preferences serves this purpose.

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with z.lua around line 107, where the default ~/.zlua path is written, and read the linked XDG Base Directory, Windows, and macOS guidance. Define the platform-specific config locations and verify that the default no longer writes directly into the home directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.