pippinlee / get-issues Goto Github PK
View Code? Open in Web Editor NEWQuickest way to get a local version of github issues
Home Page: https://www.npmjs.com/package/get-issues
Quickest way to get a local version of github issues
Home Page: https://www.npmjs.com/package/get-issues
Instead of making http request via request
module, we should make use the github4 module for all requests to github.
Currently the getIssues
function uses the request
module -- since we're switching over github4 module for all other requests, we should do the same for non-auth required requests to github.
We should be aware of the problem of running get-issues
for a public repo that doesn't require auth. Although it is likely our most common use case by a long shot Github's non-authed API has a rate limit that pretty easy to hit:
get-issues
on many projects they'll hit Github's rate limitThere are a few solutions to this:
get-issues
always require auth, even for public repos. This is a sound choice, but means we add one extra barrier to people getting their issues. The majority of use will be through smallish public repos, so have get-issues
be a one step command would be important, for our most common use caseTLDR: This likely isn't a big issue because most use of get-issues
is for <100 issue projects that are public, bit it's something we may hear about. Least work path: we just suggest people fake switch IP's to get around rate-limiting.
Forward slashes in issues titles (which are then used as filenames for each issue) are causing failed writes.
Ex: add support for websockets / tcp.md
Two apparent options: figure out way to escape /
characters, or take them out of filenames.
fs module already uses path.join so don't need to worry about platform compatibility for this specific issue.
Windows does not allow colons in filenames. An easy fix would be to replace with a hyphen (-
) or similar.
This isn't immediately important but we should consider deleting old issues that are closed. Or, simpler, we could re-write the /issues
dir everytime get-issues
is run, which would then represent the CURRENT state of open issues for that repo.
@mikemimik let's use this as a guideline for async.waterfall flow. Let me know if flow doesn't make sense. I'll also use this as a guideline to make tests.
For this first release get-issues
only works for request to public URLs.
Ideally we could use github auth to allow use of ssh keys so that folks don't need to set user/pass for every repo they want issues from.
If no open issues exist we should tell the user explicitly.
Currently we don't return console.log anything except the fancy ascii logo if no issues are found.
thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf thing sldkfjslkj sljflsjf lsj fdljslfd ls jfl slf
falksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls ffalksjf lejflfnlajflnalnf lanfnaflalnflnfalnflnalsnfnnfksf flk sl fls fl lds fls f
for this particular project: https://github.com/seiyria/Roguathia
this isn't doing anything besides adding an empty issues folder and an entry in my gitignore. how does this work? is there a way to specify a repository?
For code consistency we should ES6-ify all the code. Most folks are running node 4+ so this shouldn't be a problem.
Adding Travis integration will help with future PRs. This will be part of adding tests.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.