From 33392cd925190dc06c1a96cfb5a6fa5e96725ffc Mon Sep 17 00:00:00 2001
From: Noel De Martin <noel@moodle.com>
Date: Thu, 23 Nov 2023 17:42:03 +0100
Subject: [PATCH] Implement polyfills option in CLI

---
 packages/check-es-compat/README.md   | 10 +++++++
 packages/check-es-compat/bin/cli.mjs | 43 ++++++++++++++++++++++++++--
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/packages/check-es-compat/README.md b/packages/check-es-compat/README.md
index d5ad6db..34da439 100644
--- a/packages/check-es-compat/README.md
+++ b/packages/check-es-compat/README.md
@@ -19,6 +19,16 @@ Firefox >= 58
 
 <!--- Absolute link, in order to work from NPM website --->
 
+The optional `--polyfills` argument can be used to specify polyfills that your application loads. These features are
+therefore considered supported in all browsers. Features that are polyfillable and can be specified here can be found
+in the [rule schema](https://github.com/robatwilliams/es-compat/blob/master/packages/eslint-plugin-ecmascript-compat/lib/rule.js).
+
+```bash
+$ npx check-es-compat . --polyfills="Array.prototype.includes,Promise.prototype.finally"
+```
+
+<!--- Absolute link, in order to work from NPM website --->
+
 It [doesn't currently support](https://github.com/robatwilliams/es-compat/issues/69) ES modules.
 
 <!--- Absolute link, in order to work from NPM website --->
diff --git a/packages/check-es-compat/bin/cli.mjs b/packages/check-es-compat/bin/cli.mjs
index f4c0b55..49b9052 100644
--- a/packages/check-es-compat/bin/cli.mjs
+++ b/packages/check-es-compat/bin/cli.mjs
@@ -17,7 +17,8 @@ if (args.length === 0) {
   }
 }
 
-async function execute(files) {
+async function execute(args) {
+  const { files, polyfills } = parseArguments(args);
   const eslint = new ESLint({
     // Ignore any config files
     useEslintrc: false,
@@ -34,7 +35,7 @@ async function execute(files) {
         es2023: true,
       },
       rules: {
-        'ecmascript-compat/compat': 'error',
+        'ecmascript-compat/compat': ['error', { polyfills }],
       },
     },
   });
@@ -46,3 +47,41 @@ async function execute(files) {
 
   return { hasErrors: results.some((result) => result.errorCount > 0) };
 }
+
+function parseArguments(args) {
+    const files = [];
+    const polyfills = [];
+    let nextArgIsPolyfills = false;
+
+    for (const arg of args) {
+        if (nextArgIsPolyfills) {
+            nextArgIsPolyfills = false;
+            polyfills.push(...splitPolyfillsArgument(arg));
+            continue;
+        }
+
+        if (arg.startsWith('--polyfills')) {
+            if (arg.startsWith('--polyfills=')) {
+                polyfills.push(...splitPolyfillsArgument(arg.slice(12)));
+            } else {
+                nextArgIsPolyfills = true;
+            }
+
+            continue;
+        }
+
+        files.push(arg);
+    }
+
+    return { files, polyfills };
+}
+
+function splitPolyfillsArgument(polyfills) {
+    const prototypeAtPolyfill = '{Array,String,TypedArray}.prototype.at';
+    const prototypeAtPlaceholder = '{{PROTOTYPEAT}}';
+
+    return polyfills
+        .replace(prototypeAtPolyfill, prototypeAtPlaceholder)
+        .split(',')
+        .map(polyfill => polyfill === prototypeAtPlaceholder ? prototypeAtPolyfill : polyfill);
+}