@remotion/eslint-config 4.0.176 → 4.0.178

package/README.md

@@ -0,0 +1,18 @@
+# @remotion/eslint-config
+ 
+Default configuration for Remotion templates
+ 
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/eslint-config.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/eslint-config?minimal=true)
+ 
+## Installation
+ 
+```bash
+npm install @remotion/eslint-config --save-exact
+```
+ 
+When installing a Remotion package, make sure to align the version of all `remotion` and `@remotion/*` packages to the same version.
+Remove the `^` character from the version number to use the exact version.
+ 
+## Usage
+ 
+See the [documentation](https://www.remotion.dev/docs/brownfield#install-the-eslint-plugin) for more information.

package/dist/patch-eslint.js

@@ -37,25 +37,27 @@ const allowESLintShareableConfig = () => {
     // Probe for the ESLint >=8.0.0 layout:
     for (let currentModule = module;;) {
         if (!eslintrcBundlePath) {
-            // For ESLint >=8.0.0, all @eslint/eslintrc code is bundled at this path:
-            //   .../@eslint/eslintrc/dist/eslintrc.cjs
-            try {
-                const eslintrcFolder = path_1.default.dirname(require.resolve("@eslint/eslintrc/package.json", {
-                    paths: [currentModule.path],
-                }));
-                // Make sure we actually resolved the module in our call path
-                // and not some other spurious dependency.
-                if (path_1.default.join(eslintrcFolder, "dist/eslintrc.cjs") ===
-                    currentModule.filename) {
-                    eslintrcBundlePath = path_1.default.join(eslintrcFolder, "dist/eslintrc.cjs");
+            if (currentModule.filename.endsWith('eslintrc.cjs')) {
+                // For ESLint >=8.0.0, all @eslint/eslintrc code is bundled at this path:
+                //   .../@eslint/eslintrc/dist/eslintrc.cjs
+                try {
+                    const eslintrcFolderPath = path_1.default.dirname(require.resolve("@eslint/eslintrc/package.json", {
+                        paths: [currentModule.path],
+                    }));
+                    // Make sure we actually resolved the module in our call path
+                    // and not some other spurious dependency.
+                    const resolvedEslintrcBundlePath = path_1.default.join(eslintrcFolderPath, 'dist/eslintrc.cjs');
+                    if (resolvedEslintrcBundlePath === currentModule.filename) {
+                        eslintrcBundlePath = resolvedEslintrcBundlePath;
+                    }
                 }
-            }
-            catch (ex) {
-                // Module resolution failures are expected, as we're walking
-                // up our require stack to look for eslint. All other errors
-                // are rethrown.
-                if (!isModuleResolutionError(ex)) {
-                    throw ex;
+                catch (ex) {
+                    // Module resolution failures are expected, as we're walking
+                    // up our require stack to look for eslint. All other errors
+                    // are rethrown.
+                    if (!isModuleResolutionError(ex)) {
+                        throw ex;
+                    }
                 }
             }
         }
@@ -68,8 +70,19 @@ const allowESLintShareableConfig = () => {
                 }));
                 // Make sure we actually resolved the module in our call path
                 // and not some other spurious dependency.
-                if (path_1.default.join(eslintCandidateFolder, "lib/cli-engine/cli-engine.js") ===
-                    currentModule.filename) {
+                // 1. VS Code's eslint extension uses eslint/use-at-your-own-risk when you
+                // turn on flat config
+                // 2. eslint's use-at-your-own-risk maps to lib/unsupported-api.js
+                // 3. lib/unsupported-api.js loads lib/cli-engine/file-enumerator.js, not
+                // lib/cli-engine/cli-engine.js
+                // 4. eslint-patch prior to this change specifically searched for
+                // lib/cli-engine/cli-engine.js in the import stack, and if it wasn't
+                // found, it would assume an older version of eslint, and that would cause
+                // an error
+                // Below change allows for any file inside the eslint package to count,
+                // allowing VS Code's eslint extension to work when you use eslint's flat
+                // config
+                if (currentModule.filename.startsWith(eslintCandidateFolder + path_1.default.sep)) {
                     eslintFolder = eslintCandidateFolder;
                     break;
                 }
@@ -89,10 +102,10 @@ const allowESLintShareableConfig = () => {
         currentModule = currentModule.parent;
     }
     if (!eslintFolder) {
-        // Probe for the ESLint >=7.8.0 layout:
+        // Probe for the ESLint >=7.12.0 layout:
         for (let currentModule = module;;) {
             if (!configArrayFactoryPath) {
-                // For ESLint >=7.8.0, config-array-factory.js is at this path:
+                // For ESLint >=7.12.0, config-array-factory.js is at this path:
                 //   .../@eslint/eslintrc/lib/config-array-factory.js
                 try {
                     const eslintrcFolder = path_1.default.dirname(require.resolve("@eslint/eslintrc/package.json", {
@@ -113,7 +126,7 @@ const allowESLintShareableConfig = () => {
                     }
                 }
             }
-            else {
+            else if (currentModule.filename.endsWith('cli-engine.js')) {
                 // Next look for a file in ESLint's folder
                 //   .../eslint/lib/cli-engine/cli-engine.js
                 try {
@@ -142,9 +155,9 @@ const allowESLintShareableConfig = () => {
         }
     }
     if (!eslintFolder) {
-        // Probe for the <7.8.0 layout:
+        // Probe for the <7.12.0 layout:
         for (let currentModule = module;;) {
-            // For ESLint <7.8.0, config-array-factory.js was at this path:
+            // For ESLint <7.12.0, config-array-factory.js was at this path:
             //   .../eslint/lib/cli-engine/config-array-factory.js
             if (/[\\/]eslint[\\/]lib[\\/]cli-engine[\\/]config-array-factory\.js$/i.test(currentModule.filename)) {
                 eslintFolder = path_1.default.join(path_1.default.dirname(currentModule.filename), "../..");
@@ -156,7 +169,7 @@ const allowESLintShareableConfig = () => {
                 // This was tested with ESLint 6.1.0 .. 7.12.1.
                 throw new Error("Failed to patch ESLint because the calling module was not recognized.\n" +
                     "If you are using a newer ESLint version that may be unsupported, please create a GitHub issue:\n" +
-                    "https://github.com/microsoft/rushstack/issues");
+                    "https://github.com/remotion-dev/remotion/issues");
             }
             currentModule = currentModule.parent;
         }
@@ -172,14 +185,14 @@ const allowESLintShareableConfig = () => {
         throw new Error("Unable to parse ESLint version: " + eslintPackageVersion);
     }
     const eslintMajorVersion = Number(versionMatch[1]);
-    if (!(eslintMajorVersion >= 6 && eslintMajorVersion <= 8)) {
-        throw new Error("The patch-eslint.js script has only been tested with ESLint version 6.x, 7.x, and 8.x." +
+    if (!(eslintMajorVersion >= 6 && eslintMajorVersion <= 9)) {
+        throw new Error("The patch-eslint.js script has only been tested with ESLint version 6.x, 7.x, and 8.x, and 9.x." +
             ` (Your version: ${eslintPackageVersion})\n` +
             "Consider reporting a GitHub issue:\n" +
-            "https://github.com/microsoft/rushstack/issues");
+            "https://github.com/remotion-dev/remotion/issues");
     }
     let ConfigArrayFactory;
-    if (eslintMajorVersion === 8) {
+    if (eslintMajorVersion >= 8) {
         ConfigArrayFactory = require(eslintrcBundlePath).Legacy.ConfigArrayFactory;
     }
     else {
@@ -188,7 +201,7 @@ const allowESLintShareableConfig = () => {
     if (!ConfigArrayFactory.__patched) {
         ConfigArrayFactory.__patched = true;
         let ModuleResolver;
-        if (eslintMajorVersion === 8) {
+        if (eslintMajorVersion >= 8) {
             ModuleResolver = require(eslintrcBundlePath).Legacy.ModuleResolver;
         }
         else {

package/package.json

@@ -1,7 +1,10 @@
 {
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion/tree/main/packages/eslint-config"
+  },
   "name": "@remotion/eslint-config",
-  "version": "4.0.176",
-  "description": "",
+  "version": "4.0.178",
+  "description": "Default configuration for Remotion templates",
   "main": "dist/index.js",
   "files": [
     "dist"
@@ -17,15 +20,11 @@
     "eslint-plugin-10x": "1.5.2",
     "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "@remotion/eslint-plugin": "4.0.176"
+    "@remotion/eslint-plugin": "4.0.178"
   },
   "peerDependencies": {
     "eslint": ">=7.15.0"
   },
-  "devDependencies": {
-    "@types/node": "18.14.6",
-    "eslint": "8.56.0"
-  },
   "keywords": [
     "remotion",
     "ffmpeg",
@@ -35,5 +34,6 @@
   ],
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "homepage": "https://www.remotion.dev/docs/brownfield#install-the-eslint-plugin"
 }