Skip to content

Commit d06f0d8

Browse files
authored
Merge pull request #59 from mapado/add-style-makeup-variables
Add rule about using makeup variables
2 parents c7ee387 + c9eddaa commit d06f0d8

File tree

3 files changed

+60
-13
lines changed

3 files changed

+60
-13
lines changed

.prettierrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"singleQuote": true
3+
}

docs/js/style.mdx

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Guide de style
33
---
44

5-
import Tabs from "@theme/Tabs";
6-
import TabItem from "@theme/TabItem";
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
77

88
## Comment est-ce qu'on écrit une fonction (arrow function vs function declaration)
99

@@ -116,8 +116,8 @@ setTimeout(doSomething, TIMEOUT_DELAY);
116116
```
117117

118118
```jsx
119-
const EVENT_DATE_BY_LIST = "list";
120-
const EVENT_DATE_BY_DATE = "date";
119+
const EVENT_DATE_BY_LIST = 'list';
120+
const EVENT_DATE_BY_DATE = 'date';
121121
// ...
122122
const [selectedTab, setSelectedTab] = useState(EVENT_DATE_BY_LIST);
123123
```
@@ -126,9 +126,9 @@ Dans le cas où plusieurs constantes sont utilisées à plusieurs endroits, on p
126126

127127
```tsx
128128
export enum MODULE_TYPE {
129-
INFORMATION = "information",
130-
RECOMMENDATION = "recommendation",
131-
PROMOTE = "promote",
129+
INFORMATION = 'information',
130+
RECOMMENDATION = 'recommendation',
131+
PROMOTE = 'promote',
132132
}
133133

134134
function generateModule(moduleType: MODULE_TYPE) {
@@ -156,10 +156,10 @@ Afin de gagner en lisibilité dans la lecture du code, on DOIT ajouter une ligne
156156
function Foo() {
157157
const { t } = useTranslation();
158158
const [loading, setLoading] = useState(true);
159-
let name = "JD";
159+
let name = 'JD';
160160

161161
if (!loading) {
162-
name = "Chris";
162+
name = 'Chris';
163163
}
164164

165165
useEffect(() => {
@@ -172,7 +172,7 @@ function Foo() {
172172
return <MpdLoader />;
173173
}
174174

175-
return <div>{t("hello", { name })}</div>;
175+
return <div>{t('hello', { name })}</div>;
176176
}
177177
```
178178

@@ -212,7 +212,7 @@ Cette syntaxe est difficilement compréhensible car on ne comprends pas directem
212212

213213
## Extension de fichier dans les imports
214214

215-
On **NE DEVRAIT PAS** avoir le nom de l'extension dans les imports
215+
On **NE DEVRAIT PAS** avoir le nom de l'extension dans les imports
216216

217217
<Tabs
218218
defaultValue="good"
@@ -222,14 +222,57 @@ On **NE DEVRAIT PAS** avoir le nom de l'extension dans les imports
222222
]}
223223
>
224224
<TabItem value="bad">
225+
225226
```tsx
226227
import Component from './components.jsx';
227228
```
229+
228230
</TabItem>
229-
<TabItem value="good">
231+
<TabItem value="good">
232+
230233
```tsx
231234
import Component from './components';
232235
```
233236

234237
</TabItem>
235238
</Tabs>
239+
240+
## Variables makeup
241+
242+
On **DEVRAIT** privilégier les [variables makeup](https://makeup.mapado.net/?path=/docs/overview-variables--docs) lorsqu'on style un composant React.
243+
244+
<Tabs
245+
defaultValue="good"
246+
values={[
247+
{ label: 'Pas bien 👎', value: 'bad', },
248+
{ label: 'Bien 👍', value: 'good', },
249+
]}
250+
>
251+
<TabItem value="bad">
252+
253+
```tsx
254+
const styled = 'styled-components';
255+
256+
// ...
257+
258+
const Container = styled.div`
259+
margin: 5px 0;
260+
`;
261+
```
262+
263+
</TabItem>
264+
<TabItem value="good">
265+
266+
```tsx
267+
const styled = 'styled-components';
268+
import { $marginSmall } from '@mapado/makeup/build/variables';
269+
270+
// ...
271+
272+
const Container = styled.div`
273+
margin: ${$marginSmall} 0;
274+
`;
275+
```
276+
277+
</TabItem>
278+
</Tabs>

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@
2626
"last 1 firefox version",
2727
"last 1 safari version"
2828
]
29-
}
29+
},
30+
"packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
3031
}

0 commit comments

Comments
 (0)