{"id":15775973,"url":"https://github.com/agentender/code-rub","last_synced_at":"2026-03-01T12:34:30.991Z","repository":{"id":40500417,"uuid":"439144506","full_name":"AgentEnder/code-rub","owner":"AgentEnder","description":"A CLI tool to implement regular code rub into a repository. ","archived":false,"fork":false,"pushed_at":"2024-09-16T18:57:21.000Z","size":2955,"stargazers_count":2,"open_issues_count":10,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T02:48:15.974Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://craigory.dev/code-rub/","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/AgentEnder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-12-16T22:33:40.000Z","updated_at":"2024-07-17T21:24:29.000Z","dependencies_parsed_at":"2024-10-25T21:17:33.857Z","dependency_job_id":"5613b413-9fc6-42a3-8578-64ac747974f7","html_url":"https://github.com/AgentEnder/code-rub","commit_stats":{"total_commits":50,"total_committers":3,"mean_commits":"16.666666666666668","dds":"0.21999999999999997","last_synced_commit":"11eea0039a2de0746138de1eb15635e8f5a16618"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/AgentEnder/code-rub","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fcode-rub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fcode-rub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fcode-rub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fcode-rub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgentEnder","download_url":"https://codeload.github.com/AgentEnder/code-rub/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fcode-rub/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29969248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T11:43:06.159Z","status":"ssl_error","status_checked_at":"2026-03-01T11:43:03.887Z","response_time":124,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2024-10-04T17:04:01.775Z","updated_at":"2026-03-01T12:34:30.479Z","avatar_url":"https://github.com/AgentEnder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# code-rub\n\nThis repository implements a base layer, CLI, and a few plugins to automate the process described here: https://hassanhabib.com/2020/02/09/code-rub/.\n\nThe core of code-rub is agnostic to ticketing system, project philosophy, and technology. On its own, it will do nothing except keep track of which files have been assigned for a rub, but it doesn't know how to actually create tickets and assign them. It doesn't even log them to the console by default.\n\n## Quick Start\n\nCurrently, a jira plugin and an azure-devops plugin are provided. If this suits your use case, run `npx code-rub init --preset {jira|azure-devops}`, and then fill in the placeholder values created in `code-rub.config.js`.\n\nIf this doesn't suit your use case, run `npx code-rub init` to generate a blank configuration. There are examples of local plugins in this repo's tool folder, and the `code-rub.config.js` file here demonstrates how to point to them. They can be either typescript or javascript. There are future plans to add azure-devops and github issues based support, but they are not yet implemented. PRs adding them are welcome 😀\n\n## Plugins\n\nThis is where the plugins come in. A code-rub plugin can change almost everything about the flow of `npx code-rub`. They can provide:\n\n- A setup function: `setup`\n- An initial configuration, used in `npx code-rub init --preset`: `initialConfiguration`\n- A method to process assignments, after they are generated: `processAssignments`\n- A method to process the file queue, useful for filtering out file extensions or paths: `processFileQueue`\n- A method to process the `Ignore` object used when generating the repository file map: `processIgnore`\n  - This is ran before `code-rub` saves the file map, so it affects all configuration files. This should only be specified in the repositories base configuration (or sole configuration).\n- A method to read and write the file map: `readFileMap` and `saveFileMap` respectively.\n  - Only one plugin may specify these methods.\n\nPlugins are specified by two pieces of configuration, the `plugins` array and the `pluginConfiguration` object. Plugin's are loaded based on the `plugins` array, and the capabilities they provide are configured through their entry in `pluginConfiguration`.\n\nPlugins are loaded, and executed based on their order in the `plugins` array. This is especially important for functions like `processFileQueue` which chains the results during execution.\n\n\u003e As an example, imagine you have plugin1 which removes typescript files but plugin2 expects them to be present. If you use `plugins: [plugin1, plugin2]`, plugin2 would not see any of the typescript files. If you use `plugins: [plugin2, plugin1]`, plugin2 would see them since they are not removed yet.\n\nFor an example plugin implementation, check the `jira` package in this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentender%2Fcode-rub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagentender%2Fcode-rub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentender%2Fcode-rub/lists"}