{"id":13684332,"url":"https://github.com/withspectrum/danger-plugin-flow","last_synced_at":"2025-04-30T20:33:50.317Z","repository":{"id":57156699,"uuid":"125213204","full_name":"withspectrum/danger-plugin-flow","owner":"withspectrum","description":"Ensure all JS files that get touched in a PR are flow typed","archived":true,"fork":false,"pushed_at":"2019-08-20T18:11:48.000Z","size":417,"stargazers_count":21,"open_issues_count":13,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-19T19:49:05.280Z","etag":null,"topics":["danger","danger-plugin"],"latest_commit_sha":null,"homepage":null,"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/withspectrum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-14T13:01:59.000Z","updated_at":"2023-08-15T16:23:48.000Z","dependencies_parsed_at":"2022-08-30T03:21:11.549Z","dependency_job_id":null,"html_url":"https://github.com/withspectrum/danger-plugin-flow","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withspectrum%2Fdanger-plugin-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withspectrum%2Fdanger-plugin-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withspectrum%2Fdanger-plugin-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withspectrum%2Fdanger-plugin-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/withspectrum","download_url":"https://codeload.github.com/withspectrum/danger-plugin-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251777758,"owners_count":21642219,"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":["danger","danger-plugin"],"created_at":"2024-08-02T14:00:32.302Z","updated_at":"2025-04-30T20:33:50.057Z","avatar_url":"https://github.com/withspectrum.png","language":"TypeScript","funding_links":[],"categories":["Plugins"],"sub_categories":["TypeScript (danger-js)"],"readme":"# danger-plugin-flow\n\n[![Build Status](https://travis-ci.org/withspectrum/danger-plugin-flow.svg?branch=master)](https://travis-ci.org/withspectrum/danger-plugin-flow)\n[![npm version](https://badge.fury.io/js/danger-plugin-flow.svg)](https://badge.fury.io/js/danger-plugin-flow)\n\n\u003e Ensure all new `.js` files in a project are flow typed\n\n## Usage\n\nInstall:\n\n```sh\nyarn add danger-plugin-flow --dev\n```\n\nAt a glance:\n\n```js\n// dangerfile.js\nimport { schedule } from 'danger'\nimport flow from 'danger-plugin-flow'\n\nschedule(flow());\n```\n\n### Options\n\n**Recommended setup**:\n\n```JS\nschedule(flow({\n  modified: \"warn\",\n  created: \"fail\"\n}))\n```\n\nThis will fail the build for any newly introduced file that isn't flow typed, but will only warn the developer if they touch a file that's not flow typed. This is what we use because it can be hard to type legacy code, but we want to ensure every newly incoming code is properly typed.\n\n#### `blacklist`\n\nBlacklist certain globs from being checked:\n\n```JS\nschedule(flow({\n  blacklist: ['dist/**/*.js']\n}))\n```\n\n#### `created`\n\nDecide whether you want to warn, fail or ignore newly created files that are untyped:\n\n```JS\nschedule(flow({\n  created: \"warn\"\n}))\n\nschedule(flow({\n  created: \"fail\"\n}))\n\nschedule(flow({\n  created: false\n}))\n```\n\n#### `modified`\n\nDecide whether you want to warn, fail or ignore modified files that are untyped:\n\n```JS\nschedule(flow({\n  modified: \"warn\"\n}))\n\nschedule(flow({\n  modified: \"fail\"\n}))\n\nschedule(flow({\n  modified: false\n}))\n```\n\n## Changelog\n\nSee the GitHub [release history](https://github.com/withspectrum/danger-plugin-flow/releases).\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithspectrum%2Fdanger-plugin-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwithspectrum%2Fdanger-plugin-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithspectrum%2Fdanger-plugin-flow/lists"}