This repository has been archived by the owner. It is now read-only.
⛔ DEPRECATED ⛔ Flow type definition library for Mattermost
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
examples
flow
.babelrc
.eslintrc.json
.flowconfig
.gitignore
LICENSE
README.md
package.json
yarn.lock

README.md

⛔ DEPRECATED ⛔

This library has been deprecated by https://github.com/cometkim/mattermost-typed/issues/18

But mattermost-redux is starting to support flowtype! Please consider to contribute types to the Mattermost codebase.

Mattermost type definitions

Flow type definition library for Mattermost

Compatible with Mattermost API and Mattermost Redux

This project will help you in your Mattermost projects:

  • Understanding Mattermost codebase.
  • Preventing building bad request or parsing response incorrectly.
  • Improves productivity with intelligence support.

Install

Install

yarn add --dev mattermost-typed
npx flow init # initialize flow if you've not.

Add a line under libs tag on your .flowconfig

[libs]
+./node_modules/mattermost-typed/

Add the preset (if you use BabelJS)

yarn add --dev babel-preset-flow

.babelrc

preset: [
+  "flow"
]

How to use

By CLI

npx flow [COMMAND] 

or add script into your package.json

scripts: {
+  "flow": "flow"
}

VSCode Extentions

Why?

You might wonder if this is really necessary.
Well, Here is why I came to think it is - Expect the type of Get Posts API.

I was building a Mattermost integration and I expected it would of course be an array of Post.
And I had to see the result of map is not a function because of the result of the Get Posts API that looks like:

{
  "order": [
    "post_id1",
    "post_id2"
  ],
  "posts": {
    "post1": {},
    "post2": {}
  }
}
  • It was your fault. Mattermost have documentation for it.
  • Why did you not write test, evil.

You can think it is wrong not to check the documentation or write test code. But generally it could be skip when productivity is important like in prototyping. type checking is simple and a great solution to avoid mistakes.

  • PropTypes is not enough?

PropTypes is great sollution to assert types. But it's only for React component.

Typescript?

TODO