@ fedify/lint: 联邦化的ESLint插件
此包自Fedify 2.0.
此软件包提供 德诺·林特 财务报告和审定财务报表 ESLint 语录 带有插件规则的插件 专为 联邦 应用。 它能帮助你找到常见的 在构建联邦服务器应用程序时错误并强制执行最佳做法 联邦.
插件包括检查 :
- 适当的演员身份配置
- 所需的演员属性( 收件箱、 发件箱、 追随者等)
- 正确的演员收藏的 URL 模式
- 公用钥匙和断言方法要求
- 收集过滤执行
Deno Lint 配置实例
// deno.json
{
"lint": {
"plugins": {
"@fedify/lint": "jsr:@fedify/lint"
},
"rules": {
"@fedify/lint/actor-id-required": "error",
"@fedify/lint/actor-id-mismatch": "error",
"@fedify/lint/actor-inbox-property-required": "warn"
// ... other rules
}
}
}
ESLint 配置示例
// eslint.config.ts
import fedifyLint from "@fedify/lint";
export default fedifyLint;
特征
这个 @fedify/lint 软件包为联邦提供了全面的折叠规则
联邦代码 :
演员验证规则
actor-id-required:确保所有行动者id属性actor-id-mismatch: 验证演员ID与预期的 URI 匹配 从Context.getActorUri()actor-public-key-required:确保行为者拥有用于 HTTP 签名actor-assertion-method-required: 验证 对象完整性证明
财产征收规则
actor-inbox-property-required: 当setInboxListeners设定actor-inbox-property-mismatch: 验证信箱 URI fromgetInboxUriactor-outbox-property-required:确保当setOutboxDispatcher设定actor-outbox-property-mismatch: 校验发件箱 URI 从getOutboxUriactor-followers-property-required: 确保在setFollowersDispatcher设定actor-followers-property-mismatch: 验证追随者的 URI fromgetFollowersUriactor-following-property-required: 当setFollowingDispatcher设定actor-following-property-mismatch: URI 从getFollowingUriactor-liked-property-required: 在setLikedDispatcher设定actor-liked-property-mismatch: 校验器喜欢来自getLikedUriactor-featured-property-required: 当setFeaturedDispatcher设定actor-featured-property-mismatch: 校验显示 URI 从getFeaturedUriactor-featured-tags-property-required: 确保显示 标记被定义 何时setFeaturedTagsDispatcher设定actor-featured-tags-property-mismatch: 显示的验证符 标记 URI 从getFeaturedTagsUriactor-shared-inbox-property-required: 确保共享信箱被定义 何时setInboxListeners设定actor-shared-inbox-property-mismatch: 验证共享的Inbox URI 来源getInboxUri
其他规则
collection-filtering-not-implemented: 关于丢失收藏的警告 过滤执行setFollowersDispatcher暂时的)
安装
* :密码组
deno add jsr:@fedify/lint
npm add -D @fedify/lint
pnpm add -D @fedify/lint
yarn add -D @fedify/lint
bun add -D @fedify/lint
* :
用法 (德诺林特)
基本设置
将插件添加到您的 德诺·杰森 配置文件 :
{
"lint": {
"plugins": ["jsr:@fedify/lint"]
}
}
默认情况下,这可以实现所有推荐的规则.
自定义配置
您可以自定义要启用哪些规则及其严重程度:
{
"lint": {
"plugins": ["jsr:@fedify/lint"],
"rules": {
"tags": ["recommended"],
"include": [
"@fedify/lint/actor-id-required",
"@fedify/lint/actor-id-mismatch"
],
"exclude": [
"@fedify/lint/actor-featured-property-required"
]
}
}
}
运行 Deno 林特
设置配置后, 运行 Deno 的 linter :
deno lint
您也可以指定要插入的文件 :
deno lint federation.ts
deno lint src/federation/
用法( ESLint)
基本设置
将插件添加到您的 ESLint 配置文件( 例如, ), 互联网档案馆的存檔,存档日期2013-12-02 或者说 互联网档案馆的存檔,存档日期2013-12-02:
import fedifyLint from "@fedify/lint";
// If your `createFederation` code is in `federation.ts` or `federation/**.ts`
export default fedifyLint;
// Or specify your own federation files
export default {
...fedifyLint,
files: ["my-own-federation.ts"],
};
// If you use other ESLint configurations
export default [
otherConfig,
fedifyLint,
];
默认配置对匹配的文件应用推荐规则 与联邦有关的共同模式(例如:, 联邦, (中文(简体) ), 联合会/*.ts) (中文(简体) ).
自定义配置
您可以自定义哪些文件可以擦出, 哪些规则可以启用 :
import { plugin } from "@fedify/lint";
export default [{
files: ["src/federation/**/*.ts"], // Your federation code location
plugins: {
"@fedify/lint": plugin,
},
rules: {
"@fedify/lint/actor-id-required": "error",
"@fedify/lint/actor-id-mismatch": "error",
"@fedify/lint/actor-inbox-property-required": "warn",
// ... other rules
},
}];
使用配置
该插件提供了两个预设配置:
建议(默认)
允许将关键规则作为错误, 可选规则作为警告 :
import fedifyLint from "@fedify/lint";
export default fedifyLint;
严格
启用所有规则为错误 :
import { plugin } from "@fedify/lint";
export default [{
files: ["**/*.ts"],
...plugin.configs.strict,
}];
示例
这里有一个代码的例子会引发错误:
// ❌ Wrong: Using relative URL for actor ID
import { createFederation, Person } from "@fedify/fedify";
const federation = createFederation({ /* ... */ });
federation.setActorDispatcher(
"/{identifier}",
(_ctx, identifier) => {
return new Person({
id: new URL(`/${identifier}`), // ❌ Should use ctx.getActorUri()
name: "Example User",
});
},
);
已更正版本 :
// ✅ Correct: Using Context.getActorUri() for actor ID
import { createFederation, Person } from "@fedify/fedify";
const federation = createFederation({ /* ... */ });
federation.setActorDispatcher(
"/{identifier}",
(ctx, identifier) => {
return new Person({
id: ctx.getActorUri(identifier), // ✅ Correct
name: "Example User",
inbox: ctx.getInboxUri(identifier),
outbox: ctx.getOutboxUri(identifier),
followers: ctx.getFollowersUri(identifier),
// ... other required properties
});
},
);
运行电线
德诺·林特
用插件运行 Deno 的插件 :
deno lint
您也可以指定要提示的文件或目录 :
deno lint federation.ts
deno lint src/federation/
ESLint 语录
如上所示设置您的 ESLint 配置, 并添加一个 follwing 脚本
package.json数字 :
{
"scripts": {
"lint": "eslint ."
}
}
设置配置后, 在您的代码库上运行 ESLint :
* :密码组
npm run lint
pnpm lint
yarn lint
bun lint
* :
或直接通过命令行运行 :
* :密码组
npx eslint .
pnpx eslint .
yarn eslint .
bunx eslint .
* :