find-babel-config

What is find-babel-config?

The find-babel-config npm package is a utility that helps in finding Babel configuration files in a project. It searches for Babel configuration files (.babelrc, .babelrc.js, babel.config.js) in the directory you specify and upwards through the directory tree until it finds a configuration file.

What are find-babel-config's main functionalities?

find Babel configuration

This feature allows you to find the Babel configuration file and its contents. The function returns a promise that resolves with an object containing the path to the configuration file and its contents if found.

const findBabelConfig = require('find-babel-config');

(async () => {
  const { file, config } = await findBabelConfig('./path/to/project');
  if (file) {
    console.log(`Found Babel config at: ${file}`);
    console.log('Config contents:', config);
  } else {
    console.log('No Babel config found.');
  }
})();

synchronous find

This feature provides a synchronous method to find the Babel configuration file. It returns an object with the path to the configuration file and its contents if found.

const findBabelConfig = require('find-babel-config');

const { file, config } = findBabelConfig.sync('./path/to/project');
if (file) {
  console.log(`Found Babel config at: ${file}`);
  console.log('Config contents:', config);
} else {
  console.log('No Babel config found.');
}

Other packages similar to find-babel-config

cosmiconfig

cosmiconfig is a more general configuration file finder that can be used to find Babel configurations among other types of configurations. It is more flexible and supports various file formats and custom loaders, which makes it a more versatile choice compared to find-babel-config.

README

find-babel-config

Helper function to retrieve the closest Babel configuration from a specific directory.

Installation

npm install --save find-babel-config

Usage

Async

// directory can be an absolute or relative path
// If it's a relative path, it is relative to the current working directory (process.cwd())
const directory = 'src';
findBabelConfig(directory).then(({ file, config }) => {
    if (file) {
        // file is the file in which the config is found
        console.log(file);
        // config is a JS plain object with the babel config
        console.log(config);
    }
});

Sync

// directory can be an absolute or relative path
// If it's a relative path, it is relative to the current working directory (process.cwd())
const directory = 'src';
const { file, config } = findBabelConfig.sync(directory);
// if file === null, the config wasn't found. (Also config === null)
if (file) {
    // file is the file in which the config is found
    console.log(file);
    // config is a JS plain object with the babel config
    console.log(config);
}

A second parameter can be given to findBabelConfig, it specifies the depth of search. By default, this value is Infinity but you can set the value you want: findBabelConfig('src', 10).

License

MIT, see LICENSE.md for details.

Changelog

2.1.2 (2024-09-02)

Bug Fixes

• replace path-exists for native (#77) (e7fd92f)