{"action":"created","issue":{"url":"https://api.github.com/repos/sindresorhus/awesome/issues/569","repository_url":"https://api.github.com/repos/sindresorhus/awesome","labels_url":"https://api.github.com/repos/sindresorhus/awesome/issues/569/labels{/name}","comments_url":"https://api.github.com/repos/sindresorhus/awesome/issues/569/comments","events_url":"https://api.github.com/repos/sindresorhus/awesome/issues/569/events","html_url":"https://github.com/sindresorhus/awesome/issues/569","id":140036967,"number":569,"title":"Tools for enforcing awesome-style?","user":{"login":"paulirish","id":39191,"avatar_url":"https://avatars.githubusercontent.com/u/39191?v=3","gravatar_id":"","url":"https://api.github.com/users/paulirish","html_url":"https://github.com/paulirish","followers_url":"https://api.github.com/users/paulirish/followers","following_url":"https://api.github.com/users/paulirish/following{/other_user}","gists_url":"https://api.github.com/users/paulirish/gists{/gist_id}","starred_url":"https://api.github.com/users/paulirish/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/paulirish/subscriptions","organizations_url":"https://api.github.com/users/paulirish/orgs","repos_url":"https://api.github.com/users/paulirish/repos","events_url":"https://api.github.com/users/paulirish/events{/privacy}","received_events_url":"https://api.github.com/users/paulirish/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2016-03-10T23:16:17Z","updated_at":"2016-03-11T08:50:40Z","closed_at":null,"body":"In the [manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) there are a few suggestions and requirements.  For example..\r\n\r\n##### style\r\n* grammatically correct\r\n* no typos\r\n* no markdown errors\r\n* consistent style (e.g. \"[link](/thing) - Description with a period.\")\r\n\r\n##### build\r\n* table-of-contents generated\r\n\r\n-----------\r\n\r\nHave any list maintainers written some scripts to either lint for style issues? Also interested in boring build scripts to automate TOC generation with DocToc, etc."},"comment":{"url":"https://api.github.com/repos/sindresorhus/awesome/issues/comments/195262398","html_url":"https://github.com/sindresorhus/awesome/issues/569#issuecomment-195262398","issue_url":"https://api.github.com/repos/sindresorhus/awesome/issues/569","id":195262398,"user":{"login":"wooorm","id":944406,"avatar_url":"https://avatars.githubusercontent.com/u/944406?v=3","gravatar_id":"","url":"https://api.github.com/users/wooorm","html_url":"https://github.com/wooorm","followers_url":"https://api.github.com/users/wooorm/followers","following_url":"https://api.github.com/users/wooorm/following{/other_user}","gists_url":"https://api.github.com/users/wooorm/gists{/gist_id}","starred_url":"https://api.github.com/users/wooorm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wooorm/subscriptions","organizations_url":"https://api.github.com/users/wooorm/orgs","repos_url":"https://api.github.com/users/wooorm/repos","events_url":"https://api.github.com/users/wooorm/events{/privacy}","received_events_url":"https://api.github.com/users/wooorm/received_events","type":"User","site_admin":false},"created_at":"2016-03-11T08:50:40Z","updated_at":"2016-03-11T08:50:40Z","body":"Hi Sindre, Paul, great idea!\r\n\r\n#### no markdown errors, consistent style\r\n\r\nI believe [remark](https://github.com/wooorm/remark), the markdown processor, could help here. Probably though its [lint](https://github.com/wooorm/remark-lint) plugin, which checks patterns in markdown and triggers warnings. It checks for several possible style violations (e.g., emphasis markers, `*` or `_`), which each can be configured, turned on, or turned off. And, it supports external rules, for example: [`vhf/remark-lint-alphabetize-lists`](https://github.com/vhf/remark-lint-alphabetize-lists), which ensures lists are sorted properly.\r\n\r\nWhich brings me to a similar project, [`vhf/free-programming-books-lint`](https://github.com/vhf/free-programming-books-lint), which implemented the aforementioned rule. This project wraps remark and remark-lint and enforces the free-programming-book style in their [`.travis.yml`](https://github.com/vhf/free-programming-books/blob/83ad2ccb681432e79c808cfa5bb418ec84a8369b/.travis.yml#L5-L7) file.\r\n\r\nP.S. also interesting: [`remark-validate-links`](https://github.com/wooorm/remark-validate-links)\r\n\r\n#### table-of-contents\r\n\r\nMaybe [`remark-toc`](https://github.com/wooorm/remark-toc), or of course one of the non-remark plugins if you want more control.\r\n\r\n#### grammatically correct, no typos\r\n\r\nNothing good so far. I investigated this but there’s no good solution to implement this in a Travis task, yet. I’m half-way with n-spell, plain-JavaScript (Hunspell) spelling, which will make this possible. But I got bored...\r\n\r\n---\r\n\r\nHope this helps!"}}