FlowType and CSS Modules

_readme.md

Huh?

So basically FlowType doesn't know about CSS Modules, a really handy way of dealing with the plagues of CSS in codebases (global variables and dependency wackiness mainly).

What WebPack allows us to do is "require" CSS files and use their class names:

import styles from "my_styles.css";
import React from "react";

const MyComponent = React.createClass({
  render() {
    return <h1 className={styles.redHeader}>Hello!</h1>;
  }
});

Unfortunately, Flow will give us an error Required module not found because, well, let's be honest, importing CSS with JavaScript is pretty out of this world and a little bit crazy (i.e: this).

So here's what I did to fix that. Flow has a nice way of dealing with this in its options, namely one called module.name_mapper. Somebody was kind enough to make an npm module called empty that– you guessed it– returns empty objects and arrays. I'm pretty amazed to have found a use for this.

So as a fix, do this: Run npm install --save empty in your project directory.

Open your .flowconfig, and add the following under [options]:

module.name_mapper='.*\(.css\)' -> 'empty/object'

Ta-da! Another fun day in JavaScript land.

Sadly this didn't work for me and I'm not sure why. Has anyone else gotten this to work?

I couldn't get this to work either, however there is a solution in this thread.

interfaces/global.js

declare module CSSModule {
  declare var exports: { [key: string]: string };
}

.flowconfig

[include]
.*/src/.*

[libs]
./interfaces/global.js

[options]
module.name_mapper='.*\(.css\)' -> 'CSSModule'
module.system=haste
strip_root=true

Hope that helps somebody.

Thanks so much! That works for me.

It seems like the "strip_root=true" line isn't needed for CSS imports to work.

Also, it seems the regex in the name_mapper can be simplified to '.+.css$'.

And one more thing, under [libs] I was able to just use "interfaces" without the ./ or referring explicitly to global.js. That allows me to put other files in that directory as well and have them be processed.

The dot in a regex needs to be escaped, otherwise it's a wildcard. I have module.name_mapper='.+\.s?css' -> 'CSSModule'.

Without module.system=haste this doesn't work though. Any side-effects from setting this option? According to the docs haste is a Reacte Native thing, my app is not for React Native though.

The original post worked fine for me with these two notes:

The dot does need to be escaped like this: module.name_mapper='.*\(.css\)' -> 'empty/object'
empty/object is an actual npm module that you need to install: npm install --save-dev empty

I couldn't get this to work until I manually added all the file types I wanted flow to recognize:

module.file_ext=.js
module.file_ext=.json
module.file_ext=.jsx
module.file_ext=.css
module.file_ext=.scss

Thanks @nicolasartman - that finally got it fixed for me.

@nicolasartman +1 Thanks! :)

@nicolasartman +1 🎉

Other solution would be to generate definition file from css. As it done for TypeScript https://github.com/Quramy/typed-css-modules

By "works", do you guys just mean that Flow manages to parse your code correctly? Have you checked whether Flow actually can check that the correct props are specified when you use your component in JSX for example?

I was able to do something similar to what was suggested here but that will apparently make import CssModules from 'react-css-modules; export default CssModules(MyComponent, styles, options) spit out a new Component which is missing the information about the props so Flow cannot check it in JSX.

I was trying to put together a more sophisticated workaround today but without success. Would be interesting to hear if you also had this problem and if you can manage to figure out how to get my solution to work. I documented my efforts here: facebook/flow#2536

If anyone still cares, there's been a resolution to this problem on the flow issue I linked in my previous message.

Just a heads up to anyone who has trouble getting this working, it didn't for me until I added module.system=haste

Got the idea from here: facebook/flow#1068

In order to not have to declare CSSModule for every project, I've published an npm package that does so:

https://www.npmjs.com/package/css-module-flow

https://github.com/ckknight/css-module-flow

but what if you're importing styles without the extension, eg: import styles from '../css/foo' where foo is actually foo.css?

module.file_ext=.css doesn't seem to help in that matter. In fact, for me, it makes flow completely not work in VS Code.

Ghost's solution worked for me:

empty/object is an actual npm module that you need to install: npm install --save-dev empty

And then add this to .flowconfig

[options]
module.name_mapper='.*\(.s?css\)' -> 'empty/object'

What I really wanted was Flow to understand and typecheck my CSS Modules. So it would validate that a given identifier is actually in the .css file. Doing so would give us:

• static type checks showing usage of non existing classes
• editor autocompletion of CSS classes (for editors supporting Flow)

I actually just released a few tools to do this. Please give them a try! 😃

See:

• https://medium.com/@skovhus/type-safe-css-modules-with-flow-dd95e761bbe5
• https://github.com/skovhus/css-modules-flow-types

@jeznag Thanks! Your post actually saved my day.

@nicolasartman that worked

@skovhus That's brilliant! Way better than just ignoring the errors. Thanks for building this!

@jeznag: fantastic. you solution works for me..

Why install another dumb package? Just do this :)

[options]
module.name_mapper='.*(.css.scss)' -> '{}'

thanks @nicolasartman it works!

Thanks so much for sharing this!! You're a lifesaver.

Could not get your solution to work, @Luna2442. According to the documentation (https://flow.org/en/docs/config/options/#toc-module-name-mapper-regex-string),

module.name_mapper (regex -> string)

Specify a regular expression to match against module names, and a replacement pattern, separated by a ->.

For example:

module.name_mapper='^image![a-zA-Z0-9$_]+$' -> 'ImageStub'

This makes Flow treat require('image!foo.jpg') as if it were require('ImageStub').

These are OCaml regular expressions. Use \( and \) (slashes required!) to create a capturing group, which you can refer to in the replacement pattern as \1 (up to \9).

So (1) how did you get your regex capturing group to work without the required slashes and (2) how did you get Flow to ignore the .css imports by feeding it require('{}')?

Original solution works perfectly, @lambdahands

Slight modification from @jsermeno solution, which no longer works (facebook/flow#1806 (comment)):

interfaces/global.js

  declare var exports: { [key: string]: string };
  declare export default typeof exports;
}

.flowconfig

[...]

[libs]
./interfaces/global.js

[options]
module.name_mapper='^\(.*\)\.css$' -> 'CSSModule'
module.system=haste

[...]

I believe @lambdahands solution works, but doesn't offer type coverage.

As for me, the best solution is css-modules-flow-types.
It's not just a plug. This thing make types for your css modules.

Google brought me here, and it's late 2018, and still got that same issue and couldn't really solve it following the comments here, here's what I did eventually:

1. Create a dump module at PROJECT_ROOT/flow-typed/LESSModule.js.flow
2. Add this code inside of it

declare module 'LESSModule' {
  declare module.exports: any;
}

3. Add this line under [options] in .flowconfig (just this line, nothing more 😄)

module.name_mapper.extension='less' -> 'LESSModule'

Notes that I had to take are that the file name must begin with exactly the same name as the stub module name, if you're going to change the module name to SCSSModule or CSSModule, then change the file name accordingly, also put the file under that same directory, flow-typed should be already there if you did npm i --save flow-typed and ran flow-typed install, I tried putting that file somewhere else, but it didn't work.

👍 ❤️

@KareemSalah
not working for me,

$ node node_modules/.bin/flow check app.js
Error ┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈ app.js:5:8

Cannot resolve module my.less.

     2│
     3│ import "./my.sass"
     4│ import "LESSModule"
     5│ import "my.less"
     6│
     7│

Found 1 error