README

内容存储库工具

作者和赞助商

• Wilhelm Behncke - behncke@sitegeist.de

此软件包的开发和公共发布得到了我们的雇主 http://www.sitegeist.de 的慷慨赞助。

安装

Sitegeist.Janitor 可通过 Packagist 获取

composer require --dev sitegeist/janitor

用法

Sitegeist.Janitor 包含一些工具，帮助您检查内容存储库并发现优化潜力。此外，它还在 neos ui 中为每个 nodeType 和属性添加了自动帮助信息，以便快速获取确切名称和类型。

report:unused

找出在您的 Neos 实例内部未使用的 NodeTypes。

./flow report:unused

选项

• --threshold (可选，默认：0) - 您可以使用此参数检测到不仅仅是未使用的 NodeTypes，而是基本所有出现次数少于此阈值的 NodeTypes
• --super-type (可选，默认: 'Neos.Neos:Node') - 使用此参数，您可以限制考虑的 NodeTypes 集合为继承特定 SuperType 的那些
• --workspaces (可选，默认: 'live') - 您也可以限制考虑的工作区集合
• --dimensions (可选，默认: null) - 指定 dimensionvalues 以 json 格式限制分析，例如 --dimensions '{"language":["de"]}'

report:occurences

获取特定节点类型的所有出现列表。

./flow report:occurences MyAwesome.Package:MyAwesomeNodeType

选项

• --node-type (必需) - 想要找到出现次数的节点
• --workspaces (可选，默认: '_all') - 限制考虑的工作区集合
• --limit (可选，默认: 5) - 使用此参数，您可以限制报告中列出出现次数的数量
• --start-at (可选，默认: 1) - 指定报告开始的位置

report:nodetypes

获取所有节点类型的概览。

./flow report:nodetypes

选项

• --super-type (可选，默认: 'Neos.Neos:Node') - 使用此参数，您可以限制考虑的 NodeTypes 集合为继承特定 SuperType 的那些
• --filter (可选，默认: '') - 使用 shell glob 模式过滤结果，留空以不进行过滤
• --abstract (可选，默认: false) - 考虑抽象节点类型
• --oneline (可选，默认: false) - 创建压缩报告

report:whereallowed

找出允许特定节点类型的地方。此命令将列出节点类型和自动创建的子节点，并突出显示允许给定节点类型的那些。

./flow report:whereallowed Neos.Neos:Content

选项

• --node-type (必需) - 要分析的节点类型
• --filter (可选，默认: '') - 使用 shell glob 模式过滤结果，留空以不进行过滤

report:uris

获取给定节点类型的所有 URI 列表。

./flow report:uris

选项

• --node-type (可选，默认: 'Neos.Neos:Document') - 要分析的节点类型
• --filter (可选，默认: '') - 使用 shell glob 模式过滤结果，留空以不进行过滤
• --workspace (可选，默认: 'live') - 限制结果到特定工作区
• --verbose (可选，默认: false) - 增加详细程度
• --limit (可选，默认: 0) - 限制结果数量 (0 = 无限制)

贡献

我们乐意接受贡献。请发送 pull requests。

在没有正式样式指南的情况下，请注意保持现有的编码风格。请确保贡献符合 PSR-2 的源代码。

许可

见 LICENSE.md