{"id":19869736,"url":"https://github.com/decaffeinate/decaffeinate-examples","last_synced_at":"2025-03-01T00:33:00.096Z","repository":{"id":66123891,"uuid":"80322863","full_name":"decaffeinate/decaffeinate-examples","owner":"decaffeinate","description":"A tool to automatically run decaffeinate on some open source projects","archived":false,"fork":false,"pushed_at":"2020-03-14T01:15:34.000Z","size":171,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-11T16:20:57.835Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/decaffeinate.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-01-29T01:32:05.000Z","updated_at":"2018-09-26T19:57:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"c8487e2e-f7a5-4828-9062-bdd19385fb87","html_url":"https://github.com/decaffeinate/decaffeinate-examples","commit_stats":{"total_commits":133,"total_committers":2,"mean_commits":66.5,"dds":0.03759398496240607,"last_synced_commit":"6d7e2543c36ee531c3db2c57c95d8de0794eef47"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decaffeinate%2Fdecaffeinate-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decaffeinate%2Fdecaffeinate-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decaffeinate%2Fdecaffeinate-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decaffeinate%2Fdecaffeinate-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decaffeinate","download_url":"https://codeload.github.com/decaffeinate/decaffeinate-examples/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241290509,"owners_count":19939281,"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":"2024-11-12T16:06:47.619Z","updated_at":"2025-03-01T00:33:00.091Z","avatar_url":"https://github.com/decaffeinate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# decaffeinate-examples\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/decaffeinate/decaffeinate-examples.svg)](https://greenkeeper.io/)\n\nA tool that can automatically run [decaffeinate] on the latest version of\nvarious open source projects.\n\n[decaffeinate]: https://github.com/decaffeinate/decaffeinate\n\n## Example usage\n\n```\nnpm install -g bulk-decaffeinate decaffeinate eslint jscodeshift\ngit clone https://github.com/decaffeinate/decaffeinate-examples\ncd decaffeinate-examples\nnpm install\nbin/example-runner hubot\n```\n\nThis will clone the hubot repo, configure it to allow JS files, convert the\nproject to JS using decaffeinate, and run all tests. If all goes well, all files\nshould convert successfully and all tests should pass.\n\n## Adding new projects\n\nA new project can be added by adding a new subdirectory to the\n[examples](./examples) directory. Each project should have the following:\n* A file called `config.js` exporting an object. That object should have a\n  `cloneUrl` field with the clone URL of the relevant repo, an\n  `extraDependencies` field for any additional packages to `npm install`, and\n  can opt into a \"default config\" that installs babel and eslint with\n  reasonable defaults.\n* A `bulk-decaffeinate.config.js` file that will be used for the decaffeinate\n  process.\n* Optionally, a `.gitignore_extension` file that is added to the end of the\n  `.gitignore`.\n* A file called `decaffeinate.patch` that applies a patch to the repo so that\n  tests can be run in JavaScript using `npm test`.\n\nIn general, this format is designed to be easy to read and modify; the patch\nfile should hopefully be as minimal as possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecaffeinate%2Fdecaffeinate-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecaffeinate%2Fdecaffeinate-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecaffeinate%2Fdecaffeinate-examples/lists"}