eslint plugin project structure

Eslint-Plugin-Project-Tructure

功能强大的ESLINT插件具有规则，可帮助您实现一个可扩展，一致且结构良好的项目。

创建自己的框架！定义您的文件夹结构，文件组成，高级命名约定，并创建独立的模块。

将您的项目提升到一个新的水平，并通过自动审查健康项目的关键原则来节省时间！

？一般信息

？ ESLINT-PLUGIN-PROKOXTRUCTURE规则的操场。

检查最新版本，并使用新功能和更改保持更新。

成为社区的一部分！
留下A并与您的朋友分享链接。

• 如果您有任何疑问或需要帮助创建满足您需求的配置，请帮助。
• 如果您在文档中找到了错误或错误，请报告问题。
• 如果您有新功能的想法或对现有功能的改进，想法。
• 如果您有兴趣讨论不同框架的项目结构，或者想对拟议的想法进行投票，请讨论。

文档

• 项目结构/文件夹结构
• 项目结构/独立模块
• 项目结构/文件组件

项目结构/文件夹结构

执行有关文件夹结构的规则，以使您的项目保持一致，有序和经过深思熟虑。

特征：

• 文件夹结构的验证。结构外的任何文件/文件夹都将被视为错误。
• 文件/文件夹名称REGEX验证具有通配符*和治疗等功能.作为角色，以及其他便利。
• 构建以防万一。
• 继承文件夹的名称。文件/文件夹继承其所在文件夹的名称。添加您自己的前缀/后缀或更改情况的选项。
• 当存在特定文件/文件夹时，强制执行文件/文件夹。例如./src/Component.tsx ./src/Component.test.tsx ./src/stories/Component.stories.tsx 。
• 文件夹结构可重复使用的规则。
• 使用打字稿支持创建单独的配置文件的选项。
• 强迫给定文件夹的嵌套/平坦结构。
• 支持所有文件扩展名。
• 文件夹递归。您可以反复嵌套文件夹结构并设置嵌套深度的限制。还有一个选择在最终级别上更改规则，例如使文件夹结构变平。
• 通过将文件夹结构表示为树，更少的重复和精确错误消息，甚至对于深层嵌套的文件夹（递归）。
• 检查路径的长度并通知何时超过限制。

项目结构/独立模型

健康项目的一个关键原则是防止创建巨大的依赖树，其中删除或编辑一个功能会触发影响整个项目的链反应。

创建模块控制可以导入的内容。消除文件夹或文件之间不必要的依赖性，以构建真正的独立功能。

特征：

• 创建您控制可以导入的内容的模块（例如类型，功能，一个功能的组件，不能导入到另一个功能中）。
• 即使对于嵌套文件夹结构，也可以创建非常详细的规则。无论是大型模块，子模块还是一个文件，都没有限制。
• 支持所有类型的导入，包括require() ， import() ， jest.mock()和jest.requireActual() ，以及ExportAllDeclaration和ExportNamedDeclaration 。
• 禁用给定模块的外部导入（NODE_MODULES）（添加异常的选项）。
• 非相关/相对进口支持。
• 内置的导入架架，因此您无需安装任何其他插件。它还包括最受欢迎的文件扩展名的内置配置，因此您不必手动配置任何内容。
• 可重复使用的导入模式。
• 支持路径别名。该插件将自动检测您的tsconfig.json并使用您的设置。还有一个可以手动输入它们的选项。
• 使用打字稿支持创建单独的配置文件的选项。

项目结构/文件组件

撰写您的理想文件！

完全控制选择器的顺序和数量。

定义高级命名约定，并禁止在给定文件中使用特定选择器。

特征：

• 文件组成验证。
• 支持的选择器： class ， function ， arrowFunction功能， type ， interface ， enum ， variable ， variableExpression ， propertyDefinition 。
• 将文件名继承为选择器名称。选项添加您自己的前缀/后缀，更改案例或删除文件名的部分。
• 禁止在给定文件中使用给定的选择器。例如， **/*.consts.ts文件只能包含变量， **/*.types.ts文件只能包含接口和类型。
• 定义选择器应在给定文件中出现的顺序。支持--fix自动纠正订单。
• 导出的选择器的规则，文件根和文件中的所有选择器中的选择器。它们可以组合使用。
• 每个文件最多执行一个主组件/函数/类。
• 在给定文件的根中设置某些选择器的特定限制的能力。
• 选择器名称REGEX验证。
• 构建以防万一。
• 不同文件的不同规则。
• 使用打字稿支持创建单独的配置文件的选项。

赞助商

非常感谢所有赞助商的支持！您给我继续前进的力量和动力！

感谢您，我可以帮助其他人创建他们的理想项目！