{"id":19988202,"url":"https://github.com/gabrielogregorio/mark-tested-specs","last_synced_at":"2026-04-29T09:05:06.652Z","repository":{"id":194548820,"uuid":"691332179","full_name":"gabrielogregorio/mark-tested-specs","owner":"gabrielogregorio","description":"📦 This CLI library helps you mark the specifications that were tested in a markdown file.","archived":false,"fork":false,"pushed_at":"2023-12-11T23:35:33.000Z","size":999,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-07T06:01:54.670Z","etag":null,"topics":["automatic-testing","cli","docs","npm-package","package","testing"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mark-tested-specs","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gabrielogregorio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE-OF-CONDUCT.md","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":"2023-09-14T01:05:07.000Z","updated_at":"2023-10-31T10:19:38.000Z","dependencies_parsed_at":"2023-09-14T03:22:01.267Z","dependency_job_id":"b48ed3a4-a2de-4a33-9607-5e9867e97ee3","html_url":"https://github.com/gabrielogregorio/mark-tested-specs","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"c662572c8730cfc7f1688cfdfa52833d876abb8c"},"previous_names":["gabrielogregorio/mark-tested-specs","ogregorio0/mark-tested-specs"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/gabrielogregorio/mark-tested-specs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabrielogregorio%2Fmark-tested-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabrielogregorio%2Fmark-tested-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabrielogregorio%2Fmark-tested-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabrielogregorio%2Fmark-tested-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gabrielogregorio","download_url":"https://codeload.github.com/gabrielogregorio/mark-tested-specs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabrielogregorio%2Fmark-tested-specs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260491142,"owners_count":23017181,"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":["automatic-testing","cli","docs","npm-package","package","testing"],"created_at":"2024-11-13T04:41:56.175Z","updated_at":"2026-04-29T09:05:01.632Z","avatar_url":"https://github.com/gabrielogregorio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# mark-tested-specs - EXPERIMENTAL\n\n![NPM package](https://img.shields.io/badge/npm-CB3837?style=for-the-badge\u0026logo=npm\u0026logoColor=white)\n![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![Eslint](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge\u0026logo=eslint\u0026logoColor=white)\n![Prettier](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge\u0026logo=prettier\u0026logoColor=F7BA3E)\n\n\u003c/div\u003e\n\n## Getting Started\n\nThis CLI library helps you mark the specifications that were tested in a markdown file.\n\n## How to Use\n\n1. First, you need to install mark-tested-specs as a development or global dependency. You can do this using your preferred package manager:\n\n```bash\nnpm install --global mark-tested-specs\n```\n\n```bash\nnpm install mark-tested-specs --save-dev\n```\n\n```bash\nyarn add -D mark-tested-specs\n```\n\n```bash\npnpm install mark-tested-specs --save-dev\n```\n\n2. Then create a script in your package.json\n\n```json\n{\n  \"scripts\": {\n    \"update:marks\": \"mark-tested-specs -d ./src/ -s ./src/example.md \"\n  }\n}\n```\n\n3. About parameters\n\n- **-d ** (required) The path where you will indicate that a specification was tested, it can be in a comment in your typings or in your specs\n- **-s** (required) This is your file that contains your specifications, this file will be updated as you complete the specifications\n\n4. For this to work, your spec file will have to have a syntax similar to this `[](#any-mark-name#)`, example:\n\n```md\n###Var\n\n'Var' is test\n\nupdate me [](#any-mark-name#)\n\n| Name     | Type                  |                         |\n| -------- | --------------------- | ----------------------- |\n| text     | String                | [](#any-mark-name#)     |\n| location | [Location](#location) | [✅](#any-mark-name#)   |\n| location | [Location](#location) | [❌](#any-mark-name#)   |\n| location | [Location](#location) | [❌](#any-mark-name-2#) |\n```\n\nAnd to make a mark updated, simply write `test #any-mark-name#` in one of your files specified with `-d`, example\n\n```ts\nit('should test #any-mark-name#', () =\u003e {\n  // blah blah blah\n});\n```\n\nAfter running the command with \"npm run update:marks\" that we defined in package.json, all markers found with \"test #any-mark-name#\" will be marked as ✅, example:\n\n```md\n### Var\n\n'Var' is test\n\nupdate me [✅](#any-mark-name#)\n\n| Name     | Type                  |                         |\n| -------- | --------------------- | ----------------------- |\n| text     | String                | [](#any-mark-name#)     |\n| location | [Location](#location) | [✅](#any-mark-name#)   |\n| location | [Location](#location) | [✅](#any-mark-name#)   |\n| location | [Location](#location) | [❌](#any-mark-name-2#) |\n```\n\n5. You can use this however you want, but by giving a suggestion, you can integrate this at the end of your tests\n\n```json\n{\n  \"scripts\": {\n    \"jest\": \"jest \u0026\u0026 npm run update:marks\",\n    \"update:marks\": \"mark-tested-specs -d ./src/ -s ./src/example.md \"\n  }\n}\n```\n\n## Contributing to the project\n\nWould you like to contribute to the project? Excellent! In our [contributing.md](CONTRIBUTING.md) guide, you'll find information on how to create a Pull Request, code standards we follow, and how to report bugs. Your contribution is valuable and will help improve the tool for everyone.\n\nI hope these explanations and examples are clear and useful!\n\n# Known issues\n\nTo report issues, if possible, please provide a snippet or link to the code on GitHub where the issue can be replicated. You can report [issues here](https://github.com/gabrielogregorio/mark-tested-specs/issues/new).\n\nYou can make [suggestions here](https://github.com/gabrielogregorio/mark-tested-specs/discussions)\n\n## Next steps\n\n...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabrielogregorio%2Fmark-tested-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgabrielogregorio%2Fmark-tested-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabrielogregorio%2Fmark-tested-specs/lists"}