https://github.com/tupton/dotfiles

⚙ My configuration files.
https://github.com/tupton/dotfiles

configuration dotfiles macos makefile personal-dotfiles shell

Last synced: 11 days ago
JSON representation

⚙ My configuration files.

• Host: GitHub
• URL: https://github.com/tupton/dotfiles
• Owner: tupton
• Created: 2009-02-10T04:17:46.000Z (over 15 years ago)
• Default Branch: main
• Last Pushed: 2024-09-25T16:21:20.000Z (about 1 month ago)
• Last Synced: 2024-10-14T07:07:10.194Z (26 days ago)
• Topics: configuration, dotfiles, macos, makefile, personal-dotfiles, shell
• Language: Shell
• Homepage:
• Size: 756 KB
• Stars: 13
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dotfiles

[![CircleCI Build Status](https://dl.circleci.com/status-badge/img/gh/tupton/dotfiles/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/tupton/dotfiles/tree/main)

A collection of config files that I use.

## Installation

Installing will overwrite anything in the way. Run `make -n` first. If you are happy with that output, you can test the dotfile environment with

    ❯ TMP=$(mktemp -d -t HOME); HOME=$TMP make install && ls -al $TMP && unset TMP

Install common, cross-platform dotfiles to `$HOME` with

    ❯ make install

Install individual dotfiles with, e.g.

    ❯ make install-git

or

    ❯ make install-vim-config

and so forth.

Look at the `Makefile` to see which dotfiles are installed by default and which require running a separate task. For example, tarsnap configs only really apply to my local machine, so they are not installed by default.

Use `make list` to see a list of all targets, including the test targets and any auxiliary helper targets. More on test targets follows.

## Tests

There is a `test` target in the Makefile. Not everything is tested, but I've attempted to verify the files that can be tested. If you know of a way to verify or test other dotfiles, please open an issue or let me know.

- All `zsh` and `bash` config files and scripts are parsed by their respective shells. This includes all the `zsh` installation script helpers.

- All `vim` config files are linted by [vim-vint].

- All [dotjs] files are linted by [eslint].

  [vim-vint]: https://github.com/Kuniwak/vint

  [dotjs]: https://github.com/tupton/dotjs

  [eslint]: http://eslint.org/

You need `bash` and `zsh` installed to check the syntax of some installation files. Presumably, if you are using these dotfiles, you have at least those two shells installed.

In order to test the dotjs and vim config files, you need to install vim-vint and eslint. There is a `test-requirements.txt` to help with vim-vint, and there is a `package.json` to help with the javascript linters. Simply run `pip install -r test-requirements.txt` and `npm install --only=dev` to install these dependencies.

Note that you *do not* need to install `pip` and `npm` requirements in order to install and use these dotfiles. These requirements are only used for running tests, hence their test- and dev-specific install commands.

## Inspiration and Thanks

 - Makefile and overall project structure

 - Interactive, templated gitconfig