GithubHelp home page GithubHelp logo

amruser-48 / .config Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rafi/.config

0.0 0.0 0.0 635 KB

Rafi's workstations (Archlinux, osx) ~/.config.

Shell 61.92% CSS 3.26% Python 8.01% Vim Script 3.22% Makefile 0.46% Perl 1.49% sed 0.72% Ruby 4.37% CoffeeScript 1.29% C 15.26%

.config's Introduction

Rafael Bodill's macOS/Archlinux dotfiles

This is my entire "dotfiles" configuration for all the software I use on macOS & Archlinux, mostly in the terminal.

I've turned my ~/.config directory into a Git repository and strive to set applications write their configuration there if they don't by default. Meaning, I try to conform to the XDG standard. There is one important caveat in doing so: Secrets can be accidentally committed. I solve this with the clean and smudge filter features of Git attributes.

Features

The most interesting configs:

... and make sure to check-out github.com/rafi/vim-config!

Install

There is no installation script, only three symlinks:

# Clone the .config repo
cd ~
git clone --recursive [email protected]:rafi/.config.git

# Symlink few files manually:
cd ~
ln -s .config/bash/bashrc .bashrc
ln -s .config/bash/profile .profile
ln -s .config/tmux/config .tmux.conf

# Create cache directories
mkdir -p ~/.cache/{nvim,pacaur,proselint,xpanes,zoxide}
mkdir -p ~/.cache/{aria2,beets,mpd,mpdscribble,mutt,neomutt,rtorrent,subtitles}
mkdir -p ~/.cache/ncmpcpp/lyrics
mkdir -p ~/.cache/node/{npm,gyp}

# Create user local shared directories
mkdir -p ~/.local/bin
mkdir -p ~/.local/share/{cargo,composer,fonts,go,krew,lf,mailbox,mutt,neomutt}
mkdir -p ~/.local/share/{newsbeuter,newsboat,nextword,tig,vagrant,virtualbox}
mkdir -p ~/.local/share/python/{envs,pyenv}

macOS-specific Software

on macOS, make sure you check these out:

XDG Conformity

Configuration directories are organized neatly by defining specific environment variables in bash/exports and aliases in bash/aliases.

Some programs require special help to feed the proper config:

alias cpan='cpan -j "$XDG_CONFIG_HOME"/cpan/config.pm'
alias gcal='gcalcli --configFolder "$XDG_CONFIG_HOME"/gcalcli'
alias mbsync='mbsync -c "$XDG_CONFIG_HOME"/isync/mbsyncrc'
alias mysql='mysql --defaults-extra-file="$XDG_CONFIG_HOME"/mysql/config'
alias mutt='ESCDELAY=0 neomutt || mutt -F "$XDG_CONFIG_HOME"/mutt/config'
alias ncmpc='ncmpc -f "$XDG_CONFIG_HOME"/ncmpc/config -k "$XDG_CONFIG_HOME"/ncmpc/keys'
alias ncmpcpp='ncmpcpp -c "$XDG_CONFIG_HOME"/ncmpcpp/config'
alias redshift='redshift -c "$XDG_CONFIG_HOME"/redshift/config'
alias rtorrent='rtorrent -n -o import="$XDG_CONFIG_HOME"/rtorrent/config.rc'
alias vercel='vercel --global-config="$XDG_CONFIG_HOME"/vercel'
alias weechat='weechat --dir "$XDG_CONFIG_HOME"/weechat/'

Protecting Secrets

Using .gitattributes filters clean and smudge. Setup custom filters:

cd ~/.config
git config --local filter.vault.clean 'sed -f ~/.config/clean.sed'
git config --local filter.vault.smudge 'sed -f ~/.config/smudge.sed'

The sed script clean.sed is included. However, you have to create the smudge.sed script yourself, for example:

cat > ~/.config/smudge.sed
s/{{ \(DIANA\|ARIA2\)_TOKEN }}/secret/
s/{{ LASTFM_USER }}/username/
s/{{ LASTFM_TOKEN }}/token/
s/{{ LASTFM_PASS }}/token/
s/{{ SPOTIFY_USER }}/username/
s/{{ SPOTIFY_PASS }}/password/
s/{{ ECHONEST_TOKEN }}/token/
s/{{ JIRA_URL }}/url/
s/{{ JIRA_USER }}/username/
s/{{ JIRA_PASS }}/password/
s/{{ GIT_EMAIL }}/[email protected]/
s/{{ GIT_NAME }}/Joe Shmoe/
s/{{ GIT_USER }}/joe/
s/{{ WEATHER_TOKEN }}/token/
s/{{ FORECASTIO_TOKEN }}/token/
s/{{ GITHUB_TOKEN }}/token/
s/{{ HOMEBREW_GITHUB_API_TOKEN }}/token/
s/{{ TMUX_SPOTIFY_API_KEY }}/token/

Now whenever you stage files, the clean.sed will prevent secrets being committed. And on checkout, the smudge.sed will inject your secrets into their proper placeholders. Note that smudge.sed is ignored from being committed mistakenly.

.config's People

Contributors

rafi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.