{"id":25000153,"url":"https://github.com/thinkmill/markings","last_synced_at":"2025-04-12T08:44:59.690Z","repository":{"id":55981475,"uuid":"244874470","full_name":"Thinkmill/markings","owner":"Thinkmill","description":"📝","archived":false,"fork":false,"pushed_at":"2023-08-03T06:18:27.000Z","size":815,"stargazers_count":12,"open_issues_count":4,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-08T17:54:38.500Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/Thinkmill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-03-04T10:43:00.000Z","updated_at":"2020-12-03T04:27:58.000Z","dependencies_parsed_at":"2024-06-19T06:11:23.454Z","dependency_job_id":"05a7ea2d-49f8-463f-82fa-46e5a9b8c5e9","html_url":"https://github.com/Thinkmill/markings","commit_stats":{"total_commits":78,"total_committers":8,"mean_commits":9.75,"dds":"0.34615384615384615","last_synced_commit":"0e828638589905fcb6e84c52b9df4fa55672b9de"},"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thinkmill%2Fmarkings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thinkmill%2Fmarkings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thinkmill%2Fmarkings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thinkmill%2Fmarkings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Thinkmill","download_url":"https://codeload.github.com/Thinkmill/markings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248543838,"owners_count":21121838,"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":[],"created_at":"2025-02-04T19:31:36.014Z","updated_at":"2025-04-12T08:44:59.671Z","avatar_url":"https://github.com/Thinkmill.png","language":"TypeScript","readme":"# 📝 Markings\n\nNever forget a `// TODO` or `// FIXME` again.\n\nNotes added to your code are surfaced visually when a page is rendered so they're always visible in context of what you're building.\n\nAnswer _\"What's left?\"_ with the project wide burn down list of all notes.\n\n## Getting Started\n\nIn its simplest form, the Markings CLI generates a report of all `TODO`, `FIXME` \u0026 `QUESTION` comments in your code:\n\n```\nyarn add @markings/cli @markings/source-comments @markings/output-html\n```\n\nAnd in your `package.json`*:\n\n```json\n{\n  \"scripts\": {\n    \"report\": \"markings\"\n  },\n  \"markings\": {\n    \"sources\": [{\n      \"source\": \"@markings/source-comments\",\n      \"include\": \"src/**/*.(j|t)s\"\n    }],\n    \"outputs\": [{\n      \"output\": \"@markings/output-html\",\n      \"filename\": \"report.html\"\n    }]\n  }\n}\n```\n\nFinally, run:\n\n```bash\nyarn report\n```\n\nTo generate `report.html`, containing all the detected `TODO`, `FIXME` \u0026 `QUESTION` comments in your code.\n\n### React\n\nWhen used within a React codebase, the special `\u003cMarking\u003e` component allows viewing a report directly in the page.\n\n```\nyarn add @markings/react @markings/source-react \n```\n\nWrap your application in `\u003cMarkingProvider\u003e`\n\n```javascript\nimport { MarkingProvider } from \"@markings/react\";\n\nconst App = () =\u003e (\n  \u003cMarkingProvider\u003e\n    \u003cdiv\u003e...\u003c/div\u003e\n  \u003c/MarkingProvider\u003e\n);\n```\n\nThen add `\u003cMarking\u003e` components around the components you want to mark\n\n```javascript\nimport { Marking } from \"@markings/react\";\nconst MyComponent = () =\u003e (\n  \u003cdiv\u003e\n    \u003ch1\u003eHello world\u003c/h1\u003e\n    \u003cMarking\n      description=\"Get the actual text back from the copywriters\"\n      purpose=\"todo\"\n    \u003e\n      \u003cp\u003eLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\u003c/p\u003e\n    \u003c/Marking\u003e\n  \u003c/div\u003e\n);\n```\n\nNow your page will have an inline report of all the detected `\u003cMarkings\u003e`.\n\n\u003e ℹ️ The inline report will _not_ include any `TODO` / `FIXME` / `QUESTION` comments.\n\nTo include React `\u003cMarkings\u003e` along side comments in your report output, add `@markings/source-react` to your `package.json`:\n\n```json\n{\n  \"markings\": {\n    \"sources\": [{\n      \"source\": \"@markings/source-comments\",\n      \"include\": \"src/**/*.(j|t)s\"\n    }, {\n      \"source\": \"@markings/source-react\",\n      \"include\": \"src/**/*.(j|t)s\"\n    }]\n  }\n}\n```\n\n## Outputs\n\nOutputs work with the Markings CLI to generate reports of all discovered markings.\n\nFirst, install the cli:\n\n```\nyarn add @markings/cli\n```\n\nAnd in your `package.json`*:\n\n```json\n{\n  \"scripts\": {\n    \"report\": \"markings\"\n  },\n}\n```\n\nThen, pick one or more outputs. For every output added, a report will be generated.\n\n### HTML\n\nGenerate a good looking html report.\n\n```\nyarn add @markings/output-html\n```\n\nAnd in your `package.json`*:\n\n```json\n{\n  \"markings\": {\n    \"outputs\": [{\n      \"output\": \"@markings/output-html\",\n      \"filename\": \"report.html\"\n    }]\n  }\n}\n```\n\n### JSON\n\nGenerate a detailed JSON report.\n\n```\nyarn add @markings/output-json\n```\n\nAnd in your `package.json`*:\n\n```json\n{\n  \"markings\": {\n    \"outputs\": [{\n      \"output\": \"@markings/output-json\",\n      \"filename\": \"report.json\"\n    }]\n  }\n}\n```\n\n### CSV\n\nGenerate a detailed CSV report.\n\n```\nyarn add @markings/output-csv\n```\n\nAnd in your `package.json`*:\n\n```json\n{\n  \"markings\": {\n    \"outputs\": [{\n      \"output\": \"@markings/output-csv\",\n      \"filename\": \"report.csv\"\n    }]\n  }\n}\n```\n\n---\n\n_\u003csup\u003e* In a monorepo? Place this in your root `package.json`.\u003c/sup\u003e_\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinkmill%2Fmarkings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthinkmill%2Fmarkings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinkmill%2Fmarkings/lists"}