https://github.com/xiaoxiaosn/dotfiles

My dotfiles configuration, including Neovim, fish shell, tmux...
https://github.com/xiaoxiaosn/dotfiles

dotfiles fish neovim vim

Last synced: 1 day ago
JSON representation

My dotfiles configuration, including Neovim, fish shell, tmux...

• Host: GitHub
• URL: https://github.com/xiaoxiaosn/dotfiles
• Owner: XiaoXiaoSN
• Created: 2021-10-02T11:15:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T06:25:43.000Z (about 1 month ago)
• Last Synced: 2024-12-18T07:24:06.206Z (about 1 month ago)
• Topics: dotfiles, fish, neovim, vim
• Language: Shell
• Homepage:
• Size: 5.93 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ⚙️ dotfiles

![lint](https://github.com/XiaoXiaoSN/dotfiles/actions/workflows/lint.yaml/badge.svg)

## Getting Started

See more configurations in the [Makefile](/Makefile).

```bash

make all

```

- Neovim

  ![images/neovim.png](images/neovim.png)

  ![images/neovim-finder.png](images/neovim-finder.png)

- Zsh

  ![images/z-shell.png](images/z-shell.png)

- Fish Shell

  ![images/fish-shell.png](images/fish-shell.png)

- Vim

  ![images/vim.png](images/vim.png)

## Writer Guide

### Git Hooks

This repository use [pre-commit](https://github.com/pre-commit/pre-commit) to help developers keep the code quality.

If you install hooks, pre-commit will styling and linting before code committing.

```bash

# or check the installation page: https://pre-commit.com/#install

brew install pre-commit

pre-commit install --install-hooks -t commit-msg -t pre-commit

```

### Lint & Format

This repository use [EditorConfig](https://editorconfig.org/) and [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) to help me keep the consistent coding styles :)

run below command to check format

```

editorconfig-checker

```

Also, we have [Prettier](https://prettier.io/) to further ensure the code format of the project.

run below command to check format

```

npx prettier --check **/*.{js,ts,md,json,yaml}

```

or use `--write` to directly re-write it

```

npx prettier --write **/*.{js,ts,md,json,yaml}

```