Skip to content

njkleiner/coco

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

coco

Quickly parse conventional comments.

Install

$ npm install @njkleiner/coco

Usage

const coco = require('@njkleiner/coco');

coco.parse('nitpick (non-blocking): This is not worded correctly.');
// => [{label: 'nitpick', subject: 'This is not worded correctly.', decoration: ['non-blocking'], discussion: null}]

coco.parse('suggestion: Let\'s avoid using this specific function...\n\nIf we reference much of a function marked "Deprecated", it is almost certain to disagree with us, sooner or later.');
// => [{label: 'suggestion', subject: 'Let\'s avoid using this specific function...', discussion: 'If we reference much of a function marked "Deprecated", it is almost certain to disagree with us, sooner or later.', decoration: []}]

coco.parse('not a conventional comment');
// => []

Contributing

You can contribute to this project by sending patches to noah@njkleiner.com.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

About

Parse conventional comments

Resources

License

Stars

Watchers

Forks

Releases

No releases published