Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mishamyrt/checode
✅ Comment keyword extractor, parser and reporter
https://github.com/mishamyrt/checode
ci comment todo
Last synced: 24 days ago
JSON representation
✅ Comment keyword extractor, parser and reporter
- Host: GitHub
- URL: https://github.com/mishamyrt/checode
- Owner: mishamyrt
- License: mit
- Created: 2020-07-02T22:06:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-20T18:14:14.000Z (over 3 years ago)
- Last Synced: 2024-12-31T07:30:15.980Z (about 1 month ago)
- Topics: ci, comment, todo
- Language: Go
- Homepage:
- Size: 112 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![Go Report Card](https://goreportcard.com/badge/github.com/mishamyrt/checode)][goreportcard]
Checode extracts, collects and reports TODOs, FIXMEs and other keywords in your code. If you don't know why you should write a comment, look at the [wiki note](https://github.com/mishamyrt/checode/wiki/Maybe-you-don't-really-want-TODO).
## Features
* Language agnostic
* Multithreaded
* CI ready## Usage in command line
```sh
checode src/
```## Usage in GitLab CI
```yaml
checode:
stage: quality assurance
image: mishamyrt/checode
script:
checode src/
```## Configuring
When running, Checode checks if the `.checode.yaml` file is in current directory and applies it if it is. Default built-in config looks like this:
```yaml
keywords:
TODO: warn
FIXME: err
STOPSHIP: err
NOTE: info
```Using the configuration file, you can add processing of any keywords.
```yaml
keywords:
XXX: warn
HACK: warn
```To apply a configuration file with a different name, specify it as the parameter.
```sh
checode -c custom_config.yaml src/
```## Commands
In addition to normal comments, you can make comments with logic. The commands are triggered as follows:
```ts
// :: :
```For example:
```ts
// FIXME:: due 2021-10-20: Remove this dirty hack after the demonstration.
```### Available commands
* `due` — Limits the date until which this comment will not be considered an error. Raises the comment level to `err` if the specified date is greater than or equal to the current date. Accepts the date in `yyyy-mm-dd` format.
[goreportcard]: https://goreportcard.com/report/github.com/mishamyrt/checode