@remotion/eslint-plugin 4.0.0-oops.3 → 4.0.0-prefetch.7

package/dist/index.d.ts

@@ -7,6 +7,9 @@ declare const _default: {
         "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>;
         "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-remote": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"RelativePathStaticFile", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
     };
     configs: {
         recommended: {
@@ -18,6 +21,9 @@ declare const _default: {
                 "@remotion/even-dimensions": string;
                 "@remotion/duration-in-frames": string;
                 "@remotion/volume-callback": string;
+                "@remotion/use-gif-component": string;
+                "@remotion/staticfile-no-relative": string;
+                "@remotion/staticfile-no-remote": string;
             };
         };
     };

package/dist/index.js

@@ -4,11 +4,14 @@ 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_duration_frames_infinity_1 = __importDefault(require("./rules/no-duration-frames-infinity"));
 const no_mp4_import_1 = __importDefault(require("./rules/no-mp4-import"));
 const no_string_assets_1 = __importDefault(require("./rules/no-string-assets"));
-const warn_native_media_tag_1 = __importDefault(require("./rules/warn-native-media-tag"));
-const no_duration_frames_infinity_1 = __importDefault(require("./rules/no-duration-frames-infinity"));
+const staticfile_no_relative_1 = __importDefault(require("./rules/staticfile-no-relative"));
+const staticfile_no_remote_1 = __importDefault(require("./rules/staticfile-no-remote"));
+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 rules = {
     "no-mp4-import": no_mp4_import_1.default,
     "warn-native-media-tag": warn_native_media_tag_1.default,
@@ -17,6 +20,9 @@ const rules = {
     "even-dimensions": even_dimensions_1.default,
     "duration-in-frames": no_duration_frames_infinity_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,
 };
 module.exports = {
     rules,
@@ -30,6 +36,9 @@ module.exports = {
                 "@remotion/even-dimensions": "error",
                 "@remotion/duration-in-frames": "error",
                 "@remotion/volume-callback": "error",
+                "@remotion/use-gif-component": "error",
+                "@remotion/staticfile-no-relative": "error",
+                "@remotion/staticfile-no-remote": "error",
             },
         },
     },

