我正在与我的团队建立一个 React 项目,该项目将使用 mobX 作为状态管理器,以及 TypeScript。
我在 React 项目中的大小写和命名模式中看到了一个常见的模式:
- 非 React 文件夹和文件:
camelCase
或kebab-case
- react(
components
文件夹内):PascalCase
react中是否有文件夹/文件命名的正式约定?如果没有,是否有此模式所基于的风格指南?或者大多数时候使用这个的原因?
我正在与我的团队建立一个 React 项目,该项目将使用 mobX 作为状态管理器,以及 TypeScript。
我在 React 项目中的大小写和命名模式中看到了一个常见的模式:
camelCase
或kebab-case
components
文件夹内):PascalCase
react中是否有文件夹/文件命名的正式约定?如果没有,是否有此模式所基于的风格指南?或者大多数时候使用这个的原因?
只是为了加上我的两分钱。正如其他人所说,文件结构是不受约束的。但是,组件命名不是。他们应该是PascalCase
为应对知道你是否正在使用function
,class
或HTMLelement
†。
例如:
class input extends Component {...}
不好!为什么?因为 React 不知道你是在尝试使用input
元素还是基于类的组件。
这就是为什么您会看到 PascalCase 组件的原因:
class Input extends Component {...}
† 有一个例外,您可以在其中使用dot notation
. 例如,如果您有多个导出并将它们全部导入为fields
,那么您可以执行以下操作:
组件/字段/index.js
import React, { Component } from 'react';
export class input extends Component {
state = { value: "" };
handleChange = ({ target: { value } }) => {
this.setState({ value });
};
render = () => (
<input type="text" value={this.state.value} onChange={this.handleChange} />
);
}
export class textarea extends Component {
state = { value: "" };
handleChange = ({ target: { value } }) => {
this.setState({ value });
};
render = () => (
<textarea
type="text"
value={this.state.value}
onChange={this.handleChange}
/>
);
}
组件/应用程序/index.js
import React, { Fragment } from 'react';
import * as fields from "../fields";
const App = () => (
<Fragment>
<fields.input />
<fields.textarea />
<Fragment>
);
export default App;
作为一般经验法则,我dot notation
完全避免。感觉很笨拙,可能会让其他不知道如何fields
构建的开发人员感到困惑。另外,我不喜欢在一个文件中堆叠多个组件,然后将它们作为一堆导入。此外,该文件可能会变得非常大且难以导航和调试(更多内容见下文)。
也就是说,为了保持结构简单,我喜欢将主目录保持小写:
├── dist // compiled application files to be served
| ├── css
| | ├── main.[contenthash:8].css
| | └── main.[contenthash:8].css.map
| ├── js
| | ├── main.[hash].js // depending on app size, this may contain multiple js files for code splitting
| | └── main.[hash].js.map
| ├── media
| | └── [hash].[ext] // static assets like fonts and images
| └── favicon.ico
| └── index.html
|
├── config // supporting "webpackdevserver" configuration files
| ├── devServer.js
| ├── envs.js
| ├── optimization.js
| ├── output.js
| ├── paths.js
| ├── plugins.js
| └── rules.js
|
├── public
| ├── favicon.ico
| └── index.html
|
├── src
| ├── actions // redux actions
| ├── components // stateful and stateless reusable components that just display "stuff" -- stateful components change and manipulate the UI
| ├── containers // stateful components that utilize the reusable "components" to CRUD data and/or are connected to redux
| ├── images
| ├── pages // utilize components/containers to display something when visiting a "/route"
| ├── reducers // redux reducers
| ├── root // aka "<App />" that combines "routes", redux and other top-level supporting files into one place
| ├── routes // assigns "pages" to a "/route"
| ├── styles // shared and/or global styles used by all "components"
| ├── types // redux types
| ├── utils // supporting app files: like test setup, custom polyfills, axios configurations, ...etc
| └── index.js // a simple file that "ReactDOM.render"s the "App"
|
├── server.js // express setup to serve the "dist" folder
└── webpack.config.js
然后在component
文件夹中,我将 PascalCase 我的组件来表示如下内容:
└── components
└── Input
├── __tests__
| └── Input.test.js // jest unit tests for "index.js"
├── index.js // all required code/styles to be exported
└── styles.scss // styles required by "index.js"
为什么是这种结构?
Input
包含在此文件夹中。因此,我可以将它交给某人,他们可以将它放入他们的应用程序中并使用它。index.js
,因此无需遍历大量嵌套文件即可轻松导入:(import Input from 'components/Input';
此外,无需指定js
要使用的确切文件,因为“index.js”包含所有必需的代码)。缺点:
index.js
命名法,因此一开始可能会有点混淆“index.js”失败的原因。我曾经做过的另一种方法是:
└── components
├── input // lowercase name to delineate it's a "pure" function -- the actual function will be a PascalCased "Input"
| ├── input.test.js // jest unit tests for "input.js"
| ├── input.js // all required code/styles to be exported
| └── styles.scss // styles required by "input.js"
|
└── Sidebar // PascalCase because it's a "class"
├── Sidebar.test.js // jest unit tests for "Sidebar.js"
├── Sidebar.js // all required code/styles to be exported
└── styles.scss // styles required by "Sidebar.js"
为什么是这种结构?
Input
包含在此文件夹中。因此,我可以将它交给某人,他们可以将它放入他们的应用程序中并使用它。function
还是class
.缺点:
import Input from 'components/input/input.js';
其他一般准则:
默认导出匿名函数的示例:
export default () => (
<p>Anonymous Function</p>
);
为什么?因为在测试时,该函数会在酶中显示为:
<_default />
当你在一个组件中有多个匿名函数时,哪个是哪个!?
<_default />
<_default />
<_default />
通常情况下,我发现大多数组件在适当优化后都会低于 100 行左右。最坏的情况是我必须创建小的子组件来补充主要组件。但!更容易阅读和调试。
什么更容易阅读:
示例 #1(34 行带有补充子组件)
示例 #2(318 行所有内容)
Example #1 模仿阅读一本书。将多个页面粘合在一起可创建易于阅读的体验。与示例 #2 相比,它读起来就像一英里长的卷轴,很容易迷路!
这可能会令人困惑,但这完全取决于您如何应用样式。如果您只是像这样导入样式:
import "./styles.css";
然后你可以使用snake-case:
<input className="snake-case" type="text" value="" onChange={this.handleChange} />
但是,如果您使用的是css modules
,则需要使用camelCase:
import { camelCaseClassName } from "./styles.css";
为什么?因为打包器(如 Webpack)不支持蛇案例导入:
<input className={camelCaseClassName} type="text" value="" onChange={this.handleChange} />
结论: 有很多方法可以通过一些提示和技巧来创建文件夹结构,以维护逻辑流程。只需选择最适合您且不会干扰在您身边工作的人!
换句话说,KISS === “保持简单,愚蠢!”
没有官方指南。大多数项目采用 PascalCase 作为 react 组件的原因是为了模仿该文件的主要导出。React 组件按照惯例是 PascalCased,当使用 jsx 时,pascal 大小写成为强制性的(实际上只有大写的首字母成为强制性的)。其余文件的 cameCase 或 kebab-case 只是遵循一般 javascript 项目更常见的偏好。
React 没有官方的风格指南。但是你可以使用eslint
AirBnb最流行的 React 配置。
在这里阅读更多https://github.com/airbnb/javascript/tree/master/react
在许多语言中,PascalCase 它们的类很常见,并且具有驼峰式函数和变量名。一个JS例子,
function hello() {console.log('world')};
class Foo {
say() { console.log('bar') }
}
let foo = new Foo();
foo.say();
组件通常是类class Nav extends React.PureComponent
,因此逻辑连接是类似地命名包含类的文件,从而导致匹配的 case 导入语句import Nav from './Nav
您可能还有一个实用程序文件,它导出一个函数,而不是一个类。同样,有匹配的案例很好import hello from './hello'
因此,您可能会发现一个常见的结构,例如
src
- App.js
- components/
- Nav.js
- util/
- hello.js
目前我有一个以 PascalCase 命名的文件夹,其中有一个index.js
文件 - 这是我的组件。
任何直接附加到根组件的组件我都嵌套在他们自己的文件夹中,并使用他们自己的 index.js。我还使用点符号来描述与该文件夹直接相关的任何文件的性质,例如[descriptor].[name].[prefix]
Components/
ComponentName/
|---util.componentName.js
|---constants.componentName.js
|---styles.componentName.scss
|---index.js
ChildComponent1/
|---util.childComponent1.js
|---styles.childComponent1.scss
|---index.js
ChildComponent2/
|---util.childComponent2.js
|---styles.childComponent2.scss
|---index.js
对于我的 mobx 商店,因为我的商店module不太可能拥有真正深层的文件夹结构,所以我有一个根module文件夹,其中通常包含两个js
文件Actions.js
,index.js
索引是我的主要商店类,它扩展了我的 Actions 类。(我发现一个带有observable
,computed
和action
属性的mobx 类有点混乱)。
Store 文件夹本身有一个index.js
导入所有同级存储module,以便稍后将它们组合成一个存储对象(我的项目需要)
Store/
StoreModule/
|---actions.js
|---index.js
AnotherStoreModule/
|---actions.js
|---index.js
index.js
我想没有真正正确的方法,因为它取决于偏好,上面的方法我认为可读,并且在 VSCode 上使用工具查找文件时,它可以更轻松地搜索诸如“我想查看作为常量文件的所有文件”之类的细节"搜索constants.[component name]