hdasch / indent-lint.el

Async indentation checker and flycheck frontend

Table of Contents

• Description
• Install
• Usage
• Customize
• Syntaxes
• Information
  • Community
  • Contribution
  • Migration
  • License
  • Author
  • Contributors
  • Special Thanks

Description

Async indentation checker and flycheck frontend.

Install

• M-x package-install indent-lint
• M-x package-install flycheck-indent

Usage

indent-lint

• interactive

  M-x indent-lint

  Lint indentation for current-buffer.

• Lisp program

  Use indent-lint function.

  (indent-lint BUF)
      

  BUF accepts buffer name (string) or buffer (buffer object).

  After few seconds, a buffer with different indentation lines are popped.

flycheck-indent

To enable, use something like this.

(eval-after-load 'flycheck
  '(flycheck-indent-setup))

Customize

indent-lint-before-indent-fn

The function will eval before indent

indent-lint-verbose

If non-nil, output diff verbose.

Information

Community

Any feedback and suggestions are welcome!

You can use GitHub issues, but you can also use Slack if you want a more casual conversation.

Contribution

We welcome PR!

Require tools for testing

• cask
  • install via brew

    brew install cask
            

  • manual install

    cd ~/
    hub clone cask/cask
    export PATH="$HOME/.cask/bin:$PATH"
            

Running test

Below operation flow is recommended.

make                              # Install git-hooks in local .git

git branch [feature-branch]       # Create branch named [feature-branch]
git checkout [feature-branch]     # Checkout branch named [feature-branch]

# <edit loop>
emacs indent-lint.el              # Edit something you want

make test                         # Test indent-lint
git commit -am "brabra"           # Commit (auto-run test before commit)
# </edit loop>

hub fork                          # Create fork at GitHub
git push [user] [feature-branch]  # Push feature-branch to your fork
hub pull-request                  # Create pull-request

Migration

License

General Public License Version 3 (GPLv3)
Copyright (c) Naoya Yamashita - https://conao3.com
https://github.com/conao3/indent-lint.el/blob/master/LICENSE

Author

• Naoya Yamashita (conao3)

Contributors