package/dist/rules/deterministic-randomness.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const DeterministicRandomness = [

package/dist/rules/even-dimensions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const EvenDimensions = "Videos rendered in H264/H265 codec do not support dimensions that are not divisible by 2. Make the number even to resolve this warning. Ignore this warning if you don't plan on rendering this video with a H264 or H265 codec.";

package/dist/rules/no-duration-frames-infinity.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const DurationInFrames = "Infinity is now the default, so you can remove the prop.";

package/dist/rules/no-mp4-import.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const NoMP4Import = "Importing MP4 will work while you are previewing the video, but will not work while rendering since Puppeteer does not include the codecs necessary for MP4 videos. Convert the video to WebM first.";

package/dist/rules/no-string-assets.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const NoStringAssets = [

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

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

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

@@ -0,0 +1,64 @@
+"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/staticfile-relative-paths`;
+});
+const RelativePathStaticFile = [
+    "Don't pass a relative path to staticFile().",
+    "See: https://remotion.dev/docs/staticfile-relative-paths",
+].join("\n");
+exports.default = createRule({
+    name: "staticfile-no-relative",
+    meta: {
+        type: "problem",
+        docs: {
+            description: RelativePathStaticFile,
+            recommended: "warn",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            RelativePathStaticFile: RelativePathStaticFile,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            CallExpression: (node) => {
+                const value = node;
+                // src={"some string"}
+                if (!value) {
+                    return;
+                }
+                if (node.type === "CallExpression" &&
+                    node.callee.type === "Identifier" &&
+                    node.callee.name === "staticFile") {
+                    const args = node.arguments;
+                    if (args.length === 0) {
+                        return;
+                    }
+                    const firstArg = args[0];
+                    if (firstArg.type === "Literal") {
+                        const value = firstArg.value;
+                        if (typeof value !== "string") {
+                            return;
+                        }
+                        if (value.startsWith("./")) {
+                            context.report({
+                                messageId: "RelativePathStaticFile",
+                                node,
+                            });
+                        }
+                        if (value.startsWith("../")) {
+                            context.report({
+                                messageId: "RelativePathStaticFile",
+                                node,
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+});

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

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

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

@@ -0,0 +1,64 @@
+"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/staticfile-remote-urls`;
+});
+const RelativePathStaticFile = [
+    "Don't pass a remote URL to staticFile().",
+    "See: https://remotion.dev/docs/staticfile-remote-urls",
+].join("\n");
+exports.default = createRule({
+    name: "staticfile-no-remote",
+    meta: {
+        type: "problem",
+        docs: {
+            description: RelativePathStaticFile,
+            recommended: "warn",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            RelativePathStaticFile: RelativePathStaticFile,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            CallExpression: (node) => {
+                const value = node;
+                // src={"some string"}
+                if (!value) {
+                    return;
+                }
+                if (node.type === "CallExpression" &&
+                    node.callee.type === "Identifier" &&
+                    node.callee.name === "staticFile") {
+                    const args = node.arguments;
+                    if (args.length === 0) {
+                        return;
+                    }
+                    const firstArg = args[0];
+                    if (firstArg.type === "Literal") {
+                        const value = firstArg.value;
+                        if (typeof value !== "string") {
+                            return;
+                        }
+                        if (value.startsWith("http://")) {
+                            context.report({
+                                messageId: "RelativePathStaticFile",
+                                node,
+                            });
+                        }
+                        if (value.startsWith("https://")) {
+                            context.report({
+                                messageId: "RelativePathStaticFile",
+                                node,
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+});

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

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

package/dist/rules/staticfile-rules.js

@@ -0,0 +1,94 @@
+"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 UseGifComponent = [
+    "Use the <Gif> component for animated GIFs instead.",
+].join("\n");
+exports.default = createRule({
+    name: "use-gif-component",
+    meta: {
+        type: "problem",
+        docs: {
+            description: UseGifComponent,
+            recommended: "warn",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            UseGifComponent: UseGifComponent,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            JSXAttribute: (node) => {
+                if (node.type !== "JSXAttribute") {
+                    return;
+                }
+                if (node.name.name !== "src") {
+                    return;
+                }
+                const value = node.value;
+                // src={"some string"}
+                if (!value) {
+                    return;
+                }
+                const stringValue = value &&
+                    value.type === "JSXExpressionContainer" &&
+                    value.expression.type === "Literal"
+                    ? value.expression.value
+                    : value.type === "Literal"
+                        ? value.value
+                        : 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,
+                            });
+                        }
+                    }
+                }
+                if (value.type === "JSXExpressionContainer" &&
+                    value.expression.type === "CallExpression" &&
+                    value.expression.callee.type === "Identifier" &&
+                    value.expression.callee.name === "staticFile") {
+                    const args = value.expression.arguments;
+                    if (args.length === 0) {
+                        return;
+                    }
+                    const firstArg = args[0];
+                    if (firstArg.type === "Literal") {
+                        const value = firstArg.value;
+                        if (typeof value !== "string") {
+                            return;
+                        }
+                        if (value.includes(".gif")) {
+                            context.report({
+                                messageId: "UseGifComponent",
+                                node,
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+});

package/dist/rules/use-gif-component.d.ts

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

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

@@ -0,0 +1,96 @@
+"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 UseGifComponent = [
+    "Use the <Gif> component animated GIFs.",
+    "See: https://www.remotion.dev/docs/gif.",
+    "Ignore this message if this is a non-animated GIF.",
+].join("\n");
+exports.default = createRule({
+    name: "use-gif-component",
+    meta: {
+        type: "problem",
+        docs: {
+            description: UseGifComponent,
+            recommended: "warn",
+        },
+        fixable: undefined,
+        schema: [],
+        messages: {
+            UseGifComponent: UseGifComponent,
+        },
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            JSXAttribute: (node) => {
+                if (node.type !== "JSXAttribute") {
+                    return;
+                }
+                if (node.name.name !== "src") {
+                    return;
+                }
+                const value = node.value;
+                // src={"some string"}
+                if (!value) {
+                    return;
+                }
+                const stringValue = value &&
+                    value.type === "JSXExpressionContainer" &&
+                    value.expression.type === "Literal"
+                    ? value.expression.value
+                    : value.type === "Literal"
+                        ? value.value
+                        : 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,
+                            });
+                        }
+                    }
+                }
+                if (value.type === "JSXExpressionContainer" &&
+                    value.expression.type === "CallExpression" &&
+                    value.expression.callee.type === "Identifier" &&
+                    value.expression.callee.name === "staticFile") {
+                    const args = value.expression.arguments;
+                    if (args.length === 0) {
+                        return;
+                    }
+                    const firstArg = args[0];
+                    if (firstArg.type === "Literal") {
+                        const value = firstArg.value;
+                        if (typeof value !== "string") {
+                            return;
+                        }
+                        if (value.includes(".gif")) {
+                            context.report({
+                                messageId: "UseGifComponent",
+                                node,
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+});

package/dist/rules/volume-callback.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const VolumeCallback = "Prefer a callback function for setting the volume: `volume={(f) => interpolate(...)}`. See https://www.remotion.dev/docs/using-audio/#controlling-volume";

package/dist/rules/warn-native-media-tag.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@typescript-eslint/utils");
-const createRule = utils_1.ESLintUtils.RuleCreator((name) => {
+const createRule = utils_1.ESLintUtils.RuleCreator(() => {
     return `https://github.com/remotion-dev/remotion`;
 });
 const NoNativeImgTag = "Prefer the <Img /> tag from 'remotion' package, because it will wait until the image is loaded when you are rendering your video.";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/eslint-plugin",
-  "version": "4.0.0-oops.3+31c506229",
+  "version": "4.0.0-prefetch.7+47cce0679",
   "description": "A set of rules helping you avoid common pitfalls in Remotion.",
   "scripts": {
     "build": "tsc -d",
@@ -20,8 +20,8 @@
     "eslint": "8.13.0",
     "jest": "^27.2.4",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.5.5"
+    "typescript": "^4.7.0"
   },
   "private": false,
-  "gitHead": "31c506229ccf43f67dee263b0edce90ebbb2e22e"
+  "gitHead": "47cce06799563fb244ff25b211ea4055389bd7de"
 }