freelyformd/github-todos

MVP: Analyse a repo's code for TODOs and FixMe comments & make github issues out of them

github-todos's Issues

API function to update existing bot created issue with new comments

Get new issues from source code

• Get issues created by bot

• Diff issues created by bot with current source code issues and return new only issues

Posting & authenticating with github

We need a module that allows us to communicate with github such that the app can be able to post and edit a github issue

Tests and nodemon return errors.

de72104
for tests -> npm test
to start the server -> npm run dev

Get source code from a github repo for analysis

Write a function that takes in a list of files and returns an array of their content:

see https://probot.github.io/docs/webhooks/, https://probot.github.io/docs/github-api/ & https://octokit.github.io/rest.js/#api-Gitdata-getBlob.

Maybe write the functions for this in src/lib/github/blob

API Function for adding an issue with comments to a repo

Say you have a set of issues of below type

type Body = string;
type Title = string;

interface Issue { 
   title:  title;
   body: Body;
};

write a function that can add a list of issues to a repository. Write in file lib/github/addIssueToRepo.ts

Transform Todo issue objects into issue with comments

transform a list of RepoIssues[] i.e

interface RepoIssues {
   commentText: string;
   lineNumber: number;
   keyWord: KeyWord;
   fileName: string;
}

Into an issue with title named: <keyword> issues from source code and with extracted code issues as comments. For keyword TODO, title would be; TODO issues from source code

The comment item could have text of the form:

<fileName> : <lineNumber> <commentText>

So your function will return a list of issue of the form:

type Comment = string;
type Title = string;
interface IssueWithComments { 
   title:  Title
   comments: Comment[]
};

Write this in lib/github/issue-presenter.ts

deploy bot

Add missing tests and correct existing ones

Search repo source code for comments starting with specific keywords.

The keywords we are considering at the moment are TODO & FIXME. After search return an array object of this type:

type KeyWord = "TODO"  | "FIXME";

repoIssues = Array<{
   commentText: string;
   lineNumber: number;
   keyWord: KeyWord;
   fileName: string;
}>

TODOs from source code

• src/lib/github/repoIssuesList.ts : Need to pass authentication token so as to be able to get issues for private repos
• src/lib/github/repoIssuesList.ts : to query only open issues and created by bot

precise type for context

@epicallan, how do you see replacing any with a precise type for context

github-todos/src/lib/github/repoIssuesList.ts

Line 16 in ae72018

export async function getAllRepoIssues(context: any): Promise<GHIssue[]> {

Similar projects for inspiration

• https://github.com/aviaviavi/toodles

Github todos badge.

Build a simple API that can create a git hub badge.

Below are badge examples;

Return a list of comments to remove or edit on github

If an issue no longer exists in the source code but exists on GitHub TODO issue, we return its Github comments issue details for use in subsequent issues (stories) for deletion. see #57 for more details.

type definition for file missing

https://github.com/Akilihub/github-todos/blob/0e3ef58e5c36b5c37d5f0b7d08f400371993a869/src/lib/github/changedFilesList.ts#L14

Turn issueWithComments into an issue with title and body.

Given a list of issuesWithComments of type

Array<{
   title:  Title
   comments: Comment[]
}>

Turn them into a list of issues with body from comments and title. i.e

type Body = string;
type Title = string;

interface Issue { 
   title:  title;
   body: Body;
};

create body as a string created by joining the comments list with a new line deliminator (separator), where each comment item has already been transformed into a checklist item as below

const formattedComment  = `- [ ] ${commentText}`

Do this in the issuePresenters module

Retrieve checked comments / issues from bot created issues

Can we have this run as a CLI?

Imagine running this every time a PR gets merged to create issues, just an idea

Add assignees to bot created issues.

Documentation on how to set up a test bot

see https://probot.github.io/docs/development/

Remove an assignee from bot created issue once the issue no longer exists or has been checked

support config file

A config file may be added to a repo that a bot has access to. This config file can then be used to change bot behavior.

Possible config values may include;

• keywords to listen for i.e TODO, FIXME, BUG
• boolean flag for auto-deleting checked out or no longer existing TODO items in source code
• issue labels to add to auto created bots
• mode in which bot should run i.e add issues on PR or on pushing to a specific branch (default master) see #65
• files to ignore (regex pattern)
• root directories of the project such that it is easy to traverse project for comments on bot install see #54 defaults can be src, app etc

Issues management

Once a TODO / FIXME comment has been removed from a source code file, we would like to delete it from the auto-created Github TODO issue comments.

Preferable approach:

• Get all current issue comments on GitHub. #69
• Cross check whether returned Github issues ( done in #69 ) still exist in the source code. Return a list of those that should be kept or removed. (#72 )
• Delete no longer existing issue comments (done in #72) from Github. (#57 )
• Remove an assignee from bot created issue once the issue no longer exists or has been checked #59

Use github API to get a list of changed files on git push

do this work in a new file: src/lib/github/changedFilesList.ts and in a new branch.

Add new tslint rules

• should error out on wrong alignment
• should error on detected un-reacheable code

add proper types for Context object

Failed to find `__.getContent` as an api

github-todos/src/lib/github/changedFilesList.ts

Line 28 in b81a3c8

const content = await octokit.repos.getContent({owner, repo, path: name});

, @epicallan , perhaps you meant __.getContents as in https://octokit.github.io/rest.js/#api-Repos-getContents

should support multiple languages besides Javascript & typescript

look at https://github.com/aviaviavi/toodles/blob/master/app/Parse.hs#L66

remove .vscode and dist from git history

Test bot and make sure it works locally.

code formatting and refactoring

Come up with implementation architectural design guide document

set up CI with travis or circleCI

• should have build, tests & linting tasks.

supporting posting issues as JIRA and YouTrack backlog issues

• May require setting up database ??

add docker deployment config

add assignees to bot created issues text

assignee (user who created comment) should be added to issue comment text as below

- [ ] [src/lib/github/repoIssuesList.ts](https://github.com/freelyformd/github-todos/blob/master/src/lib/github/repoIssuesList.ts#L20) : todo comment text  by @epicallan 

Improve error handling

We should have error types for various Async errors and handle them from one place. This may involve possibly creating a file called errors.

Look through all files for issue comments on bot install on a repo.

When bot is initially given repo access we should go through entire project files and look out for TODO and FIXME comments

Get open issues created by app and return them as a list.

Remove nolonger existing issue comments in source-code from github Issue

We need to remove comments on GH-TODO bot issue on Github that no longer exist in the source code.
Some code is going to be written to create a list of the issue comments to delete or edit in other issues that are subtasks of #71.

So, for this issue expect a list of comments to delete or edit (overwrite) using GitHub issue comments API.

Assume usage of types below;

type CommentEditAction = "delet | "edit"; // can be enum 

const delete:  CommentEditAction = "delete"
const edit :  CommentEditAction = "edit"

interface CommentEdit { 
  GhIssueId: number;
  GhCommentId: number;
  action:  CommentEditAction;
  commentsText: string[];
}

// the list of items to remove or edit is a list of this type, done in other issues.
type CommentsEdit = CommentEdit[] 

For instance, if a comment on a GitHub TODO issue with two items has one item removed from source code, we will over-write that comment to have only one instead of previous two.

If a comment on GitHub TODO issue has two items and they both get removed from source code, we would need to delete that comment instead of overwriting it.

Create a github utils module

It should contain functions that returns some of the common / duplicated data we get from git hub payload.