{"id":20065071,"url":"https://github.com/raphaelkieling/doctorenv","last_synced_at":"2025-05-05T18:31:32.422Z","repository":{"id":200411325,"uuid":"705417455","full_name":"raphaelkieling/doctorenv","owner":"raphaelkieling","description":"Checklist tool that helps developers identify environment issues","archived":false,"fork":false,"pushed_at":"2023-10-22T22:56:28.000Z","size":786,"stargazers_count":5,"open_issues_count":5,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-01-26T22:37:41.419Z","etag":null,"topics":["checklist","cli","doctor","environment","hacktoberfest","issue","javascript","tool"],"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/raphaelkieling.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-16T00:32:31.000Z","updated_at":"2023-10-23T03:21:53.000Z","dependencies_parsed_at":"2023-11-15T23:45:23.976Z","dependency_job_id":null,"html_url":"https://github.com/raphaelkieling/doctorenv","commit_stats":{"total_commits":53,"total_committers":5,"mean_commits":10.6,"dds":"0.15094339622641506","last_synced_commit":"b5870d74369c8b745fe43684de1f8d0aa72cae45"},"previous_names":["raphaelkieling/doctorenv"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelkieling%2Fdoctorenv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelkieling%2Fdoctorenv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelkieling%2Fdoctorenv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelkieling%2Fdoctorenv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raphaelkieling","download_url":"https://codeload.github.com/raphaelkieling/doctorenv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224459439,"owners_count":17314896,"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":["checklist","cli","doctor","environment","hacktoberfest","issue","javascript","tool"],"created_at":"2024-11-13T13:48:58.000Z","updated_at":"2024-11-13T13:48:58.846Z","avatar_url":"https://github.com/raphaelkieling.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"image.png\" height=\"100px\"\u003e\n\u003c/div\u003e\n\n# Doctorenv\n\n![Known Vulnerabilities](https://snyk.io/test/github/raphaelkieling/doctorenv/badge.svg)\n[![codecov](https://codecov.io/gh/raphaelkieling/doctorenv/graph/badge.svg?token=8FUTQY7PA7)](https://codecov.io/gh/raphaelkieling/doctorenv)\n\n[Wiki documentation here](https://github.com/raphaelkieling/doctorenv/wiki)\n\n✅ `Doctorenv` is a checklist tool that helps developers to check if they have everything to contribute in a project.\n\nIn the end the goal is `Save time`, nothing more! 🚀\n\n### How to install?\n\n```sh\n# Without install\nnpx doctorenv-cli\n\n# Installing globally using npn\nnpm i -g doctorenv-cli\n\n# Installing globally using yarn\nyarn global add doctorenv-cli\n```\n\n\u003e I do not recommend to install locally yet, since you do not have any big reason to do it right now. In the future the idea is to have plugin system, hooks and type checking using `require`, up to you.\n\n### Why?\n\nSometimes you aren't sure if you have everything to contribute in a project. The `Doctorenv` should give you some help on:\n\n- Check what is missing in your environment to make it works\n- Giving you some `Suggestions` on how to fix in case you do not met some requirements\n- Easy to start using and change\n- Automatic fixers\n\nExample of config:\n\n```js\n// doctorenv.config.js\nmodule.exports = ({ builder }) =\u003e {\n  return builder\n    .task('check package manager')\n    .subTask('has npm', ({ bash }) =\u003e bash`npm --version`)\n    .subTask('has yarn', ({ bash }) =\u003e bash`yarn --version`)\n    .task('has env', ({ checkEnv }) =\u003e checkEnv('NODE_ENV'))\n    .setFixableSuggestion(\n      'Run source ./env.sh',\n      ({ bash }) =\u003e bash`source ./env.sh`\n    )\n    .build()\n}\n```\n\nRun:\n\n```sh\n# To check the default doctorenv.config.js\ndoctorenv check\n\n# To check with a custom config\ndoctorenv check \u003ccustom-path-to-config\u003e\n```\n\n![Alt text](image-1.png)\n\n### Changelog\n\nYou can check the changelog [here](CHANGELOG.md).\n\n### How to contribute?\n\nIt's simple, just take a look at our [Contributing](CONTRIBUTING.md) guide.\n\n### Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/dakshsinghrathore\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/115932772?v=4?s=100\" width=\"100px;\" alt=\"Daksh Singh Rathore\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDaksh Singh Rathore\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#research-dakshsinghrathore\" title=\"Research\"\u003e🔬\u003c/a\u003e \u003ca href=\"https://github.com/raphaelkieling/doctorenv/commits?author=dakshsinghrathore\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/harshvyas-22\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/118657807?v=4?s=100\" width=\"100px;\" alt=\"harshvyas-22\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eharshvyas-22\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#design-harshvyas-22\" title=\"Design\"\u003e🎨\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/raphaelkieling\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/16259523?v=4?s=100\" width=\"100px;\" alt=\"Raphael Kieling\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRaphael Kieling\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/raphaelkieling/doctorenv/commits?author=raphaelkieling\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n### Development\n\n```sh\n# testing\nnpm run test\nnpm run test:watch\n\n# run a specific example in dev mode\nnpm run dev check examples/NAME_HERE.config.js\n```\n\n### Publishing\n\n```sh\nnpm run publish\n```\n\n\u003csmall\u003e\nTemporary Icon from: \u003ca href=\"https://www.flaticon.com/free-icons/pharmacist\" title=\"Pharmacist icons\"\u003ePharmacist icons created by Freepik - Flaticon\u003c/a\u003e\n\u003c/small\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraphaelkieling%2Fdoctorenv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraphaelkieling%2Fdoctorenv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraphaelkieling%2Fdoctorenv/lists"}