A Flow fokozatos hozzáadása egy meglévő React alkalmazáshoz

A Flow statikus típusú ellenőrző a Javascript számára. Ez a bejegyzés azoknak szól, akik hallottak a Flow-ról, de még nem próbálták használni a React alkalmazáson belül. Ha ez az első alkalom, hogy hallott a Flow-ról, akkor Preethi Kasireddy négy bejegyzését ajánlhatom nagyszerű bevezetésként.

A Flow egyik nagyszerű tulajdonsága, hogy lehetséges fokozatosan használni. A használat megkezdéséhez nem kell teljesen átalakítania egy meglévő projektet. Csak új fájlokhoz adható hozzá, vagy lassan kipróbálható a meglévő fájlokban, hogy teljes elkötelezettség előtt megnézhesse, előnyöket nyújt-e az adott projektnek.

Mivel egy új eszköz beállítása gyakran a legnagyobb kihívást jelentheti, ebben a bejegyzésben egy meglévő projektet fogunk készíteni, és végigvezetjük a Flow hozzáadásának beállítását. A szintaxis általános bevezetésével Preethi bejegyzésének második része foglalkozik, és a Flow dokumentumok is nagyon olvashatók.

Ezt a repo példát fogjuk használni, két könyvtárral a Flow előtt és után. A Skyscanner egyedi Create React App szkriptjét használja backpack-react-scripts, az egyedi hátizsák-összetevőkkel párosítva. Ennek célja az egyes kivonatoknál összetettebb, mégis olvasható példák létrehozása, még akkor is, ha nem ismeri őket.

Az alkalmazás pontos jellege nem fontos, összehasonlítva a Flow nélküli és Flow nélküli megvalósítás közötti különbséggel. Nagyon kevés fájl változik itt, de ezek a legtöbbet elkeserítőek a helyes működéshez!

Menjünk végig minden lépést, majd vessünk egy pillantást a példakomponensek átalakítására.

Telepítse a fő függőségeket

Maga a Flow mellett telepítse a babel-cli-t és a babel-preset-flow-t, hogy a babel eltávolítsa a típusjegyzeteket a fordításkor.

npm install flow-bin babel-cli babel-preset-flow --save-dev

Beállítás Bábel

Ahhoz, hogy ezek hatályba lépjenek, hozzon létre egy .babelrcfájlt, vagy adja hozzá a meglévő .babelrckövetkező konfigurációhoz:

{ "presets": ["flow"] }

Parancsfájlok beállítása

Ha bármilyen kampót használ, például egy előzetes szkriptet, érdemes frissíteni ezeket, valamint hozzáadni az alap Flow szkriptet a következőhöz package.json:

"scripts": { "flow": "flow", "pretest": "npm run flow && npm run lint" }

Generáljon flowconfig-t

Ha fut áramlás először akkor létrehoz egy sablont .flowconfigfuttatásával npm run flow init. Példánkban láthatjuk, hogy kiterjesztjük a következővel:

Figyelmen kívül hagyja a mintákat

Annak elkerülése érdekében, hogy a Flow elemezze a csomópont moduljait és a build kimenetet, ezeket könnyen figyelmen kívül hagyhatja.

