I have a repo which has a bunch of code in it which isn't mine. Moreover, this code has TODOs in it. I would like to ignore these files. In the example repo, these files are inside deps/fftw-3.3.4.

I recently tried to push a very large commit (thousands of lines changed). This resulted in github-todos printing so much to the stdout that the git push failed (exceeded buffer).

A very large css file (9000+lines) was printed to stdout. I suspect this was the cause of the issue, but I am not sure if it was the only problem.

If anyone else gets the same problem, you can do git push --no-verify to omit the githook.

For discussion, let's study possibilities:

• Closing issue when a TODO is removed or "marked as complete"?
• Remove TODOs when issue is closed?
• Do it automatically? At push-time? In a separate command (brew doctor-like)?

This project is really an awesome idea, it's something I think I was lacking. In fact, I was thinking of building something similar myself, then I discover your project. Kudos to you!

Anyway, I failed my first attempt at using it. After installation, when I try to configure it,
I was asked for GH user and password to generate an API token. I type my credentials,
but then I receive this error:

[Github-Todos] To disable checking credentials on 'init', add option '--no-connect'
[Github-Todos] Hook file not found, create new one…
[Github-Todos] Hook installed
[Github-Todos] Option 'repo' is not set
[Github-Todos] Now guessing initial configuration from remote 'origin'…
[Github-Todos] TypeError: Object parroit/immutato has no method 'then'
[Github-Todos] Failed to fetch 'repo' option
[Github-Todos] Now guessing initial configuration from remote 'origin'…
TypeError: Object parroit/immutato has no method 'then'

( parroit/immutato is my repo on GH )

Ref. #4 ping @Palleas

Using node v13.6.0 (64-bit) on Windows 10.

When I run github-todos init command, I receive this error:

Unhandled rejection ReferenceError: primordials is not defined
    at fs.js:35:5
    at req_ (C:\Users\joaos\AppData\Roaming\npm\node_modules\github-todos\node_modules\natives\index.js:143:24)
    at Object.req [as require] (C:\Users\joaos\AppData\Roaming\npm\node_modules\github-todos\node_modules\natives\index.js:55:10)
    at Object.<anonymous> (C:\Users\joaos\AppData\Roaming\npm\node_modules\github-todos\node_modules\graceful-fs\fs.js:1:37)
    at Module._compile (internal/modules/cjs/loader.js:1144:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1164:10)
    at Module.load (internal/modules/cjs/loader.js:993:32)
    at Function.Module._load (internal/modules/cjs/loader.js:892:14)
    at Module.require (internal/modules/cjs/loader.js:1033:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (C:\Users\joaos\AppData\Roaming\npm\node_modules\github-todos\node_modules\graceful-fs\graceful-fs.js:3:27)
    at Module._compile (internal/modules/cjs/loader.js:1144:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1164:10)
    at Module.load (internal/modules/cjs/loader.js:993:32)
    at Function.Module._load (internal/modules/cjs/loader.js:892:14)
    at Module.require (internal/modules/cjs/loader.js:1033:19)

I have lines going like:
// TODO #10 #9 #8 #7 what is this
With the many issues there on github.

After installing github-todos, I tryied to authenticate, but I got this error message:

$ github-todos auth
/usr/bin/env: node: No such file or directory

First off, this looks really helpful. Unfortunately, hooks aren't ideal for the workflow that I follow (and for various organizational reasons, that workflow can't be changed). Would it be possible to expose the core library so that grunt or gulp tasks could be written around it?

I use vim-simple-todo to make checkboxes for my TODO's.
But the issues created par github-todos is shown as code, and therefore does not create Github-Flavored checkboxes. Is there a way to get github-todos to export plain issues? (I mean not in a code block.)

Thanks for your work.

EDIT:
what I get:

  [ ] task undone
  [X] task done

while I want/need:

• task undone
• task done

Should be able to specify a simple TODO text file as provider. Using a well known format (SublimeText's PlainTasks? TodoTxt?) would be helpful.

Hi there,

I couldn't find a SECURITY.md in your repository and am not sure how to best contact you privately to disclose a security issue.

Can you add a SECURITY.md file with an e-mail to your repository, so that our system can send you the vulnerability details? GitHub suggests that a security policy is the best way to make sure security issues are responsibly disclosed.

Once you've done that, you should receive an e-mail within the next hour with more info.

Thanks! (cc @huntr-helper)

Ref. lib/todos.js:225

        // TODO syntax highlighting?
        text += "\n\n```\n" + extract + "\n```\n";
      }

