Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidosomething/dotfiles

mac OS, Arch Linux, and Debian/Ubuntu + Neovim
https://github.com/davidosomething/dotfiles

bash dotfiles fzf git hammerspoon neovim shell tmux vim xdg zsh

Last synced: about 2 months ago
JSON representation

mac OS, Arch Linux, and Debian/Ubuntu + Neovim

Host: GitHub
URL: https://github.com/davidosomething/dotfiles
Owner: davidosomething
Created: 2012-03-07T06:45:57.000Z (over 12 years ago)
Default Branch: dev
Last Pushed: 2024-05-17T18:35:49.000Z (4 months ago)
Last Synced: 2024-05-18T03:04:29.524Z (4 months ago)
Topics: bash, dotfiles, fzf, git, hammerspoon, neovim, shell, tmux, vim, xdg, zsh
Language: Lua
Homepage: https://github.com/davidosomething/dotfiles
Size: 26.1 MB
Stars: 322
Watchers: 6
Forks: 23
Open Issues: 13
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        

My dotfiles.   

My [/uses] post my be of interest to you!

![terminal screenshot][screenshot]

> Screenshot of my ZSH prompt

| Tool              | Link                        |

| ----------------- | --------------------------- |

| OS support        | Arch, macOS, Debian, Ubuntu |

| Terminal emulator | [wezterm]                   |

| Font              | [Maple Mono]                |

| Shell             | zsh                         |

| Shell plugins     | [zinit]                     |

| Editor            | [neovim]                    |

| Tooling/env       | [mise]                      |

- [XDG] compliance wherever possible to keep `$HOME` clean

  - See [Arch Linux wiki for XDG Base Directory Support]

  - See [Debian DotFilesList]

  - See [grawity's notes] and [environ notes]

- RC files for Lua, markdownlint, node, PHP, python, R, and others

## Installation

See macOS specific notes in [mac/README.md](mac/README.md)

Generally:

```sh

git clone https://github.com/davidosomething/dotfiles ~/.dotfiles

```

Then, run the [bootstrap/symlink](bootstrap/symlink) script for linux or

[bootstrap/mac](bootstrap/mac) for macOS.

After symlinking, [bootstrap/cleanup](bootstrap/cleanup) can move dotfiles into

their XDG Base Directory supported directories and deletes unnecessary things

(with confirmation).

After symlinking and restarting shell, aliases will be available.

The `sshkeygen` alias will help in generating a new SSH key.

## Updating

`u` is an alias to [dot](bin/dot). Use `u` without arguments for usage.

## Notes

- `bin/`

  - There's a [readme](bin/README.md) in `bin/` describing each

    script/binary. This directory is in the `$PATH`.

- `git/`

  - The comment character is `#` instead of `;` so I can use Markdown

    in my commit messages without trimming the headers as comments. This is

    also reflected in a custom Vim highlighting syntax

- `local/`

  - Unversioned folder, put `zshrc`, `bashrc`, `npmrc`, and `gitconfig` here

    and they will be automatically sourced, LAST, by the default scripts. _No

    dots on the filenames._

- `nvim/`

  - [nvim/README.md](nvim/README.md) for more information.

- `python/`

  - Never `sudo pip`. Set up a python virtual environment.

### rc script source order

If you have node installed, the [dkosourced](bin/dkosourced) command will show

you (not exhaustively) the order scripts get sourced. Without node `echo

$DKO_SOURCE` works.

For X apps (no terminal) the value may be:

```text

/etc/profile

.xprofile

  shell/vars

    shell/xdg

```

## Shell script code style

- **Script architecture**

  - Use the `#!/usr/bin/env bash` shebang and write with bash compatibility

  - Create a private main function with the same name as the shell script.

    E.g. for a script called `fun`, there should be a `__fun()` that gets

    called with the original arguments `__fun $@`

  - Two space indents

  - Prefer `.` over `source`

- **Function names**

  - For private functions in a script, use two underscores `__private_func()`

    These function names are safe to reuse after running the script once. When

    namespaced, they are in the form of `__dko_function_name()`.

- **Variable interpolation**

  - Always use curly braces around the variable name when interpolating in

    double quotes.

- **Variable names**

  - Stick to nouns, lower camel case

- **Variable scope**

  - Use `local` and `readonly` variables as much as possible over

    global/shell-scoped variables.

- **Comparison**

  - Not strict on POSIX, but portability

  - Do NOT use BASH arrays, use ZSH or Python if need something complicated

  - Use BASH `==` for string comparison

  - Use BASH `(( A == 2 ))` for integer comparison (note not `$A`, `$` not

    needed)

## Credits

> _Logo from [jglovier/dotfiles-logo]_

[Arch Linux wiki for XDG Base Directory Support]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support

[Debian DotFilesList]: https://wiki.debian.org/DotFilesList

[environ notes]: https://github.com/grawity/dotfiles/blob/master/.environ.notes

[grawity's notes]: https://github.com/grawity/dotfiles/blob/master/.dotfiles.notes

[jglovier/dotfiles-logo]: https://github.com/jglovier/dotfiles-logo

[mise]: https://github.com/jdx/mise

[neovim]: https://neovim.io/

[screenshot]: https://raw.githubusercontent.com/davidosomething/dotfiles/meta/meta/terminal-potatosff.png

[/uses]: https://www.davidosomething.com/uses/

[wezterm]: https://wezfurlong.org/wezterm/

[XDG]: https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

[zinit]: https://github.com/zdharma-continuum/zinit

[Maple Mono]: https://github.com/subframe7536/maple-font