{"action":"created","issue":{"url":"https://api.github.com/repos/documentationjs/documentation/issues/342","labels_url":"https://api.github.com/repos/documentationjs/documentation/issues/342/labels{/name}","comments_url":"https://api.github.com/repos/documentationjs/documentation/issues/342/comments","events_url":"https://api.github.com/repos/documentationjs/documentation/issues/342/events","html_url":"https://github.com/documentationjs/documentation/issues/342","id":129893588,"number":342,"title":"Is require-following a good idea?","user":{"login":"tmcw","id":32314,"avatar_url":"https://avatars.githubusercontent.com/u/32314?v=3","gravatar_id":"","url":"https://api.github.com/users/tmcw","html_url":"https://github.com/tmcw","followers_url":"https://api.github.com/users/tmcw/followers","following_url":"https://api.github.com/users/tmcw/following{/other_user}","gists_url":"https://api.github.com/users/tmcw/gists{/gist_id}","starred_url":"https://api.github.com/users/tmcw/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tmcw/subscriptions","organizations_url":"https://api.github.com/users/tmcw/orgs","repos_url":"https://api.github.com/users/tmcw/repos","events_url":"https://api.github.com/users/tmcw/events{/privacy}","received_events_url":"https://api.github.com/users/tmcw/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-01-29T21:55:43Z","updated_at":"2016-01-29T22:20:12Z","closed_at":null,"body":"cc @anandthakker @jfirebaugh @beaugunderson \r\n\r\nBeen thinking over https://github.com/documentationjs/documentation/issues/340 https://github.com/documentationjs/documentation/issues/132 and https://github.com/documentationjs/documentation/issues/140 and have been thinking: is require-following useful? One of the main things that led me to work on documentation in the first place is the usage of [module-deps](https://github.com/substack/module-deps) to find all included source code and document it. But is this actually a useful approach? I think we're seeing some downsides:\r\n\r\n* Mixing shallow & dependency modes is difficult technically and conceptually\r\n* require() statements don't always point to JavaScript files\r\n* module-deps requires each file to be parsed twice\r\n* using module-deps means that we have to run babelify in one place and babel in another, and manage the relationship between those two, making sure they can parse the same kinds of things.\r\n\r\nThis is all making me reconsider whether we don't want to support a simple non-require-following recursive-find-the-files API. Thoughts?"},"comment":{"url":"https://api.github.com/repos/documentationjs/documentation/issues/comments/176996072","html_url":"https://github.com/documentationjs/documentation/issues/342#issuecomment-176996072","issue_url":"https://api.github.com/repos/documentationjs/documentation/issues/342","id":176996072,"user":{"login":"jfirebaugh","id":98601,"avatar_url":"https://avatars.githubusercontent.com/u/98601?v=3","gravatar_id":"","url":"https://api.github.com/users/jfirebaugh","html_url":"https://github.com/jfirebaugh","followers_url":"https://api.github.com/users/jfirebaugh/followers","following_url":"https://api.github.com/users/jfirebaugh/following{/other_user}","gists_url":"https://api.github.com/users/jfirebaugh/gists{/gist_id}","starred_url":"https://api.github.com/users/jfirebaugh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jfirebaugh/subscriptions","organizations_url":"https://api.github.com/users/jfirebaugh/orgs","repos_url":"https://api.github.com/users/jfirebaugh/repos","events_url":"https://api.github.com/users/jfirebaugh/events{/privacy}","received_events_url":"https://api.github.com/users/jfirebaugh/received_events","type":"User","site_admin":false},"created_at":"2016-01-29T22:20:12Z","updated_at":"2016-01-29T22:20:12Z","body":"It's been a valuable feature for documenting mapbox-gl-js, and the points you list sound like the kinds of difficult implementation details that I'm appreciative of one project solving so lots of people don't have to reinvent."}}