(automatically generated by Github-Todos)

See immutato/benchmarks#3

Ref. lib/todos.js:322

// TODO Better heuristic for code vs words detection

// Simple heuristic to detect if a title is really a title or some valid code
// String → Boolean
…

(automatically generated by Github-Todos)

Getting

Warning: failed injecting issues, you may need to do it manually in following files:
Error: Command failed: /bin/sh -c git commit -m '[Github-Todos] Inject issue numbers'

after pushing to github

First off, love this app, keep up the awesome work.

Secondly, what do you think about adding XDG support? The global config file would then be $XDG_CONFIG_HOME/github-todos/github-todos.cfg (or similar). The default (if $XDG_CONFIG_HOME is not set) would be ~/.config/github-todos/github-todos.cfg in addition to/instead of ~/.github-todos. Or let the user specify a custom location via an environment variable like GITHUB_TODOS_CONFIG or something.

Looks like if you have a self hosted version of github It fails with the message

Connection to 'github' failed
Error: 'repo': expected format 'user/repository'

If I try to call
github-todos auth in my github repo i got

Connection to 'github' failed
Error: 'repo': expected format 'user/repository'

I presume, that this error because I try to use it on repo cloned via ssh. In my .git/config file lines are:
url = [email protected]:user/repo.git

It might be handy to let the user choose which word trigger the hook.
That whay, the hook will easily adapt to the workflow of each one

I tried to ignore an issue. I selected n and the branch won't push.

my-app git:(master) git push origin master
? Create new issue "#3 throw an error - test" (src/app/my.service.ts:52) Do not create issue
[Github-Todos] Skipped - "#3 throw an error - test"
[Github-Todos] Injecting issue numbers to files…
TypeError: Cannot read property 'type' of null
error: failed to push some refs to '[email protected]:my-user/my-app.git'

If I select y the branch pushes up correctly.

my-app git:(master) git push origin master
? Create new issue "#3 throw an error - test" (src/app/my.service.ts:52)Create issue
[Github-Todos] Created issue #4 (#3 throw an error - test) - https://github.com/my-user/my-app/issues/4
[Github-Todos] Injecting issue numbers to files…
[Github-Todos] Added a commit containing issue injections
[Github-Todos] OK.
Counting objects: 9, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (9/9), done.
Writing objects: 100% (9/9), 819 bytes | 0 bytes/s, done.
Total 9 (delta 7), reused 0 (delta 0)
remote: Resolving deltas: 100% (7/7), completed with 6 local objects.
To github.com:my-user/my-app.git
   aaaaaaa..bbbbbbb  master -> master

The CLI says: Those information ARE NOT STORED, only the generated token will be stored in your global git configuration. (by which I assume it means e.g. ~/.gitconfig), but in my experience if you do:

github-todos config github.token <TOKEN>

then it ends up in .github-todos, not in the global config file. This makes it easy to accidentally checkin the token, which I believe one shouldn't do.

I like the idea of doing what the CLI says it'll do, but if it doesn't, it should probably instead say "make sure you add .github-todos to your .gitignore".

By @Palleas, asking to support Jira.

Goal

• Add option issue-manager or manager or provider… set to "github" by default
• Automatically detect the manager AND the repo in "github-todos init"
• Load dedicated module instead of systematically "github"
• Document how to include additional managers

Implementation

• Reimplement "guessRepo()" (should delegate responsability to known managers if none set by user)
• Reimplement public interface of "lib/github" for every new manager
  • Also implement the logic to guess repo (first point)
• For Jira we can use node-jira

Things to check

• Is described format for "repo" (user/repos) really important? I think it's just used in "github.js" and then we can make format simply dependent of issue manager (will need to output some clever documentation)

It looks like github.host is expected to be the full endpoint for the github api. Since we're on GitHub Enterprise, our API endpoint isn't at a domain root, it's a BASE_DOMAIN/api/v3. Is there a way to customize that path?

Could we make an issue service for Gitlab?