{"id":20758721,"url":"https://github.com/somewhatabstract/checksync","last_synced_at":"2025-07-16T22:31:59.294Z","repository":{"id":37801009,"uuid":"203869498","full_name":"somewhatabstract/checksync","owner":"somewhatabstract","description":"A tool for helping folks keep things in sync.","archived":false,"fork":false,"pushed_at":"2025-07-12T14:41:05.000Z","size":8182,"stargazers_count":18,"open_issues_count":14,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-12T16:12:22.810Z","etag":null,"topics":["code-quality","developer-tools","development-utils","development-workflow","linting","synchronization","tool","tools","tools-engineering"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/somewhatabstract.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2019-08-22T20:37:47.000Z","updated_at":"2025-07-12T14:36:44.000Z","dependencies_parsed_at":"2024-01-06T18:43:13.198Z","dependency_job_id":"e54b861b-78c2-4de8-b51b-affcbd50c755","html_url":"https://github.com/somewhatabstract/checksync","commit_stats":{"total_commits":1718,"total_committers":5,"mean_commits":343.6,"dds":"0.39522700814901046","last_synced_commit":"9bf92469f91b4a3cf45d0c6094a4f903725ffbcf"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/somewhatabstract/checksync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somewhatabstract%2Fchecksync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somewhatabstract%2Fchecksync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somewhatabstract%2Fchecksync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somewhatabstract%2Fchecksync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/somewhatabstract","download_url":"https://codeload.github.com/somewhatabstract/checksync/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somewhatabstract%2Fchecksync/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265545905,"owners_count":23785877,"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":["code-quality","developer-tools","development-utils","development-workflow","linting","synchronization","tool","tools","tools-engineering"],"created_at":"2024-11-17T09:53:25.572Z","updated_at":"2025-07-16T22:31:59.274Z","avatar_url":"https://github.com/somewhatabstract.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# checksync\n\n[![Node CI](https://github.com/somewhatabstract/checksync/workflows/Node%20CI/badge.svg)](https://github.com/somewhatabstract/checksync/actions) [![codecov](https://codecov.io/gh/somewhatabstract/checksync/branch/main/graph/badge.svg)](https://codecov.io/gh/somewhatabstract/checksync) [![npm (tag)](https://img.shields.io/npm/v/checksync/latest)](https://www.npmjs.com/package/checksync) [![Required Node Version](https://img.shields.io/node/v/checksync/latest)](https://www.npmjs.com/package/checksync)\n\n## Usage\n\nYou can install `checksync` if you want, but the easiest way to use it is via `npx`.\n\n```shell\nnpx checksync --help\n```\n\nFor detailed usage information, run `npx checksync --help`.\n\n### Example workflow\n\n1. Add synchronization tags to files indicating what sections to synchronize and with which files:\n\n    ```javascript\n    // my-javascriptfile.js\n    // sync-start:mysyncid ./my-pythonfile.py\n    /**\n     * Some code that needs to be synchronised.\n     */\n    // sync-end:mysyncid\n    ```\n\n    ```python\n    # my-pythonfile.py\n    # sync-start:mysyncid ./my-javascriptfile.js\n    '''\n    Some code that needs to be synchronised.\n    '''\n    # sync-end:mysyncid\n    ```\n\n    Use consecutive `sync-start` tags with the same identifier to target multiple files.\n\n    ```c#\n    // my-csharpfile.cs\n    // sync-start:mysyncid ./my-pythonfile.py\n    // sync-start:mysyncid ./my-javascriptfile.js\n    /**\n     * Some code that needs to be synchronised.\n     */\n    // sync-end:mysyncid\n    ```\n\n1. Run `checksync` to verify the tags are correct:\n\n    ```shell\n    pnpm checksync \u003cglobs|files|dirs\u003e\n    ```\n\n1. Run with `--update-tags` or `-u` to automatically insert the missing checksums:\n\n    ```shell\n    pnpm checksync -u \u003cglobs|files|dirs\u003e\n    ```\n\n1. Add a pre-commit step to run `checksync` on commiting changes so that you catch when synchronized blocks change.\n    You can do this using a package like husky, or pre-commit.\n\n1. Commit your tagged files!\n\nTo get more information about the various arguments that `checksync` supports as well as information about sync-tags, run `pnpm checksync --help`.\n\n### Target file paths\n\nAll target paths are relative to your project root directory. By default, this is determined, using `ancesdir` to be the ancestor directory of the files being processed that contains `package.json`. If you want to specify a different root (for example, if you're syncing across multiple packages in a monorepo) you can specify a custom marker name using the `--root-marker` argument.\n\n## Contributing\n\nFor details on contributing to `checksync`, checkout our [contribution guidelines](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomewhatabstract%2Fchecksync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsomewhatabstract%2Fchecksync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomewhatabstract%2Fchecksync/lists"}