{"id":20617043,"url":"https://github.com/richytong/cronist","last_synced_at":"2025-08-31T13:41:18.631Z","repository":{"id":88110050,"uuid":"296423493","full_name":"richytong/cronist","owner":"richytong","description":"Transform comment documentation into ES modules","archived":false,"fork":false,"pushed_at":"2023-06-12T05:47:12.000Z","size":28,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-26T10:54:55.207Z","etag":null,"topics":["comment","documentation","json","markdown","parser"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/richytong.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":"2020-09-17T19:30:09.000Z","updated_at":"2023-06-12T05:46:39.000Z","dependencies_parsed_at":"2024-11-20T11:04:22.650Z","dependency_job_id":null,"html_url":"https://github.com/richytong/cronist","commit_stats":{"total_commits":23,"total_committers":1,"mean_commits":23.0,"dds":0.0,"last_synced_commit":"c5b2e21f59e012a70bb5f54eed85efa22b798696"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richytong%2Fcronist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richytong%2Fcronist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richytong%2Fcronist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richytong%2Fcronist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/richytong","download_url":"https://codeload.github.com/richytong/cronist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242269662,"owners_count":20100145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["comment","documentation","json","markdown","parser"],"created_at":"2024-11-16T11:21:49.492Z","updated_at":"2025-08-31T13:41:18.617Z","avatar_url":"https://github.com/richytong.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cronist\n![cronist](https://rubico.land/assets/cronist-logo-3.jpg)\n\nTransform comment documentation into [JSON](https://www.json.org/json-en.html) or [ES modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).\n\n# Usage\nWrite comment documentation following a basic `@key #valid-markdown` schema.\n\n```javascript\n/**\n * @name tap\n *\n * @synopsis\n * ```coffeescript [specscript]\n * var args ...any,\n *   tapper ...args=\u003ePromise|any\n *\n * tap(tapper)(...args) -\u003e Promise|args[0]\n * ```\n *\n * @description\n * Call a function with a value, returning the value. Promises created by the tapper are resolved before returning the value.\n *\n * ```javascript [playground]\n * pipe([\n *   tap(console.log),\n *   value =\u003e value + 'bar',\n *   tap(console.log),\n * ])('foo') // 'foo'\n *           // 'foobar'\n * ```\n */\nconst tap = ...\n```\n\nUse cronist to parse the file containing the above comment documentation into ES modules.\n\n```sh\n$ cronist file-that-had-the-above-tap.js\nexport default [\n  {\n    name: 'tap',\n    synopsis: '```coffeescript [specscript]\\n' +\n      'var args ...any,\\n' +\n      '  tapper ...args=\u003ePromise|any\\n' +\n      '\\n' +\n      'tap(tapper)(...args) -\u003e Promise|args[0]\\n' +\n      '```',\n    description: 'Call a function with a value, returning the value. Promises created by the tapper are resolved before returning the value.\\n' +\n      '\\n' +\n      '```javascript [playground]\\n' +\n      'pipe([\\n' +\n      '  tap(console.log),\\n' +\n      \"  value =\u003e value + 'bar',\\n\" +\n      '  tap(console.log),\\n' +\n      \"])('foo') // 'foo'\\n\" +\n      \"          // 'foobar'\\n\" +\n      '```',\n    mdast: {\n      name: {/* ... */},\n      synopsis: {/* ... */},\n      description: {/* ... */}\n    }\n  },\n  ...\n]\n```\n\n# Installation\nwith `npm`\n```sh\nnpm i cronist\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichytong%2Fcronist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichytong%2Fcronist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichytong%2Fcronist/lists"}