@remotion/eslint-plugin 4.0.0-webhook.27 → 4.1.0-alpha1

package/LICENSE.md

@@ -1,34 +1,34 @@
 # Remotion License
 
-Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion create videos for free (even commercial), while a company license is required for for-profit organisations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
 
 - [Free license](#free-license)
 - [Company license](#company-license)
 
 ## Free license
 
-Copyright © 2022 [Jonny Burger](https://jonny.io)
+Copyright © 2023 [Remotion](https://www.remotion.dev/)
 
 ### Eligibility
 
 You are eligible to use Remotion for free if you are:
 
 - an individual
-- a for-profit organisation with up to 3 employees
-- a non-profit or not-for-profit organisation
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
 - evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
 
 ### Allowed use cases
 
-Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify and the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
 
 ### Disallowed use cases
 
-It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, sublicensing your own derivate of Remotion.
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
 
 ### Warranty notice
 
-The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
 
 ### Support
 
@@ -36,6 +36,6 @@ Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
 
 ## Company license
 
-You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support.
+You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](/docs/support)).
 
 Visit [companies.remotion.dev](https://companies.remotion.dev) for pricing and to buy a license.

package/dist/index.d.ts

@@ -6,10 +6,13 @@ declare const _default: {
         "no-string-assets": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"NoStringAssets", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
         "even-dimensions": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"EvenDimensions", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
         "duration-in-frames": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"DurationInFrames", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        "from-0": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"From0", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
         "volume-callback": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"VolumeCallback", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
         "use-gif-component": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"UseGifComponent", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
-        "staticfile-no-relative": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"RelativePathStaticFile", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        "staticfile-no-relative": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"RelativePathStaticFile" | "AbsoluteStaticFile" | "PublicStaticFile", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
         "staticfile-no-remote": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"RelativePathStaticFile", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        "no-background-image": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"BackgroundImage", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        "v4-config-import": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"ImportConfig", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
     };
     configs: {
         recommended: {
@@ -20,10 +23,13 @@ declare const _default: {
                 "@remotion/no-string-assets": string;
                 "@remotion/even-dimensions": string;
                 "@remotion/duration-in-frames": string;
+                "@remotion/from-0": string;
                 "@remotion/volume-callback": string;
                 "@remotion/use-gif-component": string;
                 "@remotion/staticfile-no-relative": string;
                 "@remotion/staticfile-no-remote": string;
+                "@remotion/no-background-image": string;
+                "@remotion/v4-config-import": string;
             };
         };
     };

package/dist/index.js

@@ -4,7 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const deterministic_randomness_1 = __importDefault(require("./rules/deterministic-randomness"));
 const even_dimensions_1 = __importDefault(require("./rules/even-dimensions"));
+const no_background_image_1 = __importDefault(require("./rules/no-background-image"));
 const no_duration_frames_infinity_1 = __importDefault(require("./rules/no-duration-frames-infinity"));
+const no_from_0_1 = __importDefault(require("./rules/no-from-0"));
 const no_mp4_import_1 = __importDefault(require("./rules/no-mp4-import"));
 const no_string_assets_1 = __importDefault(require("./rules/no-string-assets"));
 const staticfile_no_relative_1 = __importDefault(require("./rules/staticfile-no-relative"));
@@ -12,6 +14,7 @@ const staticfile_no_remote_1 = __importDefault(require("./rules/staticfile-no-re
 const use_gif_component_1 = __importDefault(require("./rules/use-gif-component"));
 const volume_callback_1 = __importDefault(require("./rules/volume-callback"));
 const warn_native_media_tag_1 = __importDefault(require("./rules/warn-native-media-tag"));
+const v4_import_1 = __importDefault(require("./rules/v4-import"));
 const rules = {
     "no-mp4-import": no_mp4_import_1.default,
     "warn-native-media-tag": warn_native_media_tag_1.default,
@@ -19,10 +22,13 @@ const rules = {
     "no-string-assets": no_string_assets_1.default,
     "even-dimensions": even_dimensions_1.default,
     "duration-in-frames": no_duration_frames_infinity_1.default,
+    "from-0": no_from_0_1.default,
     "volume-callback": volume_callback_1.default,
     "use-gif-component": use_gif_component_1.default,
     "staticfile-no-relative": staticfile_no_relative_1.default,
     "staticfile-no-remote": staticfile_no_remote_1.default,
+    "no-background-image": no_background_image_1.default,
+    "v4-config-import": v4_import_1.default,
 };
 module.exports = {
     rules,
@@ -35,10 +41,13 @@ module.exports = {
                 "@remotion/no-string-assets": "error",
                 "@remotion/even-dimensions": "error",
                 "@remotion/duration-in-frames": "error",
+                "@remotion/from-0": "error",
                 "@remotion/volume-callback": "error",
                 "@remotion/use-gif-component": "error",
                 "@remotion/staticfile-no-relative": "error",
                 "@remotion/staticfile-no-remote": "error",
+                "@remotion/no-background-image": "error",
+                "@remotion/v4-config-import": "error",
             },
         },
     },

package/dist/rules/no-background-image.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"BackgroundImage", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/dist/rules/no-background-image.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
+    return "https://remotion.dev/docs/troubleshooting/background-image";
+});
+const BackgroundImage = [
+    "Don't use background-image in Remotion.",
+    "See: https://remotion.dev/docs/troubleshooting/background-image",
+].join("\n");
+exports.default = createRule({
+    name: "no-background-image",
+    meta: {
+        type: "problem",
+        docs: {
+            description: BackgroundImage,
+            recommended: "error",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            BackgroundImage: BackgroundImage,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            Property: (node) => {
+                if (node.key.type !== "Identifier") {
+                    return;
+                }
+                if (node.key.name !== "backgroundImage") {
+                    return;
+                }
+                if (node.value.type === "Literal") {
+                    const { value } = node.value;
+                    if (typeof value === "string" && value.includes("url(")) {
+                        context.report({
+                            messageId: "BackgroundImage",
+                            node,
+                        });
+                    }
+                }
+                if (node.value.type === "TemplateLiteral") {
+                    for (const element of node.value.quasis) {
+                        if (element.type !== "TemplateElement") {
+                            continue;
+                        }
+                        if (element.value.raw.includes("url(")) {
+                            context.report({
+                                messageId: "BackgroundImage",
+                                node,
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+});

package/dist/rules/no-from-0.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"From0", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/dist/rules/no-from-0.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
+    return `https://github.com/remotion-dev/remotion`;
+});
+const From0 = "0 is now the default, so you can remove the prop.";
+exports.default = createRule({
+    name: "from",
+    meta: {
+        type: "problem",
+        docs: {
+            description: From0,
+            recommended: "warn",
+        },
+        fixable: "code",
+        schema: [],
+        messages: {
+            From0,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            JSXAttribute: (node) => {
+                if (node.type !== "JSXAttribute") {
+                    return;
+                }
+                if (node.name.name !== "from") {
+                    return;
+                }
+                const value = node.value;
+                if (!value || value.type !== "JSXExpressionContainer") {
+                    return;
+                }
+                const expression = value.expression;
+                if (!expression || expression.type !== "Literal") {
+                    return;
+                }
+                const stringValue = expression.value;
+                if (stringValue !== 0) {
+                    return;
+                }
+                const parent = node.parent;
+                if (!parent) {
+                    return;
+                }
+                if (parent.type !== "JSXOpeningElement") {
+                    return;
+                }
+                const name = parent.name;
+                if (name.type !== "JSXIdentifier") {
+                    return;
+                }
+                if (name.name !== "Sequence") {
+                    return;
+                }
+                if (stringValue === 0) {
+                    context.report({
+                        messageId: "From0",
+                        node,
+                        fix: (fixer) => {
+                            return fixer.removeRange([node.name.range[0], value.range[1]]);
+                        },
+                    });
+                }
+            },
+        };
+    },
+});

package/dist/rules/staticfile-no-relative.d.ts

@@ -1,2 +1,3 @@
-declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"RelativePathStaticFile", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+type MessageIds = "RelativePathStaticFile" | "AbsoluteStaticFile" | "PublicStaticFile";
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<MessageIds, [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
 export default _default;

package/dist/rules/staticfile-no-relative.js

@@ -8,6 +8,14 @@ const RelativePathStaticFile = [
     "Don't pass a relative path to staticFile().",
     "See: https://remotion.dev/docs/staticfile-relative-paths",
 ].join("\n");
+const AbsoluteStaticFile = [
+    "Do not pass an absolute path to staticFile().",
+    "See: https://remotion.dev/docs/staticfile-relative-paths",
+].join("");
+const PublicStaticFile = [
+    "Do not prefix your assets with public/.",
+    "See: https://remotion.dev/docs/staticfile-relative-paths",
+].join("");
 exports.default = createRule({
     name: "staticfile-no-relative",
     meta: {
@@ -20,6 +28,8 @@ exports.default = createRule({
         schema: [],
         messages: {
             RelativePathStaticFile: RelativePathStaticFile,
+            PublicStaticFile: PublicStaticFile,
+            AbsoluteStaticFile: AbsoluteStaticFile,
         },
     },
     defaultOptions: [],
@@ -56,6 +66,26 @@ exports.default = createRule({
                                 node,
                             });
                         }
+                        if (value.startsWith("public/")) {
+                            context.report({
+                                messageId: "PublicStaticFile",
+                                node,
+                            });
+                        }
+                        if (value.startsWith("/Users") ||
+                            value.startsWith("/home") ||
+                            value.startsWith("/tmp") ||
+                            value.startsWith("/etc") ||
+                            value.startsWith("/opt") ||
+                            value.startsWith("/var") ||
+                            value.startsWith("C:") ||
+                            value.startsWith("D:") ||
+                            value.startsWith("E:")) {
+                            context.report({
+                                messageId: "AbsoluteStaticFile",
+                                node,
+                            });
+                        }
                     }
                 }
             },

package/dist/rules/use-gif-component.js

@@ -33,6 +33,20 @@ exports.default = createRule({
                 if (node.name.name !== "src") {
                     return;
                 }
+                const parent = node.parent;
+                if (!parent) {
+                    return;
+                }
+                if (parent.type !== "JSXOpeningElement") {
+                    return;
+                }
+                const name = parent.name;
+                if (name.type !== "JSXIdentifier") {
+                    return;
+                }
+                if (name.name !== "Img" && name.name !== "img") {
+                    return;
+                }
                 const value = node.value;
                 // src={"some string"}
                 if (!value) {
@@ -47,25 +61,12 @@ exports.default = createRule({
                         : null;
                 // src="image.gif"
                 if (typeof stringValue === "string") {
-                    const parent = node.parent;
-                    if (!parent) {
-                        return;
-                    }
-                    if (parent.type !== "JSXOpeningElement") {
-                        return;
-                    }
-                    const name = parent.name;
-                    if (name.type !== "JSXIdentifier") {
-                        return;
-                    }
-                    if (name.name === "Img" || name.name === "img") {
-                        // Network and inline URLs are okay
-                        if (stringValue.includes(".gif")) {
-                            context.report({
-                                messageId: "UseGifComponent",
-                                node,
-                            });
-                        }
+                    // Network and inline URLs are okay
+                    if (stringValue.includes(".gif")) {
+                        context.report({
+                            messageId: "UseGifComponent",
+                            node,
+                        });
                     }
                 }
                 if (value.type === "JSXExpressionContainer" &&

package/dist/rules/v4-import.d.ts

@@ -0,0 +1,2 @@
+declare const rule: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"ImportConfig", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default rule;

package/dist/rules/v4-import.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
+    return `https://v4.remotion.dev/docs/4-0-migration`;
+});
+const ImportConfig = "Update the import to the new V4 location: import {Config} from '@remotion/cli/config'";
+const rule = createRule({
+    name: "v4-config-import",
+    meta: {
+        type: "problem",
+        docs: {
+            description: ImportConfig,
+            recommended: "warn",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            ImportConfig,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            ImportDeclaration: (node) => {
+                if (node.source.value !== "remotion") {
+                    return;
+                }
+                const config = node.specifiers.find((s) => s.type === "ImportSpecifier" && s.imported.name === "Config");
+                if (config) {
+                    context.report({
+                        messageId: "ImportConfig",
+                        node,
+                    });
+                }
+            },
+        };
+    },
+});
+exports.default = rule;

package/dist/rules/warn-native-media-tag.d.ts

@@ -1,3 +1,3 @@
-declare type MessageIds = "NoNativeImgTag" | "NoNativeIFrameTag" | "NoNativeAudioTag" | "NoNativeVideoTag";
+type MessageIds = "NoNativeImgTag" | "NoNativeIFrameTag" | "NoNativeAudioTag" | "NoNativeVideoTag";
 declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<MessageIds, [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
 export default _default;

package/package.json

@@ -1,12 +1,7 @@
 {
   "name": "@remotion/eslint-plugin",
-  "version": "4.0.0-webhook.27+eb81308ee",
+  "version": "4.1.0-alpha1",
   "description": "A set of rules helping you avoid common pitfalls in Remotion.",
-  "scripts": {
-    "build": "tsc -d",
-    "test": "jest",
-    "watch": "tsc -w"
-  },
   "main": "dist/index.js",
   "bugs": {
     "url": "https://github.com/remotion-dev/remotion/issues"
@@ -16,12 +11,22 @@
   "dependencies": {
     "@typescript-eslint/utils": "5.19.0"
   },
+  "keywords": [
+    "eslint",
+    "eslintplugin"
+  ],
+  "peerDependencies": {
+    "eslint": ">=7.0.0"
+  },
   "devDependencies": {
-    "eslint": "8.13.0",
-    "jest": "^27.2.4",
-    "ts-jest": "^27.0.5",
-    "typescript": "^4.7.0"
+    "eslint": "8.42.0",
+    "typescript": "4.9.5",
+    "vitest": "0.31.1"
   },
   "private": false,
-  "gitHead": "eb81308ee07a402f4a8dd9ff24306bb07dd78175"
-}
+  "scripts": {
+    "build": "tsc -d",
+    "test": "vitest --run",
+    "watch": "tsc -w"
+  }
+}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../tsconfig.settings.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "skipLibCheck": true,
-    "jsx": "react-jsx"
-  },
-  "include": ["./src"]
-}