[ignore].*/node_modules/*.*/build/*

CSS modulok támogatásának hozzáadása

Ha CSS modulokat használ, meg kell adni a típusukat, hogy a Flow megértse őket, különben ezt a hibát kapja:

Ez két lépésben történik. Először az alábbiak kerülnek hozzáadásra .flowconfig:

[libs] ./src/types/global.js // this can be any path and filename you wish [options] module.name_mapper='^\(.*\)\.scss$' -> 'CSSModule' module.system=haste

Másodszor CSS modul típus jön létre a hivatkozott fájlban [libs].

// @flow declare module CSSModule { declare var exports: { [key: string]: string }; declare export default typeof exports; }

Szinkronizálás a többi használt festékkel

A példaprojektben az ESLint már használatos standard szöszölés biztosítására. Néhány kezdeti konfigurációs lépés szükséges ahhoz, hogy az ESLint jól játsszon a Flow-val, és néhány későbbi is, a projektben használt speciális típusok miatt.

Az általános beállításhoz a következőket adjuk hozzá .eslintrc:

"extends": [ "plugin:flowtype/recommended" ], "plugins": [ "flowtype" ]

Az e példára jellemző kiterjesztésekről és az általuk elkerülett hibákról a bejegyzés vége felé lesz szó.

Flow típusú libdefs

A telepítés utolsó része libdefsaz flow-typedNPM csomag használatával létrehozott felhasználásra való felkészülés . Ezzel létrehozzák a telepített csomópont modulok definícióit, és alapértelmezés szerint ezeket a fájlokat egy flow-typed/könyvtárba hozzák létre .

Mi köze akar elkövetni ezt a fájlt, de nem akarja, hogy ESLint Lint is. Ez problémát okoz, mivel korábban a szöszi szkriptünk a tudásunkra package.jsonvan beállítva .gitignore, miközben az ESLint fájloknak is figyelmen kívül kell hagyniuk:

"lint:js": "eslint . --ignore-path .gitignore --ext .js,.jsx",

Ezen most változtatni akarunk, mivel azt akarjuk, hogy az ESLint figyelmen kívül hagyja a létrehozandó flow-typed/könyvtárat is. Megváltoztathatjuk a szkriptünket:

"lint:js": "eslint . --ext .js,.jsx",

Ez azt jelenti, hogy most vissza fog térni egy .eslintignorefájl használatára, ezért ezt létre kell hoznunk, meg kell másolnunk a mi tartalmainkat .gitignore, és hozzá kell adnunk az extra könyvtárat, hogy ne vegyük figyelembe.

Végül telepítenünk kell flow-types. Ezt globálisan tesszük.

npm install flow-typed -g

libdefslehetnek teljes definíciók vagy csonkok, amelyek bármilyen típust elfogadnak. A teljes definíciók listája megmarad. Ha meg szeretné tudni, hogy van-e egy elérhető egy csomaghoz, használja

flow-typed install [email protected]

és ez vagy felveszi a flow-typedkönyvtárába, vagy arra kéri, hogy hozzon létre egy csonkot a

flow-typed create-stub [email protected]

Ha teljes meghatározást szeretne létrehozni, megteheti, és visszajuttathatja azt a lerakatba is, hogy az más fejlesztők számára is elérhető legyen.

A követendő egyszerű folyamat csak létrehozás libdefs, mivel kifejezetten szükségesek. Minden egyes összetevőhöz, amelyet átalakít a Flow használatára, adja hozzá az importálását flow-typedabban az időben, nem szükséges minden függőség típusát megadni, ha azokat nem használják olyan fájlokban, ahol a Flow-t is használják.

Meglévő komponensek konvertálása

That is all the general setup done, now we can look at converting our example components!

We have two, a stateful component and a function component. Overall these create a banner than has some text and a button. The text on the banner can be clicked to open a popover, containing a bullet pointed list.

Add flow-typed definitions

For any component, the first step is to create flow-typed definitions for any imports in the component we are working in.

For example, if we only had imports of

import React from 'react'; import BpkButton from 'bpk-component-button';

then we would try:

flow-typed install [email protected] on>

if it was not available, and it currently is not, then we would stub its definition:

flow-typed create-stub [email protected]

In the example repo we can see the list of all created definitions for the components we moved to using Flow. These were added one at a time as each component had Flow integrated with them.

Function Components

In our example without Flow we use PropTypes for some limited type checking and their ability to define defaultProps for use in development.

It may look a little complex on first glance, but there is relatively little that we need to change in order to add Flow.

To transform this to use Flow we can first remove the PropTypes import and definitions. The // @flow annotation can then be added to line one.

For this component we are only going to type check the props passed in. To do so we will first create a Props type, much cleaner than defining each prop individually inline.

type Props = { strings: { [string_key: string]: string }, onClose: Function, isOpen: boolean, target: Function, };

Here the latter three types are self-explanatory. As strings is an object of strings an object as a map has been used, checking each key and value in the object received to check that their types match, without having to specify their exact string keys.

The prop-types definitions can then be removed along with its import. As defaultProps are not tied to this import they can, and should, remain. *See the closing ESLint comments for any errors reported at this point.

The component should now look like this:

Stateful Components

Stateful components follow some slightly different declarations. As this component is more complex we will also look at declaring types for some additional aspects.

As before, first take a look at the component before adding Flow.

Props and State

As in the function component we first remove the propTypes definition and import, and add the // @flow annotation.

First we will take a look at adding types for Props and State. Again we will create types for these:

type Props = { strings: { [string_key: string]: string }, hideBannerClick: Function, }; type State = { popoverIsOpen: boolean, };

and specify that the component will use them:

class Banner extends Component { constructor(props: Props) { super(props); this.state = { popoverIsOpen: false, }; ... }; ... };

Next we hit our first difference between Function and Stateful components, defaultProps. In a Function component these were declared as we are used to, in Stateful components the external Banner.defaultProps syntax is removed, and instead the defaults are declared within the class:

class Banner extends Component { static defaultProps = { strings: defaultStrings, }; constructor(props: Props) { ... // the below is removed // Banner.defaultProps = { // strings: defaultStrings, // };

Constructor declarations

stringWithPlaceholder is declared within the constructor. Here we are not looking at why it is declared there (we will assume there is good reason), but rather to see whether flow can be added without any changes to the existing code.

If run in its existing state we would encounter the error Cannot get this.stringWithPlaceholder because property stringWithPlaceholder is missing in Banner [1].

To fix this we must add a single line inside the Banner class block, just beneath and outside of the constructor:

class Banner extends Component { constructor(props: Props) { super(props); this.state = { popoverIsOpen: false, }; this.stringWithPlaceholder = ... }; stringWithPlaceholder: string; ... };

This variable is created in the constructor but not passed in as props. As we are using Flow for type checking the props passed into the constructor, it requires everything within the constructor be type checked. It is known that Flow requires this, and this can be done by specifying their type in the class block.

At this point Props and State are complete. Let’s look at some quick additional examples of type checking within this component. *See the closing ESLint comments for any errors reported at this point.

Return, Event, and Node types

togglePopover takes no arguments, so a simple example of specifying no return value can be seen:

togglePopover = (): void => { ... };

keyboardOnlyTogglePopover returns nothing, but has a single parameter. This is an event, specifically a keypress event. SyntheticKeyboardEvent is used as

React uses its own event system so it is important to use the SyntheticEvent types instead of the DOM types such as Event, KeyboardEvent, and MouseEvent.
keyboardOnlyTogglePopover = (e: SyntheticKeyboardEvent): void => { ... };

Popover is defined in render() and returns an instance of the ListPopover Function component we looked a previously. We can specify its return type as a React Node. However, to be able to do so, we must first import it, as it is not accessible by default. There is more than one way to import it, one of which shown below:

import React, { Component } from 'react'; import type { Node } from 'react'; ... const Popover: Node = (  document.getElementById('ListPopoverLink')} /> );

Type checking imported React components

When Prop types have been declared in a component, they can be used when using that component within another. However, if you are using an index.js to export the first component then the flow, // @flow will need to be added to the index.

For example:

// @flow import ListPopover from './ListPopover'; export default ListPopover;

Marking props as optional

A prop can be marked as optional using the prop?: type syntax, for example:

type Props = { strings: { [string_key: string]: string }, hideBannerClick?: Function, };

This is supported, but no longer recommended by Flow. Instead all props should be left as required, with no ? , even if optional, as Flow automatically detects defaultProps and marks props with a default as optional internally.

In the section below we can see how manually marking props as optional can cause conflicts with other tools in some cases.

ESLint extensions, default props, and props validation error solutions

Two additions are made to our .eslintrc. For this project specifically you can simply accept their use, or read the detail below if you see any of the three errors:

  • x missing in props validation
  • error defaultProp "x" defined for isRequired propType
  • Cannot get strings.xxx because property xxx is missing in undefined

The rules added, with reasoning, are:

"react/default-props-match-prop-types": [ "error", { "allowRequiredDefaults": true } ]

When using objects as maps (in this case for the 'strings' prop) a missing in props validation error occurs. This is a bug and so is explicitly ignored here.

"react/default-props-match-prop-types": [ "error", { "allowRequiredDefaults": true }]

When using objects as maps complexities between ESLint, flow, and prop-types come into play.

strings is a required prop, passed as an object of strings. The flow type checks that for each entry in the object the string key is a string, and the value is a string. This is far more maintainable than having to list out the prop type of each specific key.

If the prop is marked as required in Flow then ESLint would error stating: error defaultProp "strings" defined for isRequired propType.

If the prop is manually marked as optional then Flow will error with Cannot get strings.xxx because property xxx is missing in undefined [1].

This is known and is due to refinement invalidation as JSX can transform method calls so Flow cannot be sure that xxx has not been redefined.

This leaves us with fixing the ESLint error. The rules above allows defaultProps to be defined while the Flow type is not marked as optional. Flow will understand this and convert it to optional. ESLint is marked to "allowRequiredDefaults": true, meaning that although ESLint sees the prop as required it will not error.

Final thoughts

Once over the initial hurdle of installation, Flow is fairly straightforward to use. The ability to add it incrementally definitely helps, rather than having to refactor an entire project in one go.

Hopefully the setup instructions and examples here prove useful if you are looking to try Flow out yourself.

Thanks for reading ?

You may also enjoy:

  • Testing React with Jest and Enzyme I
  • A beginner’s guide to Amazon’s Elastic Container Service
  • Using Pa11y CI and Drone as accessibility testing gatekeepers