-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbackstitch.todo
149 lines (133 loc) · 8.68 KB
/
backstitch.todo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# Backstitch TODO:
Props:
☐ required name prop required on inputs @created(20-06-07 23:36)
☐ `aria-controls=` in 76 places @created(20-06-07 23:00)
☐ clsx || refactor className out of render @created(20-06-11 16:50)
☐ Complex component demos @created(20-06-05 15:54)
☐ Does this link works on github for common Note: there's an example in [common/.config/.package.json](./common/.config/.package.json) @created(20-05-27 20:21)
Tests:
☐ Material-UI: `<StepContent />` is only designed for use with the vertical stepper. @created(20-06-08 19:15)
☐ Replace testing library @created(20-06-08 23:21)
Why? We have these broken tests, which are still outstanding issued with `react-test-renderer`
`TypeError: Cannot read property 'style' of null`
TextareaAutosize
`Error: Uncaught [TypeError: parentInstance.children.indexOf is not a function]` https://github.com/reactjs/react-modal/issues/553 @created(20-06-08 23:21)
Portal
SwipableDrawer
Modal
Cypress as test-runner:
☐ Throughout project or in cypress testing folder? @created(20-06-04 12:53) @created(20-06-09 00:21)
☐ Cucumber @created(20-06-09 00:21)
Templates:
☐ update folder to work with other paths than `src/common/` @created(20-06-09 00:26)
================================= LATER ===================================
Storybook:
Publish storybook @created(20-06-05 11:24)
Storybook link in Readme @created(20-06-05 11:24)
[Theme](medium.com/encode/setting-up-storybook-with-material-ui-and-styled-components-5bdacb6db866) @created(20-06-07 20:25)
Other library components:
Bare component without library @created(20-06-07 23:36)
Bootstrap @created(20-06-05 15:54)
Formik @created(20-06-05 15:54)
Refactor:
stories: myClass update to reduce ambiguity between props @created(20-06-08 21:20)
Stories into demos with multiple props combined (eg. Tabs)
Refactor update `Props` -> something like `<%= name %>Props` @created(20-06-08 17:42)
Refactor Typescript to its own file @created(20-06-08 18:03)
? rename `material` to `mui`
utils: myVar === undefined @created(20-06-07 21:16)
Hygen:
components @created(20-06-05 12:50)
custom folder location:
actionfolder for custom folder https://www.hygen.io/templates
```
<% if(locals.message){ -%>
message: <%= message %>
<% } -%>
```
unless_exists: true https://www.hygen.io/templates
list available props per component @created(20-06-04 23:29)
global variables eg. `variant: 'outlined'` @created(20-06-05 12:50)
use-effect, state, containers, redux elements @created(20-06-05 12:50)
More tests with either https://reactjs.org/docs/test-renderer.html or https://testing-library.com/docs/react-testing-library/example-intro @created(20-06-05 11:26)
install dependencies:
```
Here's a common task: add a dependency and then run yarn install.
---
inject: true
to: package.json
after: dependencies
skip_if: lodash
sh: cd <%= cwd %> && yarn install
---
"lodash":"*",
```
Storybook:
command prompt for file/structure https://www.hygen.io/generators @created(20-06-05 13:29)
[Storybook addons](https://storybook.js.org/addons/) @created(20-06-05 11:22)
viewport
source
docs
CRA template + typescript @created(20-05-27 19:08)
Analyse most used material-ui components and props with github graphql api
snippets in vscode, atom, sublime-text
Pages:
add containers @created(20-06-04 12:37)
index file points to container @created(20-06-05 11:22)
Docs:
images of before after button in Readme
https://sendgrid.com/blog/using-the-adapter-design-pattern-with-react/
https://reactpatterns.com/
___
Archive:
✔ material v4.10.1 tag git @created(20-06-05 12:31) @created(20-06-05 15:40) @done(20-06-09 00:17) @project(Git)
✔ Docs: I'm not a big fan of just including `{...rest}`, I'd rather be very specific with the props @created(20-06-08 15:58) @done(20-06-09 00:15) @project(Docs)
✔ Note: can't replace a line: https://github.com/jondot/hygen/issues/106 @created(20-06-08 17:59) @done(20-06-09 00:08) @project(Docs)
✔ Minimising bundle size with tree shaking: https://material-ui.com/guides/minimizing-bundle-size/ @created(20-06-08 01:30) @done(20-06-09 00:10) @project(Docs)
✔ Delete unused components @created(20-06-08 18:00) @done(20-06-09 00:10) @project(Docs)
✔ link to .package.json @created(20-06-05 15:27) @done(20-06-09 00:07) @project(Docs)
✔ Add typescript config options @created(20-06-08 23:51) @done(20-06-09 00:05) @project(Docs)
✔ Run updateImport on most or all components @created(20-06-08 18:02) @done(20-06-08 23:49) @project(interface Props)
✔ Update main template with Omit and extended props @created(20-06-08 18:48) @done(20-06-08 19:34) @project(interface Props)
✔ Checkbox: Type '{ children?: ReactNode; }' has no properties in common with type 'IntrinsicAttributes & CheckboxProps'. TS2559 @created(20-06-08 14:47) @done(20-06-08 19:34) @project(interface Props)
✔ Omit props @created(20-06-04 23:29) @done(20-06-08 19:34) @project(interface Props)
✔ git setup @created(20-03-24 13:13) @done(20-06-08 19:17) @project(Import each element)
✔ Why is it called backstitch (to do with material) @created(20-06-05 12:51) @done(20-06-05 15:39) @project(Docs)
✔ doesn't accept a Fragment as a child. Consider providing an array instead: Breadcrumbs BottomNavigation Select Menu Step ButtonGroup @created(20-06-08 19:14) @done(20-06-08 19:15) @project(Tests)
✔ No Children: Chip Tab @created(20-06-08 19:15) @done(20-06-08 19:15) @project(Tests)
✔ Required props: Tooltip, Modal open, RootRef rootRef, SwipeableDrawer onClose onOpen open @created(20-06-08 19:15) @done(20-06-08 19:15) @project(Tests)
✔ fix className @created(20-06-05 11:23) @done(20-06-05 12:29)
✔ Material-ui version v4.10.1 @done(20-06-05 15:41) @project(Docs)
✔ Howto: @project(Docs)
✔ [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) @created(20-02-25 17:01) @done(20-06-05 15:41) @project(Docs)
✔ [git subtree](https://www.atlassian.com/git/tutorials/git-subtree)☐ Why this exists from git into Readme @created(20-02-25 14:47) @done(20-06-05 15:41) @project(Docs)
✔ squash and merge/rebase @created(20-06-05 11:15) @done(20-06-05 15:39) @project(Git)
✔ AppBar camelcase naming in script @created(20-06-05 11:32) @done(20-06-05 15:39) @project(Git)
✔ Adapter pattern @created(20-05-27 20:10) @done(20-06-05 15:39) @project(Docs)
✔ Component wrappers @created(20-06-05 12:51) @done(20-06-05 15:39) @project(Docs)
✔ create new component @created(20-06-05 15:39) @done(20-06-05 15:39) @project(Docs)
✔ run shell script @created(20-06-05 15:39) @done(20-06-05 15:39) @project(Docs)
✔ Storybook test locally `npx http-server .out` @created(20-06-05 11:23) @done(20-06-05 15:39) @project(Docs)
}
✔ name prop @created(20-06-05 12:48) @done(20-06-05 15:33)
✔ exact copy of git branch @created(20-06-05 11:15) @done(20-06-08 19:17) @project(Git)
✔ Storybook build @created(20-06-05 11:23) @done(20-06-05 13:45) @project(Storybook)
✔ Storybook test locally `npx http-server .out` @created(20-06-05 11:23) @done(20-06-05 15:18) @project(Storybook)
✔ Storybook scripts bug @created(20-06-05 11:19) @done(20-06-05 13:06) @project(Storybook)
✔ wrap child component in storybook @created(20-06-05 13:06) @done(20-06-05 13:45) @project(Storybook)
✔ fix: `src/common/` @created(20-06-04 12:53) @done(20-06-04 20:10) @project(Hygen)
✔ Hygen UI component setup @created(20-02-25 17:08) @done(20-06-04 20:10) @project(Hygen)
✔ Setup Hygen for React apps @done(20-06-04 20:10) @project(Hygen)
✔ [Hygen CRA](https://github.com/jondot/hygen-CRA) @created(20-05-27 20:18) @done(20-06-04 19:45) @project(Hygen)
x Hygen CLI Custom folder (eg. Inputs/Button) @created(20-02-25 17:08) @project(Hygen)
(hygen docs)[https://www.hygen.io/quick-start]
x File structure based on https://material-ui.com/ @created(20-03-24 13:10) @project(Import each element)
✔ download material-ui @created(20-03-24 13:13) @done(20-06-04 20:13) @project(Import each element)
✔ rename to backstitch @created(20-05-27 19:08) @done(20-05-27 20:09)
✔ link to this todo @created(20-02-25 14:52) @done(20-02-25 17:00)
✔ add hygen to package.json @created(20-02-25 16:59) @done(20-02-25 16:59)
✔ hygen cra: @created(20-02-25 17:01) @done(20-02-25 17:02)
✔ Add yarn scripts to `package.json` @created(20-06-04 19:08) @done(20-06-05 11:20)
✔ Stories @created(20-06-04 19:08) @done(20-06-05 11:20)
✔ Bash script @created(10-06-08 23:55) @done(20-06-08 23:55)
x Possible solution: