es-check-min

A CLI tool and library to find the minimum compatible ECMAScript version of a JavaScript file.

Overview

A simple tool built on es-check to find the lowest supported ECMAScript version of a JavaScript file.

The es-check-min tool does not require any arguments, and simply runs a loop to determine the lowest supported version. This is in slight contrast to es-check which checks a file against a specified ECMAScript version.

Detection of the following ECMAScript versions is supported:

• ES5
• ES6 / ES2015
• ES7 / ES2016
• ES8 / ES2017
• ES9 / ES2018
• ES10 / ES2019
• ES11 / ES2020
• ES12 / ES2021
• ES13 / ES2022

Note: The underlying es-check implementation technically supports ES3 and ES14 / ES2023, but certain tests aren't passing against these targets so they are not currently returned.

Getting started

Dependencies

The es-check-min CLI tool requires Node 20+. The exported APIs are ESM and share the Node 20+ requirement.

Installation

Invoke directly:

npx es-check-min

Or, install locally to access the CLI commands in a single project or to import the provided APIs:

npm install es-check-min

Or, install globally for access across your system:

npm install --global es-check-min

Usage

CLI

Example

es-check-min ./mystery-file.js

prints...

es6/es2015

Command

es-check-min <file>

| Positional Argument | Description | Type | | ------------------- | ------------------------------------- | -------- | | file | Path to the JavaScript file to check. | string |

| Option | Alias | Description | Type | | ----------- | ----- | ------------------- | --------- | | --help | -h | Show help | boolean | | --version | -v | Show version number | boolean |

Library

A single function is exported:

function esCheckMin(path: string): Promise<EsVersion | undefined>

Background

Requests for something like this have come up once or twice:

• Make babel tell me the minimum version of target that supports my code
• Feature Request: Wrapper command for "minimum ES version" for a file

Maintainers

@kitschpatrol

Acknowledgments

es-check-min is just a trivial wrapper over es-check. All credit goes to Jeff Wainwright and contributors for creating and maintaining es-check.

Contributing

Issues and pull requests are welcome.

License

MIT © Eric Mika