당신의 프로젝트에 질서를 가져다 드릴게요!git commiit 지원 도구가 만들어졌습니다.

8520 단어 GitGitHubcommitizen

개막사

  • [오늘부터 가능] 제출한 정보에'접두사'를 붙이면 개발 효율을 높일 수 있다.
  • Git의 제출에 그림 문자를 사용하십시오!
  • 상술한 보도에서 우리는 제출 정보에서prefix를 사용하는 장점에 대해 이야기했다.
    실제로 자신이 지금 하고 있는 일도 커미션에prefix를 더했다.
    하지만, 이것은 상당히 번거롭다.
    "도대체 어떤 prefix가 있을까요?""doc 그렇죠, docs?"
    이렇게
    prefix를 가볍게 하는 도구는 commitizen가 있지만, 이것은 상당히 사용하기 어렵다.
    prefix의 종류가 강제되어 자유롭게 변경할 수 없습니다.
    그래서 제가 좋아하는 도구를 만들었어요.
    바로 git-consistent입니다.

    ↑ 이런 놈이야.

    설치하다.


    npm나yarn에만 설치하면 됩니다.
    $ npm install -g git-consistent
    # or
    $ yarn global add git-consistent
    

    사용법

    git consistent --gen-config전화하면 질문이 많이 들어오니까 대답해.
    $ cd my-project/
    $ git consistent --gen-config
    ? Use Type? Yes
    ? Use Emoji? No
    ? choice types feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, ui, remove, sec, up, down, tada
    ? Does the subject start with? lower case
    ? Does the subject put dot (.) at end? No
    Generated '.gitcommit_template' and '.git_consistent'.
    You can edit them freely.
    Enjoy!
    
    그럼 이렇게 서류 두 개를 만들 수 있어요.
    .gitcommit_template
    <type>: <subject>
    
    <body>
    
    .git_consistent
    type:
      type: enum
      required: true
      description: 'commit type'
      values:
        -
          name: feat
          description: 'when implementing function'
        -
          name: fix
          description: 'when fixing a bug'
        -
          name: tada
          description: 'when celebrating'
    subject:
      type: string
      required: true
      description: 'The subject contains succinct description of the change'
      rules:
        firstLatter: lower
        dotAtEnd: false
        nonAscii: false
    body:
      type: text
      default: ''
      required: false
      description: 'The body contains details of the change'
      rules:
        firstLatter: upper
        dotAtEnd: true
        nonAscii: false
    
    나머지는 대체git commitgit consistent -i다.
    $ git consistent -i
    ? Select type: 
      feat     when implementing function 
      fix      when fixing a bug 
    ❯ tada     when celebrating
    (Move up and down to reveal more choices)
    ? Write subject: my first commit
    
    이렇게 상호작용해서 제출 메시지를 생성할 수 있습니다.
    옵션에 입력할 수도 있습니다.option명은 .gitcommit_template<>에 둘러싸인 이름이다.
    옵션을 입력했다면, 입력하지 않은 내용만 서로 입력할 수 있습니다.
    $ git consistent -i --subject="my first commit"
    ? Select type: 
      feat     when implementing function 
      fix      when fixing a bug 
    ❯ tada     when celebrating
    (Move up and down to reveal more choices)
    # subjectは聞かれない
    
    또한subject에는 -m의alias가 특별히 붙어 있어gitalias와 조합하면 이렇게 된다.
    $ git config --global alias.con "consistent -i"
    
    $ git con -m "this is amazing commit"
    ? Select type: 
    ❯ feat     when implementing function 
      fix      when fixing a bug 
      tada     when celebrating
    (Move up and down to reveal more choices)
    
    평소 제출할 때와 용법이 크게 다르지 않다.

    응용 프로그램


    응용으로 다음과 같은 기능이 있다.
  • 장식 입력의 예test와 입력【test】
  • 형식 검사
  • 첫 번째 문자의 대문자/소문자
  • 끝의dot.
  • 일본어 라이센스
  • 분기 이름의 일부를 포함하는 메시지 제출 예제issue-123의 분기 제출 시close #123 자동 제출
  • 맞춤법 검사
  • 그림 문자 지원

  • git-duet 지원
  • 이것들은 자유 편집.gitcommit_template.git_consistent를 통해 간단하게 사용할 수 있다.
    자세한 내용은 README샘플 목록를 참조하십시오.
    당신의 프로젝트가 질서가 있기를 바랍니다!

    좋은 웹페이지 즐겨찾기