Flow Configuration File Parser

0.3.0 · abandoned · verified Sun Apr 19

A utility package designed to parse `.flowconfig` files, enabling programmatic access to Flow type checker's configuration settings. The current and last published version of `flow-config-parser` is 0.3.0, released over seven years ago. While its repository `https://github.com/codemix/flow-runtime` remains active for other, related packages, `flow-config-parser` itself is no longer actively developed or maintained, making it effectively abandoned as a standalone package. It provides functions to inspect specific settings like `munge_underscores`, determine suppressed types, identify ignored files, and resolve module remapping directives within Flow's configuration.

Warnings

breaking This package, `flow-config-parser`, is effectively abandoned. The last release was v0.3.0 over seven years ago. Users should be aware that it may not be compatible with newer Node.js versions, Flow versions, or modern JavaScript ecosystems (e.g., ESM modules).
Fix: Consider parsing `.flowconfig` manually or finding a more actively maintained alternative. If used, pin the version carefully and ensure compatibility with your specific environment.
gotcha The GitHub repository linked (`https://github.com/codemix/flow-runtime`) and the provided 'Recent releases' (e.g., v0.19.0 for `babel-plugin-flow-runtime`) are for the broader `flow-runtime` project, not `flow-config-parser` itself. `flow-config-parser` has not been updated since v0.3.0.
Fix: Refer to `flow-config-parser`'s npm page for its specific version history and package details. Do not rely on release notes from `flow-runtime` for this package.

Install

npm install flow-config-parser npm
yarn add flow-config-parser yarn
pnpm add flow-config-parser pnpm

Imports

parse
wrong:
```
const parse = require('flow-config-parser')
```
correct:
```
import parse from 'flow-config-parser'
```
The `parse` function is the default and primary export for parsing `.flowconfig` files. The README example contains a typo where it imports `parse` then uses `parser.parse`; it should be `parse(...)` directly.

Quickstart

Demonstrates how to import the parser, read a `.flowconfig` file, and use the resulting configuration object to query various Flow settings.

import fs from 'node:fs';
import parse from 'flow-config-parser';

const flowConfigContent = fs.readFileSync('.flowconfig', 'utf8');
const config = parse(flowConfigContent);

console.log('Munge underscores:', config.get('munge_underscores')); // Example: true or false
console.log('Suppresses type $flowIgnore:', config.suppressesType('$flowIgnore')); // Example: true or false
console.log('Suppresses type Boolean:', config.suppressesType('Boolean')); // Example: true or false
console.log('Ignores file node_modules/react/react.js:', config.ignoresFile('node_modules/react/react.js')); // Example: true or false
console.log('Remaps module foo.scss:', config.remapModule('foo.scss')); // Example: 'object-shim.js' or null

view raw JSON →