mirror of
https://github.com/vector-im/element-call.git
synced 2026-10-16 23:45:50 +00:00
Timo K.
31eafb394b
They are copied for now but will be removed from element call once it adopts the sdk. Those are no real line additions.
97 lines
2.7 KiB
JavaScript
97 lines
2.7 KiB
JavaScript
/*
|
|
Copyright 2026 Element Creations Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE in the repository root for full details.
|
|
*/
|
|
|
|
import { dirname, resolve, sep } from "node:path";
|
|
import { ESLintUtils } from "@typescript-eslint/utils";
|
|
|
|
/**
|
|
* Packages a host supplies and the SDK must not know about: UI, i18n and
|
|
* Element Call's design system.
|
|
*/
|
|
const BANNED_PACKAGES = [
|
|
"react",
|
|
"react-dom",
|
|
"react-i18next",
|
|
"i18next",
|
|
"@vector-im/",
|
|
];
|
|
|
|
/**
|
|
* Keeps the SDK free of Element Call: nothing under `sdk/` may import a file
|
|
* outside `sdk/` by relative path (that is `src/`, `component/`,
|
|
* `playwright/`) or one of the packages above. The development harness under
|
|
* `sdk/dev/` is a host, not part of the library, and is exempt.
|
|
*/
|
|
const rule = ESLintUtils.RuleCreator(
|
|
() => "https://github.com/element-hq/element-call",
|
|
)({
|
|
name: "sdk-import-boundary",
|
|
meta: {
|
|
type: "problem",
|
|
docs: {
|
|
description:
|
|
"Disallow the SDK importing Element Call (anything outside sdk/) or host-supplied packages.",
|
|
},
|
|
messages: {
|
|
outsideSdk:
|
|
"The SDK must not import '{{specifier}}': it resolves outside sdk/. Copy or move what it needs into sdk/src.",
|
|
bannedPackage:
|
|
"The SDK must not import '{{specifier}}': a host supplies that, the SDK has no UI.",
|
|
},
|
|
schema: [],
|
|
},
|
|
defaultOptions: [],
|
|
create(context) {
|
|
const filename = context.filename;
|
|
const sdkRoot = resolve(context.cwd, "sdk") + sep;
|
|
if (!filename.startsWith(sdkRoot)) return {};
|
|
if (filename.startsWith(resolve(sdkRoot, "dev") + sep)) return {};
|
|
|
|
const check = (node, specifier) => {
|
|
if (typeof specifier !== "string") return;
|
|
if (specifier.startsWith(".")) {
|
|
const target = resolve(dirname(filename), specifier);
|
|
if (!target.startsWith(sdkRoot))
|
|
context.report({
|
|
node,
|
|
messageId: "outsideSdk",
|
|
data: { specifier },
|
|
});
|
|
} else if (
|
|
BANNED_PACKAGES.some(
|
|
(pkg) =>
|
|
specifier === pkg ||
|
|
specifier.startsWith(pkg.endsWith("/") ? pkg : `${pkg}/`),
|
|
)
|
|
) {
|
|
context.report({
|
|
node,
|
|
messageId: "bannedPackage",
|
|
data: { specifier },
|
|
});
|
|
}
|
|
};
|
|
|
|
return {
|
|
ImportDeclaration(node) {
|
|
check(node, node.source.value);
|
|
},
|
|
ExportNamedDeclaration(node) {
|
|
if (node.source) check(node, node.source.value);
|
|
},
|
|
ExportAllDeclaration(node) {
|
|
check(node, node.source.value);
|
|
},
|
|
ImportExpression(node) {
|
|
if (node.source.type === "Literal") check(node, node.source.value);
|
|
},
|
|
};
|
|
},
|
|
});
|
|
|
|
export default rule;
|