{"id":17647343,"url":"https://github.com/chrisbarrett/apidoc-checker","last_synced_at":"2026-06-15T16:31:36.741Z","repository":{"id":150315951,"uuid":"55893221","full_name":"chrisbarrett/apidoc-checker","owner":"chrisbarrett","description":"A command-line tool to verify apidoc specifications","archived":false,"fork":false,"pushed_at":"2016-11-22T07:23:47.000Z","size":300,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-29T00:47:30.778Z","etag":null,"topics":["apidoc","flycheck","haskell"],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisbarrett.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-10T10:36:41.000Z","updated_at":"2018-10-28T05:38:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"c91d0fb7-9276-49a9-91cf-8715837d5fd8","html_url":"https://github.com/chrisbarrett/apidoc-checker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chrisbarrett/apidoc-checker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbarrett%2Fapidoc-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbarrett%2Fapidoc-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbarrett%2Fapidoc-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbarrett%2Fapidoc-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisbarrett","download_url":"https://codeload.github.com/chrisbarrett/apidoc-checker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbarrett%2Fapidoc-checker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34372121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apidoc","flycheck","haskell"],"created_at":"2024-10-23T11:12:34.496Z","updated_at":"2026-06-15T16:31:36.720Z","avatar_url":"https://github.com/chrisbarrett.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apidoc-checker\n\n![Tooltip displayed over syntax error in Emacs](./assets/screenshot.png)\n\nA tool to validate apidoc specifications. Provides pretty error messages for\ncommand-line use, and includes a Flycheck checker for Emacs.\n\n![Dog at a computer with an overlay labelled \"excellent\"](./assets/dog.png)\n\n## Usage\n\n```\napidoc-checker - apidoc spec validator\n\nUsage: apidoc-checker FILE [--plain]\n  Validates an apidoc JSON specification\n\nAvailable options:\n  -h,--help                Show this help text\n  FILE                     Path to the apidoc spec to validate\n  --plain                  Remove ANSI colour codes from output.\n```\n\n## Installation\n\n1. Install [stack][]\n\n2. Clone this repository and install the tool with stack\n   ```sh\n   git clone https://github.com/chrisbarrett/apidoc-checker.git\n   cd apidoc-checker\n   stack install\n   ```\n\n### Flycheck Integration\n\n1. Configure Emacs to use [MELPA][] as one of your package sources. This is\n   already done for you in Spacemacs.\n\n2. Run `M-x package-install-file apidoc-checker/elisp/apidoc-checker.el` to\n   install the package and its dependencies.\n\nWhen you visit api.json files you should now automatically enter `apidoc-mode`\nand get those *sweet sweet* error squiggles.\n\n## Contributions\n\nPRs welcome.\n\n## License\n\nSee [LICENSE][]. Copyright (c) 2016 Chris Barrett.\n\n[stack]: http://docs.haskellstack.org/en/stable/README/\n[LICENSE]: ./LICENSE\n[MELPA]: http://melpa.org/#/getting-started\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbarrett%2Fapidoc-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisbarrett%2Fapidoc-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbarrett%2Fapidoc-checker/lists"}