Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 2.17 KB

README.md

File metadata and controls

96 lines (72 loc) · 2.17 KB

aligner

Aligner is a perfect multi-line symbol column alignment tool

Feature

  • cross-platform
  • TODO 过滤
  • 开启代码段控制 aligner disable/enable
  • 文件修改监控格式化。后台进程守护。
  • 与vscode、idea 集成
  • =、+、-、/ 等运算符号对齐
  • 自定义符号对齐
  • 第一行开启不控制
  • 自适应语言代码对齐格式化
  • 单行注释与左边的代码间距设置四个空格

How to get

go get github.com/suyanlong/aligner

Usage

install to PATH env

aligner -h

NAME:
   aligner - A new CI/CD cli, align multiple lines of single comments or symbols

USAGE:
   aligner [global options] command [command options] [arguments...]

VERSION:
    aligner v1.0.0-2-g4e9cb99 darwin amd64 Wed Apr 22 11:26:05 UTC 2020


COMMANDS:
   comment  align multiple lines of single comments
   check    aligner check whether the symbols are aligned
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --comment value, -c value  annotation symbols
   --path value, -p value     alignment path (default: "/Users/suyanlong/github/aligner")
   --replace, -r              replace file (default: false)
   --ext value, -e value      file extension
   --ignore value, -i value   ignore file or direction
   --help, -h                 show help (default: false)
   --version, -v              print the version (default: false)

Example

aligner before python.py file

python.py:

class GosTxType:
    gosMallPay = "-10"  # XXXX
    appPay = "-9"  # XXXX
    ecPay = "-8"  # XXXXXXXXX
    addPool = "-7"  # XXXXXXXXXX
    cityFee = "-6"    # XXXXXXXX
    taskFee = "-5"   # XXXXXXX

aligner after python.py file

aligner  -c "#"  -e ".py" comment ./python.py

python.py:

class GosTxType:
    gosMallPay = "-10"  # XXXX
    appPay = "-9"       # XXXX
    ecPay = "-8"        # XXXXXXXXX
    addPool = "-7"      # XXXXXXXXXX
    cityFee = "-6"      # XXXXXXXX
    taskFee = "-5"      # XXXXXXX

use aligner

Contribution Welcomed !

Contributors

Report issue or pull request, or email 592938410@qq.com