Skip to content

Commit

Permalink
add note in readme about state of the project
Browse files Browse the repository at this point in the history
  • Loading branch information
gantoine committed May 11, 2024
1 parent c2ec346 commit e53319d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 22 deletions.
25 changes: 4 additions & 21 deletions README.md
Expand Up @@ -24,27 +24,10 @@
</a>
</p>

---

## ⚠️ Version 4.0 will release soon! ⚠️

And with it comes new features, most notably the support for **definition dependencies**.

Learn how to add dependencies to a definition from the `main` branch [docs](https://github.com/flow-typed/flow-typed/blob/main/CONTRIBUTING.md#importing-types-from-other-libdefs) which can be consumed with the `v4` CLI.

```bash
$ yarn global add flow-typed@next
# or
$ npm install -g flow-typed@next
```

### What's happening to `master`?

Nothing for the most part! CLI versions < `v4` will still pull definitions from `master` so if you have library definitions that don't require dependencies we still recommend you contribute to `master` and it'll get periodically synced back to `main` for users >= `v4`.

Eventually we will deprecate `master` in favour of `main`.

---
> [!NOTE]
> We want to keep the flow-typed community informed about the current state and future direction of the project. As you might have noticed, our activity has slowed down in recent months. However, we are committed to maintaining the functionality of flow-typed and will continue to fix any issues that arise with new releases of Flow.
>
> While we're not planning any major new features at the moment, we remain open to feature contributions from the community. Our focus remains on ensuring that the existing features work well and that type definitions are kept up to date. We appreciate the value that these contributions bring and encourage anyone interested in enhancing flow-typed to get involved.
Check out the [quick start](https://flow-typed.github.io/flow-typed/#/quickstart) page
in the docs to get started. It will walk you through installing typedefs, using them,
Expand Down
2 changes: 1 addition & 1 deletion cli/src/commands/__tests__/runTests-test.js
Expand Up @@ -30,7 +30,7 @@ describe('run-tests (command)', () => {
it("returns error code if $FlowExpectedError test doesn't fail", async () => {
const status = await runTest(false);
expect(status).toEqual(1);
});
}, 10000);

it('console logs about unused suppression', async () => {
await runTest(true);
Expand Down

0 comments on commit e53319d

Please sign in to comment.