https://github.com/rohit-gohri/danger-plugin-todos

A danger-js plugin to list all todos/fixmes/etc added/changed in a PR
https://github.com/rohit-gohri/danger-plugin-todos

danger danger-js danger-js-plugin danger-plugin fixme github-actions gitlab hacktoberfest nodejs todo ts typescript

Last synced: about 2 months ago
JSON representation

A danger-js plugin to list all todos/fixmes/etc added/changed in a PR

• Host: GitHub
• URL: https://github.com/rohit-gohri/danger-plugin-todos
• Owner: rohit-gohri
• License: mit
• Created: 2019-10-14T07:47:17.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-05T06:14:10.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T15:22:03.190Z (8 months ago)
• Topics: danger, danger-js, danger-js-plugin, danger-plugin, fixme, github-actions, gitlab, hacktoberfest, nodejs, todo, ts, typescript
• Language: TypeScript
• Homepage: https://rohit.page/blog/projects/dangerjs-plugin-todos/?utm_source=github&utm_medium=repo&utm_campaign=hf
• Size: 1.12 MB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# danger-plugin-todos

[![Build Status](https://github.com/rohit-gohri/danger-plugin-todos/workflows/Build/badge.svg?branch=master)](https://github.com/rohit-gohri/danger-plugin-todos/actions?query=branch%3Amaster)

[![npm version](https://img.shields.io/npm/v/danger-plugin-todos)](https://www.npmjs.com/package/danger-plugin-todos)

[![npm downloads](https://img.shields.io/npm/dm/danger-plugin-todos)](https://www.npmjs.com/package/danger-plugin-todos)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![License](https://img.shields.io/github/license/rohit-gohri/danger-plugin-todos)](https://github.com/rohit-gohri/danger-plugin-todos/blob/master/LICENSE.md)

A [danger-js](https://danger.systems/js/) plugin to list all todos/fixmes/etc added/changed/removed in a PR.

## Intro to Danger

Danger is a tool to automate common code review practices. It can run as part of your CI pipeline and help maintain standards. Check out their github repo at [danger/danger-js](https://github.com/danger/danger-js). You can configure it using a `dangerfile`, which is a javscript or typescript file in the root of your project. It'll post it's results as a comment in the PRs of your project.

## Usage

To use you must already have `danger-js` set up in your repo. 

### Install

```sh

yarn add danger-plugin-todos --dev

# OR

npm i --save-dev danger-plugin-todos

```

### At a glance

```js

// dangerfile.js

import { schedule } from 'danger'

import todos from 'danger-plugin-todos'

// Using schedule because this is an async task

schedule(todos())

// Optionally provide options

schedule(todos({

    ignore: ['CHANGELOG.md', /test/], // Any files to ignore, can be part of filename or regex pattern to match (default: [])

    keywords: ['TODO', 'FIXME', 'TO-DO'], // Keywords to find (default: ['TODO', 'FIXME'])

    repoUrl: 'https://github.com/rohit-gohri/danger-plugin-todos', // If using github provide the repo url (default: true - tries to pick from package.json -> repository.url)

}))

// For other git providers (that don't follow github style links for files) provide a custom function to turn filepaths into links for the specific commit

schedule(todos({

    repoUrl: (filepath) => `https://custom-git-example.com/rohit-gohri/danger-plugin-todos/tree/${danger.git.commits[0].sha}/${filepath}`,

}))

schedule(todos({

    repoUrl: false, // for using simple filepaths without links

}))

```

### Results Preview

#### Github

![github example](./github-example.png)

#### Gitlab

![gitlab example](./gitlab-example.png)

#### Bitbucket

This is an example for #4

![bitbucket example](./bitbucket-example.png)

## Changelog

See the GitHub [release history](https://github.com/rohit-gohri/danger-plugin-todos/releases).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).