Compare commits
243 Commits
blitz@2.0.
...
v0.6.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ca5d6ee0aa | ||
|
|
f17820f81d | ||
|
|
ab6f60571a | ||
|
|
5f3d5dd7a3 | ||
|
|
8b8143d2c2 | ||
|
|
8b6a51f8f1 | ||
|
|
0c23a7873c | ||
|
|
0fa28d20c4 | ||
|
|
97132996b8 | ||
|
|
96ac63d3a4 | ||
|
|
132601f0c2 | ||
|
|
c47d15a09f | ||
|
|
0892137370 | ||
|
|
797060c068 | ||
|
|
1c7134c272 | ||
|
|
2638ec73b3 | ||
|
|
3c4db0453e | ||
|
|
d824459190 | ||
|
|
5da2eae6e1 | ||
|
|
73f6be0814 | ||
|
|
2dfa86556d | ||
|
|
7097150c2d | ||
|
|
84a8ac7512 | ||
|
|
ef48721625 | ||
|
|
a54b48190c | ||
|
|
ff5cab07fc | ||
|
|
02ccc7db0e | ||
|
|
9de79ba621 | ||
|
|
dfac941a80 | ||
|
|
f3f17a2452 | ||
|
|
aa6d0e0dc0 | ||
|
|
4b0b1b8c66 | ||
|
|
7e72dd3ccd | ||
|
|
0aa16e25ae | ||
|
|
9e5d58ddbd | ||
|
|
edd673f54c | ||
|
|
6cccbe3487 | ||
|
|
92069cfef8 | ||
|
|
b16424592f | ||
|
|
92c4a4bfc8 | ||
|
|
ffd87a80af | ||
|
|
9c54cfaef1 | ||
|
|
fd2e9d2988 | ||
|
|
3cc4476a98 | ||
|
|
1a45b2d394 | ||
|
|
bac7f21295 | ||
|
|
9755466f9b | ||
|
|
3a85e83b56 | ||
|
|
4e49239f53 | ||
|
|
f0a56ff2fe | ||
|
|
2a71e3441d | ||
|
|
63cacbb73c | ||
|
|
219d12aaa2 | ||
|
|
b1321c77e1 | ||
|
|
f7685b4abb | ||
|
|
cf215b4a12 | ||
|
|
32f0a76b18 | ||
|
|
e9e8841f07 | ||
|
|
d6b29a2f71 | ||
|
|
af338d99e4 | ||
|
|
bd63e4cab0 | ||
|
|
e387936cb0 | ||
|
|
0650252c53 | ||
|
|
76cfb8c076 | ||
|
|
6273ffd255 | ||
|
|
6e447f1f44 | ||
|
|
4c4721250a | ||
|
|
6852cfc208 | ||
|
|
da488ccf33 | ||
|
|
36d0ae8587 | ||
|
|
8bcaf62641 | ||
|
|
820d191a63 | ||
|
|
45842d48ad | ||
|
|
67ed16429d | ||
|
|
45cb96f9f1 | ||
|
|
9063758292 | ||
|
|
2a892ba4d0 | ||
|
|
73b3920a53 | ||
|
|
fae90065df | ||
|
|
fc762c15fc | ||
|
|
cc10b71f9d | ||
|
|
998d227832 | ||
|
|
35c150a46a | ||
|
|
920716a0d8 | ||
|
|
39675d1da8 | ||
|
|
dd20c0ac6c | ||
|
|
2ea1e7b522 | ||
|
|
44c3ea22e2 | ||
|
|
f4760776ee | ||
|
|
65bb7e8e84 | ||
|
|
8547585cc7 | ||
|
|
16b810e0c3 | ||
|
|
8d38c6c225 | ||
|
|
c00e78cbc7 | ||
|
|
11325ba136 | ||
|
|
477094d042 | ||
|
|
2c91340539 | ||
|
|
4c42176ec9 | ||
|
|
6564a268f6 | ||
|
|
9c66a2938e | ||
|
|
27e314821d | ||
|
|
bf4b90943b | ||
|
|
3b5f7bc6c8 | ||
|
|
0659b37d77 | ||
|
|
67950db948 | ||
|
|
45a09911a4 | ||
|
|
e89127358f | ||
|
|
cf94dc866d | ||
|
|
bd3841b43b | ||
|
|
50dd2dcc4e | ||
|
|
6443184f0f | ||
|
|
9f8a7afd17 | ||
|
|
5d3afb0230 | ||
|
|
9dfc5c53ed | ||
|
|
ba540bb546 | ||
|
|
b70296a7a2 | ||
|
|
36c0acdb92 | ||
|
|
549115af97 | ||
|
|
a4d6fe139e | ||
|
|
9010566895 | ||
|
|
167fc251fd | ||
|
|
4bcc2efbec | ||
|
|
4c1eed6248 | ||
|
|
36b4f101f9 | ||
|
|
9209c934ee | ||
|
|
ecd1118ce5 | ||
|
|
29820ac964 | ||
|
|
93dcd6d884 | ||
|
|
6f66e5bd72 | ||
|
|
df76a4b2ab | ||
|
|
b9391305b0 | ||
|
|
9e1ce7dda0 | ||
|
|
d956da624f | ||
|
|
4b29564f12 | ||
|
|
227c1204c2 | ||
|
|
1ca88afcef | ||
|
|
bb4272bbe6 | ||
|
|
b749884ddc | ||
|
|
0b18df1390 | ||
|
|
256387cbbd | ||
|
|
f80071913d | ||
|
|
c05afe8bf6 | ||
|
|
95713e627b | ||
|
|
4184a4fe5d | ||
|
|
5933b6189e | ||
|
|
2d545688cb | ||
|
|
c3dee2271e | ||
|
|
93865f4431 | ||
|
|
be1c57b345 | ||
|
|
5d22f9b2cc | ||
|
|
1ea4398216 | ||
|
|
bb93ed8843 | ||
|
|
e2eed221e0 | ||
|
|
6719104cb3 | ||
|
|
d103345b77 | ||
|
|
ae99dc4a55 | ||
|
|
4658f616f1 | ||
|
|
48861cbf25 | ||
|
|
c82de5cfd0 | ||
|
|
64185b884d | ||
|
|
9bdc4350f9 | ||
|
|
81735c4dec | ||
|
|
53eab985fd | ||
|
|
e16d66a4c5 | ||
|
|
bc3aa30929 | ||
|
|
9d8edb6ead | ||
|
|
25ff55291a | ||
|
|
2a9ac48a72 | ||
|
|
925098534f | ||
|
|
277c704be8 | ||
|
|
046b2ed300 | ||
|
|
ef579daf1c | ||
|
|
e44785bcff | ||
|
|
72697f25f9 | ||
|
|
fa6067eee7 | ||
|
|
6879be005e | ||
|
|
52e93a608b | ||
|
|
bce5a4bd37 | ||
|
|
1dad620368 | ||
|
|
f09b968e27 | ||
|
|
7f81d6291d | ||
|
|
f48a776e99 | ||
|
|
3e63287fa2 | ||
|
|
828c8d2f23 | ||
|
|
d8c2f696b1 | ||
|
|
4f21628365 | ||
|
|
0521b595fe | ||
|
|
f0159a05ae | ||
|
|
4a1e7e361f | ||
|
|
b1f620a579 | ||
|
|
dfbcb5bf67 | ||
|
|
0677a16e75 | ||
|
|
968b507570 | ||
|
|
e773b26f5f | ||
|
|
54e4759791 | ||
|
|
df0e5d3539 | ||
|
|
32944666f4 | ||
|
|
b5e0d7afed | ||
|
|
4bb86dc8b8 | ||
|
|
93a5fb057e | ||
|
|
3c044fd4d0 | ||
|
|
b430c87b65 | ||
|
|
903644b628 | ||
|
|
d26be24cb3 | ||
|
|
949e7eb83f | ||
|
|
97bb455cc4 | ||
|
|
cdb5ff2133 | ||
|
|
b1aee93e2d | ||
|
|
667566e341 | ||
|
|
c51443bf5d | ||
|
|
ab4a3d2748 | ||
|
|
6d6a689557 | ||
|
|
16c2031d2a | ||
|
|
590b20f12e | ||
|
|
c82c0b3689 | ||
|
|
18d38d79e7 | ||
|
|
4113124ec4 | ||
|
|
8f6d0e03ac | ||
|
|
c48fd8925b | ||
|
|
66af983955 | ||
|
|
55b735086c | ||
|
|
4e64784749 | ||
|
|
3ee2ef0b42 | ||
|
|
eaa6fc8802 | ||
|
|
ef6bf61c5b | ||
|
|
5f5b589a7f | ||
|
|
82ae27841c | ||
|
|
8623d5a817 | ||
|
|
250c49c7bd | ||
|
|
7739c3e951 | ||
|
|
8a7f7931f4 | ||
|
|
6579e85a96 | ||
|
|
1195f5225e | ||
|
|
9b206a9831 | ||
|
|
dae1db73e9 | ||
|
|
d63f59d2fa | ||
|
|
bbf9cb0d2b | ||
|
|
a44b1d93c1 | ||
|
|
3dab930a75 | ||
|
|
939fad20f6 | ||
|
|
2e06ef8637 | ||
|
|
12ab14bc57 | ||
|
|
45000493e0 |
275
.all-contributorsrc
Normal file
275
.all-contributorsrc
Normal file
@@ -0,0 +1,275 @@
|
||||
{
|
||||
"projectName": "blitz",
|
||||
"projectOwner": "blitz-js",
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"files": [
|
||||
"README.md"
|
||||
],
|
||||
"badgeTemplate": "<a aria-label=\"All Contributors\" href=\"#contributors-\"><img alt=\"\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>-17BB8A.svg?style=for-the-badge&labelColor=000000\"></a>",
|
||||
"imageSize": 100,
|
||||
"commit": true,
|
||||
"commitConvention": "none",
|
||||
"contributors": [
|
||||
{
|
||||
"login": "flybayer",
|
||||
"name": "Brandon Bayer",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/8813276?v=4",
|
||||
"profile": "https://twitter.com/flybayer",
|
||||
"contributions": [
|
||||
"code",
|
||||
"content",
|
||||
"ideas",
|
||||
"review"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "medelman17",
|
||||
"name": "Michael Edelman ",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/14793389?v=4",
|
||||
"profile": "https://fabulas.io",
|
||||
"contributions": [
|
||||
"infra",
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "merelinguist",
|
||||
"name": "Dylan Brookes",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/24858006?v=4",
|
||||
"profile": "https://merelinguist.now.sh",
|
||||
"contributions": [
|
||||
"ideas",
|
||||
"review",
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "ryardley",
|
||||
"name": "Rudi Yardley",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/1256409?v=4",
|
||||
"profile": "https://medium.com/@ryardley",
|
||||
"contributions": [
|
||||
"code",
|
||||
"ideas"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "toddgeist",
|
||||
"name": "Todd Geist",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/316792?v=4",
|
||||
"profile": "http://www.geistinteractive.com",
|
||||
"contributions": [
|
||||
"financial"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "quirk0o",
|
||||
"name": "Beata Obrok",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/5123725?v=4",
|
||||
"profile": "https://github.com/quirk0o",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "tsawan",
|
||||
"name": "Tahir Awan",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/3263082?v=4",
|
||||
"profile": "https://github.com/tsawan",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "camilo86",
|
||||
"name": "Camilo Gonzalez",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/2454632?v=4",
|
||||
"profile": "https://raluce.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "dkempner",
|
||||
"name": "Daniel Kempner",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/2532112?v=4",
|
||||
"profile": "http://da.nielkempner.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "gielcobben",
|
||||
"name": "Giel",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/2663212?v=4",
|
||||
"profile": "http://gielcobben.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "MrLeebo",
|
||||
"name": "Jeremy Liberman",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/2754163?v=4",
|
||||
"profile": "http://jeremyliberman.com/",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "jimthedev",
|
||||
"name": "Jim Cummins",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/108938?v=4",
|
||||
"profile": "https://jimthedev.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Kristina Matuška",
|
||||
"avatar_url": "https://media-exp1.licdn.com/dms/image/C5603AQHVPAjV21gw9g/profile-displayphoto-shrink_200_200/0?e=1591228800&v=beta&t=0MlbmiYhNvGv1xjLD_fOhOFjVDZ7ltNwfGNeJ4DHedQ",
|
||||
"profile": "http://kristinamatuska.com/",
|
||||
"contributions": [
|
||||
"design"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "robdrosenberg",
|
||||
"name": "Robert Rosenberg",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/20813991?v=4",
|
||||
"profile": "http://robdrosenberg.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "jasonblalock",
|
||||
"name": "Jason Blalock",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/5899929?v=4",
|
||||
"profile": "https://github.com/jasonblalock",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "coreybrown89",
|
||||
"name": "Corey Brown",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/12791148?v=4",
|
||||
"profile": "https://corey-brown.com",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "aej11a",
|
||||
"name": "aej11a",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/10066422?v=4",
|
||||
"profile": "https://github.com/aej11a",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "marcoseoane",
|
||||
"name": "marcoseoane",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/28088807?v=4",
|
||||
"profile": "https://github.com/marcoseoane",
|
||||
"contributions": [
|
||||
"ideas"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "rishabhpoddar",
|
||||
"name": "Rishabh Poddar",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/2976287?v=4",
|
||||
"profile": "https://github.com/rishabhpoddar",
|
||||
"contributions": [
|
||||
"ideas"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "aem",
|
||||
"name": "Adam Markon",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/1909883?v=4",
|
||||
"profile": "https://github.com/aem",
|
||||
"contributions": [
|
||||
"ideas"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "lorenzorapetti",
|
||||
"name": "Lorenzo Rapetti",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/2632174?v=4",
|
||||
"profile": "https://github.com/lorenzorapetti",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "wKovacs64",
|
||||
"name": "Justin Hall",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/1288694?v=4",
|
||||
"profile": "https://github.com/wKovacs64",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "sijad",
|
||||
"name": "Sajjad Hashemian",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/7693001?v=4",
|
||||
"profile": "https://github.com/sijad",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "ETLopes",
|
||||
"name": "Eduardo Lopes",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/34959471?v=4",
|
||||
"profile": "https://github.com/ETLopes",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "mattleff",
|
||||
"name": "Matthew Leffler",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/120155?v=4",
|
||||
"profile": "https://github.com/mattleff",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "hew",
|
||||
"name": "Matt",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/3103241?v=4",
|
||||
"profile": "https://hew.tools",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "sonnypgs",
|
||||
"name": "Sonny",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/1431300?v=4",
|
||||
"profile": "https://github.com/sonnypgs",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "Zeko369",
|
||||
"name": "Fran Zekan",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/3064377?v=4",
|
||||
"profile": "https://github.com/Zeko369",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
}
|
||||
],
|
||||
"contributorsPerLine": 7,
|
||||
"skipCi": true
|
||||
}
|
||||
5
.github/CODEOWNERS
vendored
Normal file
5
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
|
||||
|
||||
* @flybayer
|
||||
|
||||
packages/server/* @ryardley
|
||||
4
.github/FUNDING.yml
vendored
Normal file
4
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
github: blitz-js
|
||||
custom: ['https://paypal.me/thebayers']
|
||||
open_collective: blitzjs
|
||||
patreon: flybayer
|
||||
22
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Something is not working right. Or error messages are unclear.
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**What is the problem?**
|
||||
|
||||
**Steps to Reproduce:**
|
||||
|
||||
1. 2.
|
||||
|
||||
**Versions:**
|
||||
|
||||
```
|
||||
[Add the output of `blitz -v` here]
|
||||
```
|
||||
|
||||
**Supporting Documentation**
|
||||
Please include applicable logs and screenshots that show your problem.
|
||||
16
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
16
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
name: Feature/change request
|
||||
about: Something new or better!
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**What do you want and why do you want it?.**
|
||||
The more information the better!
|
||||
|
||||
**Possible implementation(s)**
|
||||
How might we do this?
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
35
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
35
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
### Pull Request Type
|
||||
|
||||
<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
|
||||
|
||||
- [ ] Feature
|
||||
- [ ] Bug fix
|
||||
- [ ] Refactoring (no functional changes, no api changes)
|
||||
- [ ] Build related changes
|
||||
- [ ] Tests related changes
|
||||
- [ ] Other (please describe): Dependency updates
|
||||
|
||||
### Checklist
|
||||
|
||||
<!-- Please ensure your PR fulfills the following: -->
|
||||
|
||||
- [ ] Tests added for changes (or N/A)
|
||||
- [ ] Any added terminal logging uses `packages/server/src/log.ts` (or N/A)
|
||||
- [ ] Code Coverage stayed the same or increased
|
||||
|
||||
### What's the reason for the change? :question:
|
||||
|
||||
<!-- Closes: ISSUE_NUMBER -->
|
||||
|
||||
### What are the changes and their implications? :gear:
|
||||
|
||||
### Does this introduce a breaking change? :warning:
|
||||
|
||||
- [ ] Yes
|
||||
- [ ] No
|
||||
|
||||
<!-- If yes, describe the impact and migration path for existing apps-->
|
||||
|
||||
### Other information
|
||||
|
||||
<!-- Before/after screenshots, etc. -->
|
||||
41
.github/workflows/main.yml
vendored
Normal file
41
.github/workflows/main.yml
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
name: Continuous Integration
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- canary
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- canary
|
||||
|
||||
jobs:
|
||||
build_and_test:
|
||||
name: Build & Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12.16.1'
|
||||
- name: Get yarn cache directory path
|
||||
id: yarn-cache-dir-path
|
||||
run: echo "::set-output name=dir::$(yarn cache dir)"
|
||||
- name: Cache Node.js modules
|
||||
id: yarn-cache
|
||||
uses: actions/cache@v1
|
||||
with:
|
||||
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
||||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-yarn-
|
||||
- name: Install dependencies
|
||||
run: yarn install --frozen-lockfile --silent
|
||||
env:
|
||||
CI: true
|
||||
- name: Test Blitz Packages
|
||||
run: yarn test
|
||||
env:
|
||||
CI: true
|
||||
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
.log
|
||||
.DS_Store
|
||||
.jest-*
|
||||
lib
|
||||
node_modules
|
||||
reports
|
||||
*.log
|
||||
.nyc_output
|
||||
**/coverage
|
||||
.yarn
|
||||
.yarnrc
|
||||
tsconfig.tsbuildinfo
|
||||
.blitz
|
||||
.next
|
||||
dist
|
||||
.now
|
||||
# local env files
|
||||
**/.envrc
|
||||
**/.env
|
||||
**/.env.local
|
||||
**/.env.development.local
|
||||
**/.env.test.local
|
||||
**/.env.production.local
|
||||
.blitz-*
|
||||
16
.npmignore
Normal file
16
.npmignore
Normal file
@@ -0,0 +1,16 @@
|
||||
.DS_Store
|
||||
.prettierrc
|
||||
.nyc_output
|
||||
.travis.yml
|
||||
coverage
|
||||
coverage.lcov
|
||||
bench
|
||||
docs
|
||||
src
|
||||
examples
|
||||
babel.config.js
|
||||
test
|
||||
CONTRIBUTING.md
|
||||
CODE_OF_CONDUCT.md
|
||||
*.ts
|
||||
!*.d.ts
|
||||
19
.prettierignore
Normal file
19
.prettierignore
Normal file
@@ -0,0 +1,19 @@
|
||||
**/migrations/**
|
||||
.blitz
|
||||
.next
|
||||
.log
|
||||
.DS_Store
|
||||
.jest-*
|
||||
lib
|
||||
node_modules
|
||||
reports
|
||||
*.log
|
||||
**/.env*
|
||||
.nyc_output
|
||||
**/coverage
|
||||
.yarn
|
||||
.yarnrc
|
||||
tsconfig.tsbuildinfo
|
||||
dist
|
||||
bin
|
||||
packages/cli/templates/**
|
||||
60
CODE_OF_CONDUCT.md
Normal file
60
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# The Blitz Community Code of Conduct
|
||||
|
||||
The Blitz core members take this CoC very serious. All members, contributors and volunteers in this community are required to act according to the following Code of Conduct to keep Blitz a positive, growing project and community and help us provide and ensure a safe environment for everyone.
|
||||
|
||||
The Blitz community
|
||||
|
||||
## When Something Happens
|
||||
|
||||
If you see a Code of Conduct violation, follow these steps:
|
||||
|
||||
1. Let the person know that what they did is not appropriate and ask them to stop and/or edit their message(s).
|
||||
2. That person should immediately stop the behavior and correct the issue.
|
||||
3. If this doesn’t happen, or if you’re uncomfortable speaking up, contact Brandon Bayer ([Twitter](https://twitter.com/flybayer) | [Email](mailto:b@bayer.ws)).
|
||||
|
||||
When reporting, please include any relevant details, links, screenshots, context, or other information that may be used to better understand and resolve the situation.
|
||||
|
||||
The core members will prioritize the well-being and comfort of the recipients of the violation over the comfort of the violator.
|
||||
|
||||
## What We Believe and How We Act
|
||||
|
||||
- We are committed to providing a friendly, safe and welcoming environment for everyone, regardless of age, body size, culture, ethnicity, gender expression, gender identity, level of experience, nationality, personal ability or disability, physical appearance, physical or mental difference, race, religion, set of skills, sexual orientation, socio-economic status, and subculture. We welcome people regardless of these or other attributes.
|
||||
- We are better together. We are more alike than different.
|
||||
- Our community is based on mutual respect, tolerance, and encouragement.
|
||||
- We believe that a diverse community where people treat each other with respect is stronger, more vibrant and has more potential contributors and more sources for ideas. We aim for more diversity.
|
||||
- We are kind, welcoming and courteous to everyone.
|
||||
- We’re respectful of others, their positions, their skills, their commitments and their efforts.
|
||||
- We’re attentive in our communications, whether in person or online, and we’re tactful when approaching differing views.
|
||||
- We are aware that language shapes reality. Thus, we use inclusive, gender-neutral language in the documents we provide and when we talk to people. When referring to a group of people, we aim to use gender-neutral terms like “team”, “folks”, “everyone”. (For details, we recommend [this post](https://modelviewculture.com/pieces/gendered-language-feature-or-bug-in-software-documentation)).
|
||||
- We respect that people have differences of opinion and criticize constructively.
|
||||
- We value people over code.
|
||||
|
||||
## Don'ts
|
||||
|
||||
- Don’t discriminate against anyone.
|
||||
- Sexism and racism of any kind (including sexist and racist “jokes”), demeaning or insulting behaviour and harassment are seen as direct violations to this Code of Conduct. Harassment includes offensive verbal comments related to age, body size, culture, ethnicity, gender expression, gender identity, level of experience, nationality, personal ability or disability, physical appearance, physical or mental difference, race, religion, set of skills, sexual orientation, socio-economic status, and subculture. Harassment also includes sexual images in public spaces, deliberate intimidation, stalking, following, harassing photography or recording, inappropriate physical contact, and unwelcome sexual attention.
|
||||
- On Slack and other online or offline communications channels, don't use overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
|
||||
- Don’t be mean or rude.
|
||||
- Respect that some individuals and cultures consider the casual use of profanity offensive and off-putting.
|
||||
- Unwelcome / non-consensual sexual advances over Slack or any other channels related with this community are not okay.
|
||||
- Derailing, tone arguments and otherwise playing on people’s desires to be nice are not welcome, especially in discussions about violations to this Code of Conduct.
|
||||
- Please avoid unstructured critique.
|
||||
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
|
||||
- Sponsors of Blitz are also subject to this Code of Conduct. In particular, sponsors are required to not use sexualized images, activities, or other material which is not according to this Code of Conduct.
|
||||
|
||||
## Consequences for Violations to this Code of Conduct
|
||||
|
||||
If a participant engages in any behavior violating this Code of Conduct, the core members of this community will take any action they deem appropriate, starting with a gentle warning and then escalating as needed to expulsion from the community, exclusion from any interaction and loss of all rights in this community.
|
||||
|
||||
## Decisions About Consequences of Violations
|
||||
|
||||
Decisions about consequences of violations of this Code of Conduct are made by this community’s core members and may not be discussed with the person responsible for the violation.
|
||||
|
||||
## For Questions or Feedback
|
||||
|
||||
If you have any questions or feedback on this Code of Conduct, we’re happy to hear from you.
|
||||
|
||||
## Thanks for the Inspiration To
|
||||
|
||||
- [Hood.ie](http://hood.ie/code-of-conduct/)
|
||||
- [WeAllJS](https://wealljs.org/code-of-conduct)
|
||||
113
CONTRIBUTING.md
Normal file
113
CONTRIBUTING.md
Normal file
@@ -0,0 +1,113 @@
|
||||

|
||||
|
||||
<br>
|
||||
|
||||
We're so excited you're interested in helping with Blitz! We happy to help you get started, even if you don't have any previous open-source experience :)
|
||||
|
||||
<br>
|
||||
|
||||
### Blitz is a Community Project
|
||||
|
||||
Blitz is built by and for the community. There's no large company sponsoring development. So all community contributions are very appreciated!
|
||||
|
||||
<br>
|
||||
|
||||
### Our Codebase is a Garden
|
||||
|
||||
The Blitz codebase is like a community garden. There's a lot of beautiful plants and vegitables, but it won't take long until you find some weeds! When you find weeds, please remove them :) Minor refactoring is always encouraged. If you'd like to do some major refactoring, it's best to first either open an issue or check with us in Slack. Most likely we'll agree with you.
|
||||
|
||||
<br>
|
||||
|
||||
### First Things First
|
||||
|
||||
1. Familiarize yourself with the [Blitz Code of Conduct](https://github.com/blitz-js/blitz/blob/canary/CODE_OF_CONDUCT.md)
|
||||
2. Join the [Blitz Slack Community](https://slack.blitzjs.com)
|
||||
3. Install the [Zenhub browser extension](https://www.zenhub.com/extension)
|
||||
4. View open issues and their progress [on the Zenhub repo tab](https://github.com/blitz-js/blitz#zenhub)
|
||||
|
||||
<br>
|
||||
|
||||
### What to Work On?
|
||||
|
||||
Issues with the label [`ready to work on | help wanted`](https://github.com/blitz-js/blitz/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22ready+to+work+on+%7C+help+wanted%22) are the best place to start. If you find one that looks interesting and no one else is already working on it, comment in the issue that you are going to work on it. Please ask as many questions as you need, either directly in the issue or in Slack. We're happy to help!
|
||||
|
||||
The Blitzjs.com website and documentation repo also has issues with [`ready to work on | help wanted`](https://github.com/blitz-js/blitzjs.com/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22ready+to+work+on+%7C+help+wanted%22).
|
||||
|
||||
#### Things that are ALWAYS welcome
|
||||
|
||||
- Improved documentation
|
||||
- Improved error messages
|
||||
- Improved logging (i.e. more clear, more beautiful)
|
||||
- Educational content like blogs, videos, courses
|
||||
|
||||
If there's some other way you'd like to contribute, just ask us about it in slack!
|
||||
|
||||
After you contribute in any way, please add yourself as a contributor via the [@all-contributors bot](https://allcontributors.org/docs/en/bot/usage)!
|
||||
|
||||
<br>
|
||||
|
||||
## Development Setup
|
||||
|
||||
#### Repo Setup
|
||||
|
||||
**1.** Clone the repo
|
||||
|
||||
```
|
||||
git clone git@github.com:blitz-js/blitz.git
|
||||
cd blitz
|
||||
```
|
||||
|
||||
**2.** Install dependencies
|
||||
|
||||
```
|
||||
yarn
|
||||
```
|
||||
|
||||
**3.** Start the package server. This must be running for any package development or example development
|
||||
|
||||
```
|
||||
yarn dev
|
||||
```
|
||||
|
||||
**4.** Run tests
|
||||
|
||||
```
|
||||
yarn test
|
||||
```
|
||||
|
||||
#### Link the Blitz CLI (Optional)
|
||||
|
||||
The following will link the development CLI as a local binary so you can use it anywhere for testing.
|
||||
|
||||
```
|
||||
yarn link-cli
|
||||
// `yarn unlink-cli` will unlink
|
||||
```
|
||||
|
||||
#### Develop a Blitz `package`
|
||||
|
||||
**1.** Change to a package directory
|
||||
|
||||
```
|
||||
cd packages/core
|
||||
```
|
||||
|
||||
**2.** Start the test runner
|
||||
|
||||
```
|
||||
yarn test:watch
|
||||
```
|
||||
|
||||
#### Develop a Blitz `example`
|
||||
|
||||
**1.** Change to an example directory
|
||||
|
||||
```
|
||||
cd examples/store
|
||||
```
|
||||
|
||||
**2.** Follow instructions in the example's README
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you run into issues that should be documented here, please submit a PR! ❤️
|
||||
74
MANIFESTO.md
Normal file
74
MANIFESTO.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# The Blitz.js Manifesto
|
||||
|
||||
## Background
|
||||
|
||||
Technology follows a repeating cycle of bundling and unbundling. Created in 2005, Ruby on Rails became a major bundling force. It made web application development easier and more accessible than ever before. This benefited everyone, from those learning programming to seniors building production systems.
|
||||
|
||||
A major unbundling happened in 2013 with the release of React because it is hyper focused on the rendering layer. As React grew in popularity, so did the choices for all the other parts, leaving developers with hundreds of decisions to make when starting a new app. While this has contributed to JavaScript Fatigue, it's been a powerful driving force for rapid frontend innovation.
|
||||
|
||||
Now, in 2020, is the perfect time for another major bundling. Developers are yearning for an easier, simpler way to build web applications. Beginners want a guiding hand for building a robust app. And seniors want a framework that removes mundane tasks and provides a highly scalable architecture.
|
||||
|
||||
Hence the creation of Blitz.
|
||||
|
||||
## What is Blitz For?
|
||||
|
||||
Blitz is for building tiny to large fullstack database-backed applications that have one or more graphical user interfaces like web or mobile apps.
|
||||
|
||||
## Foundational Principles
|
||||
|
||||
1. Fullstack & Monolithic
|
||||
2. API Not Required
|
||||
3. Convention over Configuration
|
||||
4. Loose Opinions
|
||||
5. Easy to Start, Easy to Scale
|
||||
6. Stability
|
||||
7. Community over Code
|
||||
|
||||
### 1. Fullstack & Monolithic
|
||||
|
||||
A fullstack, monolithic application is simpler than an application where frontend and backend are developed and deployed separately. Monolithic doesn't mean it will be slow or hard to scale to large teams. Monolithic doesn't mean there isn't separation of concerns. Monolithic means you can reason about your app as a single entity.
|
||||
|
||||
### 2. API Not Required
|
||||
|
||||
Until now, choosing React for your view layer required you to have a REST or GraphQL API even if it wasn't used by third-parties. This additional complexity is a significant drawback not shared by traditional server rendered apps like Ruby on Rails.
|
||||
|
||||
Blitz is a framework for the 99% of us at companies with <100 employees. The vast majority of these apps don't actually need an API, at least not until years down the road when you have the time and resources to build one.
|
||||
|
||||
### 3. Convention over Configuration
|
||||
|
||||
Starting a new fullstack React app is currently too hard. You have to spend days on things like configuring eslint, prettier, husky, jest, cypress, typescript, deciding on a file structure, setting up a database, adding authentication and authorization, setting up a router, defining routing conventions, and setting up your styling library.
|
||||
|
||||
Blitz makes as many decisions and does as much work for you as possible. This makes it lightning fast to start real development. It also greatly benefits the community. Common project structure and architectural patterns make it easy to move from Blitz app to Blitz app and immediately feel at home.
|
||||
|
||||
Convention over configuration doesn't mean no configuration. It means configuration is optional. Blitz will provide all the escape hatches you need for bespoke customization.
|
||||
|
||||
### 4. Loose Opinions
|
||||
|
||||
Blitz is opinionated. The out-of-the-box experience guides you on a path perfect for most applications. However, Blitz isn't arrogant. It understands there are very good reasons for deviating from convention, and it allows you to do so. For example, Blitz has a conventional file structure, but, with few exceptions, doesn't _enforce_ it.
|
||||
|
||||
And when there's not community consensus, `blitz new` prompts you to choose.
|
||||
|
||||
### 5. Easy to Start, Easy to Scale
|
||||
|
||||
A framework that's only easy for one end of an application lifecycle is not a good framework. Both starting and scaling must be easy.
|
||||
|
||||
Easy to start includes being easy for beginners and being easy to migrate existing Next.js apps to Blitz.
|
||||
|
||||
Scaling is important in all forms: lines of code, number of people working in the codebase, and code execution.
|
||||
|
||||
### 6. Stability
|
||||
|
||||
In the fast-paced world of Javascript, a stable, predictable release cycle is a breath of fresh air. A stable release cycle ensures minimal breaking changes, and it ensures you know exactly what and when a breaking change will occur. It also minimizes bugs in stable releases by ensuring features are in beta for a minimum amount of time. [Ember is the model citizen](https://emberjs.com/releases/) in this regard.
|
||||
|
||||
The exact details of the Blitz release cycle are to be determined, but we'll follow a pattern similar to Ember which strictly follows SemVer with stable releases every 6 weeks and LTS releases every 6 months.
|
||||
|
||||
Blitz will follow a public RFC (request for comments) process so all users and companies can participate in proposing and evaluating new features.
|
||||
|
||||
If a Blitz API needs to be removed, it will be deprecated in a minor release. Major releases will simply remove APIs already deprecated in a previous release.
|
||||
|
||||
### 7. Community over Code
|
||||
|
||||
The Blitz community is the most important aspect of the framework, by far.
|
||||
We have a comprehensive [Code of Conduct](https://github.com/blitz-js/blitz/blob/canary/CODE_OF_CONDUCT.md). LGBTQ+, women, and minorities are especially welcome.
|
||||
|
||||
We are all in this together, from the youngest to the oldest. We are all more similar than we are different. We can and should solve problems together. We should learn from other communities, not compete against them.
|
||||
159
README.md
159
README.md
@@ -1,2 +1,157 @@
|
||||
# blitz
|
||||
Framework for building monolithic, full-stack, serverless React apps with zero data-fetching and zero client-side state management
|
||||
[](https://blitzjs.com)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
<p align="center">
|
||||
<a aria-label="Join our Slack Community" href="https://slack.blitzjs.com">
|
||||
<img alt="" src="https://img.shields.io/badge/Join%20our%20community-6700EB.svg?style=for-the-badge&labelColor=000000&logoWidth=20&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAQ9SURBVHgB7d3dVdtAEIbhcSpICUoH0IEogQqSVBBSAU4FSSpIOoAORAfQgSghHXzZ1U/YcMD4R9rZmf2ec3y448LyiNf27iLiGIAmPLrweC9Un3DhrzG6EarLNP09nlwJ1SOZ/lQr5N80/S/p2QMVCBf5N17XCfm1Y/rBHqjAG9PPHvBsz+mf9WAP+HLA9M/YA14cOP2payH7jpj+VCtk1wnTP+vj7xCy6cTpn7EHLMLp059iD1iD8eveJbVCNsSLheX1YA/YgOWnf8YeKB3Wmf7Ud6Fy4f/FHmtpxbl3YlC4MJ/Cj0bWdwPnPbARg+L0S54XQHS32WwuxClzd4CM0z9rPfeAuTtA5ulPXYQ7wZ04Y+oOoDD9KZc9YOoOoDj9s4dwFzgXR6w1wIPoOvPWA9buAHEJ173o3gWiy3AnuBUHLEbgmYwvAk1/wuM8vAgexThzbwPDkx7/DHwVXfFOxP2GmsKd4Ab6zPeAyU8CI7AHFmH2BRCBPXAyk18GzUrqAXCTiR4ssyj0VFw/oCU8+e+RZ33AWz6KMaYbIIWxB+JSLs1bsbkeMN0AqakHvoku9oA2sAfqBvbAQdw0QArsgb25aYBUQT3QgT2gB+yBuqGcHij2UCqXDZACe2Anlw2QYg/QAOyBuoE98CL3DZDCuK4/rh/Q7oGL6U+TOvcNkJoijN8X1C48+T+g75eQDrAH/qmqAVJgDwyqaoAUe4AGYA/UDZX3QLUNkEIZPRCd5+6BahsgVUgPROwBTSijB7jpVAvGHriHvmw9wAZ4BpX1ABvgmakHtPcbRuwBTWAPULgAV9D/jKDY9YRvwvgEaurD44uQHvAol7qBW7WKluVtIHiUS7GyvA0s6CiXDnxrpQfsgbqBS7GKk/2jYHCrVlGyfxTMrVo0ALdq1Q3sgSKofh0M9oA61a+D2QM0AHugbmAPqClmSRjK2apVVQ8UsySsoK1aHdgDesCtWnUDeyCrIpeFg1u3sylyWTi3btMA7IG6gT2wuuK3hoE9sKrit4YVslWLPaAN7IG6ocKt2zmY2h4O9sDiTG0PZw/QANy6XTewBxZj9ogYVHy025LMHhEz9cBn0We6B0yfERReBLfhx0/R1YQHPx/QBPbA0VwcEwf2wNFcHBPHHjiem3MC2QPHcXdSaJjA+KfgTPQ8hhfjBzHC40mhlzJ+Xq9lK4a4PCs43AVaGTed5mZq+iOXZwWHi3AnOj2wFWNcnxYe7gTxLtBKHuamP/J+Wnh8a5irB7ZC5Yk9gPX1QuXC+usHWqGyhYvUYR0a7zboUOFCNVhnk0krZAOW7wFOvzXhom2xnEbIHizTA1wEYhWW6YFGyC6c1gOcfg9wfA80Qj7g8B7g9HuCww+haIR8wf49wOn3Cvv9k8tGyC/s7gFOv3fY3QONkH+v9MBWqB7PeqDn9FcIT//kcitUn6kHOu/T/xfWzlQy3dEHhwAAAABJRU5ErkJggg==">
|
||||
</a>
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
<a aria-label="All Contributors" href="#contributors-"><img alt="" src="https://img.shields.io/badge/all_contributors-28-17BB8A.svg?style=for-the-badge&labelColor=000000"></a>
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
<a aria-label="License" href="https://github.com/blitz-js/blitz/blob/canary/LICENSE">
|
||||
<img alt="" src="https://img.shields.io/npm/l/blitz.svg?style=for-the-badge&labelColor=000000&color=blue">
|
||||
</a>
|
||||
<a aria-label="NPM version" href="https://www.npmjs.com/package/blitz">
|
||||
<img alt="" src="https://img.shields.io/npm/v/blitz.svg?style=for-the-badge&labelColor=000000&color=E65528">
|
||||
</a>
|
||||
</p>
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<br>
|
||||
|
||||
<h3 align="center">Blitz is a Rails-like framework for monolithic, full-stack React apps — built on Next.js</h3>
|
||||
|
||||
<br>
|
||||
|
||||
Blitz brings back the **simplicity and conventions** of server-rendered frameworks like Ruby on Rails while preserving everything we love about React and client-side rendering!
|
||||
|
||||
Blitz is the framework for the 99% of us at companies with <100 employees. This means **we don't force you to use advanced technologies like GraphQL**. We let you add advanced technologies on your terms and at your pace.
|
||||
|
||||
Blitz **maximizes your productivity** both when starting an app and when scaling it to lots of code and users.
|
||||
|
||||
<br>
|
||||
|
||||
**Features:**<br>
|
||||
⚡️ Built on Next.js<br>
|
||||
⚡️ Don't have to build an API for client-side rendering<br>
|
||||
⚡️ Client-side rendering, Server-side rendering, and fully static pages all in the same app<br>
|
||||
⚡️ Full Typescript support with static, end-to-end typing (no code generation step needed like with GraphQL)<br>
|
||||
⚡️ React Concurrent Mode enabled<br>
|
||||
⚡️ Database/ORM agnostic, but Prisma 2 is default<br>
|
||||
⚡️ CLI with code scaffolding, Rails-style console REPL, etc<br>
|
||||
⚡️ GraphQL Ready<br>
|
||||
⚡️ Deploy serverless or serverful<br>
|
||||
|
||||
**Other key features coming:**<br>
|
||||
⚡️ Highly secure authentication <br>
|
||||
⚡️ Authorization you can use on both server and client<br>
|
||||
⚡️ Model validation you can use on both server and client<br>
|
||||
⚡️ Plugins for easily adding libraries like Tailwind, CSS-in-JS, etc.<br>
|
||||
⚡️ React native support<br>
|
||||
⚡️ GUI so you don't have to use the CLI<br>
|
||||
|
||||
<br>
|
||||
|
||||
### :tada: Alpha Release Now Available :tada:
|
||||
|
||||
1. `npm i -g blitz`
|
||||
2. `blitz new myapp`
|
||||
3. [Read the Alpha User Guide](https://github.com/blitz-js/blitz/blob/canary/USER_GUIDE.md)
|
||||
|
||||
<br>
|
||||
|
||||
### What is Blitz Designed For?
|
||||
|
||||
Blitz is designed for tiny to large database-backed applications that have one or more graphical user interfaces.
|
||||
|
||||
While we currently only support web, we are pursuing the dream of a single monolithic application that runs on web and mobile with maximum code sharing and minimal boilerplate.
|
||||
|
||||
<br>
|
||||
|
||||
### What are the Foundational Principles?
|
||||
|
||||
1. Fullstack & Monolithic
|
||||
2. API Not Required
|
||||
3. Convention over Configuration
|
||||
4. Loose Opinions
|
||||
5. Easy to Start, Easy to Scale
|
||||
6. Stability
|
||||
7. Community over Code
|
||||
|
||||
[The Blitz Manifesto](https://github.com/blitz-js/blitz/blob/canary/MANIFESTO.md) explains these principles in detail.
|
||||
|
||||
<br>
|
||||
|
||||
## Welcome to the Blitz Community 👋
|
||||
|
||||
The Blitz community is warm, safe, diverse, inclusive, and fun! LGBTQ+, women, and minorities are especially welcome. Please read our [Code of Conduct](https://github.com/blitz-js/blitz/blob/canary/CODE_OF_CONDUCT.md).
|
||||
|
||||
[Join our Slack Community](https://slack.blitzjs.com) where we help each other build Blitz apps. It's also where we collaborate on building Blitz itself.
|
||||
|
||||
There's still a lot of work to do, so you are especially invited to join us in building Blitz! A good place to start is [The Contributing Guide](CONTRIBUTING.md).
|
||||
|
||||
<br>
|
||||
|
||||
## Sponsors and Donations
|
||||
|
||||
- Contribute via [GitHub Sponsors](https://github.com/sponsors/blitz-js)
|
||||
- Contribute via [PayPal](https://paypal.me/thebayers)
|
||||
- Contribute via [Open Collective](https://opencollective.com/blitzjs)
|
||||
- Contribute via [Patreon](https://patreon.com/flybayer)
|
||||
|
||||
_Sponsor Blitz and display your logo and hiring status here. This is a great way to get in front of early adopters!_
|
||||
|
||||
<br>
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="https://twitter.com/flybayer"><img src="https://avatars3.githubusercontent.com/u/8813276?v=4" width="100px;" alt=""/><br /><sub><b>Brandon Bayer</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=flybayer" title="Code">💻</a> <a href="#content-flybayer" title="Content">🖋</a> <a href="#ideas-flybayer" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/blitz-js/blitz/pulls?q=is%3Apr+reviewed-by%3Aflybayer" title="Reviewed Pull Requests">👀</a></td>
|
||||
<td align="center"><a href="https://fabulas.io"><img src="https://avatars1.githubusercontent.com/u/14793389?v=4" width="100px;" alt=""/><br /><sub><b>Michael Edelman </b></sub></a><br /><a href="#infra-medelman17" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/blitz-js/blitz/commits?author=medelman17" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://merelinguist.now.sh"><img src="https://avatars3.githubusercontent.com/u/24858006?v=4" width="100px;" alt=""/><br /><sub><b>Dylan Brookes</b></sub></a><br /><a href="#ideas-merelinguist" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/blitz-js/blitz/pulls?q=is%3Apr+reviewed-by%3Amerelinguist" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/blitz-js/blitz/commits?author=merelinguist" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://medium.com/@ryardley"><img src="https://avatars0.githubusercontent.com/u/1256409?v=4" width="100px;" alt=""/><br /><sub><b>Rudi Yardley</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=ryardley" title="Code">💻</a> <a href="#ideas-ryardley" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center"><a href="http://www.geistinteractive.com"><img src="https://avatars2.githubusercontent.com/u/316792?v=4" width="100px;" alt=""/><br /><sub><b>Todd Geist</b></sub></a><br /><a href="#financial-toddgeist" title="Financial">💵</a></td>
|
||||
<td align="center"><a href="https://github.com/quirk0o"><img src="https://avatars3.githubusercontent.com/u/5123725?v=4" width="100px;" alt=""/><br /><sub><b>Beata Obrok</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=quirk0o" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/tsawan"><img src="https://avatars3.githubusercontent.com/u/3263082?v=4" width="100px;" alt=""/><br /><sub><b>Tahir Awan</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=tsawan" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://raluce.com"><img src="https://avatars1.githubusercontent.com/u/2454632?v=4" width="100px;" alt=""/><br /><sub><b>Camilo Gonzalez</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=camilo86" title="Code">💻</a></td>
|
||||
<td align="center"><a href="http://da.nielkempner.com"><img src="https://avatars3.githubusercontent.com/u/2532112?v=4" width="100px;" alt=""/><br /><sub><b>Daniel Kempner</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=dkempner" title="Code">💻</a></td>
|
||||
<td align="center"><a href="http://gielcobben.com"><img src="https://avatars0.githubusercontent.com/u/2663212?v=4" width="100px;" alt=""/><br /><sub><b>Giel</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=gielcobben" title="Code">💻</a></td>
|
||||
<td align="center"><a href="http://jeremyliberman.com/"><img src="https://avatars3.githubusercontent.com/u/2754163?v=4" width="100px;" alt=""/><br /><sub><b>Jeremy Liberman</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=MrLeebo" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://jimthedev.com"><img src="https://avatars0.githubusercontent.com/u/108938?v=4" width="100px;" alt=""/><br /><sub><b>Jim Cummins</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=jimthedev" title="Code">💻</a></td>
|
||||
<td align="center"><a href="http://kristinamatuska.com/"><img src="https://media-exp1.licdn.com/dms/image/C5603AQHVPAjV21gw9g/profile-displayphoto-shrink_200_200/0?e=1591228800&v=beta&t=0MlbmiYhNvGv1xjLD_fOhOFjVDZ7ltNwfGNeJ4DHedQ" width="100px;" alt=""/><br /><sub><b>Kristina Matuška</b></sub></a><br /><a href="#design" title="Design">🎨</a></td>
|
||||
<td align="center"><a href="http://robdrosenberg.com"><img src="https://avatars0.githubusercontent.com/u/20813991?v=4" width="100px;" alt=""/><br /><sub><b>Robert Rosenberg</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=robdrosenberg" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/jasonblalock"><img src="https://avatars0.githubusercontent.com/u/5899929?v=4" width="100px;" alt=""/><br /><sub><b>Jason Blalock</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=jasonblalock" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://corey-brown.com"><img src="https://avatars1.githubusercontent.com/u/12791148?v=4" width="100px;" alt=""/><br /><sub><b>Corey Brown</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=coreybrown89" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/aej11a"><img src="https://avatars2.githubusercontent.com/u/10066422?v=4" width="100px;" alt=""/><br /><sub><b>aej11a</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=aej11a" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/marcoseoane"><img src="https://avatars0.githubusercontent.com/u/28088807?v=4" width="100px;" alt=""/><br /><sub><b>marcoseoane</b></sub></a><br /><a href="#ideas-marcoseoane" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center"><a href="https://github.com/rishabhpoddar"><img src="https://avatars2.githubusercontent.com/u/2976287?v=4" width="100px;" alt=""/><br /><sub><b>Rishabh Poddar</b></sub></a><br /><a href="#ideas-rishabhpoddar" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center"><a href="https://github.com/aem"><img src="https://avatars0.githubusercontent.com/u/1909883?v=4" width="100px;" alt=""/><br /><sub><b>Adam Markon</b></sub></a><br /><a href="#ideas-aem" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center"><a href="https://github.com/lorenzorapetti"><img src="https://avatars1.githubusercontent.com/u/2632174?v=4" width="100px;" alt=""/><br /><sub><b>Lorenzo Rapetti</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=lorenzorapetti" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/wKovacs64"><img src="https://avatars1.githubusercontent.com/u/1288694?v=4" width="100px;" alt=""/><br /><sub><b>Justin Hall</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=wKovacs64" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/sijad"><img src="https://avatars3.githubusercontent.com/u/7693001?v=4" width="100px;" alt=""/><br /><sub><b>Sajjad Hashemian</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=sijad" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/ETLopes"><img src="https://avatars3.githubusercontent.com/u/34959471?v=4" width="100px;" alt=""/><br /><sub><b>Eduardo Lopes</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=ETLopes" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/mattleff"><img src="https://avatars0.githubusercontent.com/u/120155?v=4" width="100px;" alt=""/><br /><sub><b>Matthew Leffler</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=mattleff" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://hew.tools"><img src="https://avatars0.githubusercontent.com/u/3103241?v=4" width="100px;" alt=""/><br /><sub><b>Matt</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=hew" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://github.com/sonnypgs"><img src="https://avatars3.githubusercontent.com/u/1431300?v=4" width="100px;" alt=""/><br /><sub><b>Sonny</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=sonnypgs" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://github.com/Zeko369"><img src="https://avatars3.githubusercontent.com/u/3064377?v=4" width="100px;" alt=""/><br /><sub><b>Fran Zekan</b></sub></a><br /><a href="https://github.com/blitz-js/blitz/commits?author=Zeko369" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-enable -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
|
||||
375
USER_GUIDE.md
Normal file
375
USER_GUIDE.md
Normal file
@@ -0,0 +1,375 @@
|
||||

|
||||
|
||||
<br>
|
||||
|
||||
Before getting started, you should know **this is alpha software**. Blitz is incomplete. There are rough spots and bugs. APIs may change. But you can build an app and deploy it to production. We're excited to see what you build!
|
||||
|
||||
If you have any issues at all, please [open an issue](https://github.com/blitz-js/blitz/issues/new/choose) or join the [Blitz slack](https://slack.blitzjs.com) and talk to us in the **#help** channel. If you get stuck and frustrated, please don't blame yourself. This user guide, and Blitz in general, is not yet fine-tuned for those with less experience. But eventually, it will be because this is very important to us.
|
||||
|
||||
<br>
|
||||
|
||||
## Introduction
|
||||
|
||||
Blitz is a Rails-like framework for building monolithic, full-stack React apps. The idea is that Blitz makes you extremely productive by doing as much set up and grunt work for you.
|
||||
|
||||
**When building a Blitz app, you don’t have to think about “building an API” or “fetching data from your API”**. You only think about writing functions that get and change data. And to use those functions in your component, you simply import and call them like a regular function.
|
||||
|
||||
Blitz is built on Next.js, so if you are familiar with that, you will feel right at home.
|
||||
|
||||
<br>
|
||||
|
||||
## Blitz App Development
|
||||
|
||||
### Set Up Your Computer
|
||||
|
||||
- [ ] You need Node.js 12 or newer
|
||||
- [ ] You need Postgres installed and running.
|
||||
|
||||
- On macOS, you can use `brew install postgres` or install [Postgres.app](https://postgresapp.com/)
|
||||
|
||||
<br>
|
||||
|
||||
### Create Your Blitz App
|
||||
|
||||
1. `npm install -g blitz` or `yarn global add blitz`
|
||||
2. Run `blitz new myAppName` to create a new blitz app in the `myAppName` directory
|
||||
3. `cd myAppName`
|
||||
4. `blitz start`
|
||||
5. View your baby app at [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
<br>
|
||||
|
||||
### Set Up Your Database
|
||||
|
||||
By default, Blitz uses Prisma 2 which is a strongly typed database client. **You probably want to read [the Prisma 2 documentation](https://www.prisma.io/docs/understand-prisma/introduction).** _Note, Prisma 2 is not required for Blitz. The only Prisma-Blitz integration is the `blitz db` cli command. You can use anything you want, such as Mongo, TypeORM, etc._
|
||||
|
||||
1. Open `db/prisma.schema` and add the following:
|
||||
|
||||
```prisma
|
||||
model Project {
|
||||
id Int @default(autoincrement()) @id
|
||||
name String
|
||||
tasks Task[]
|
||||
}
|
||||
|
||||
model Task {
|
||||
id Int @default(autoincrement()) @id
|
||||
name String
|
||||
project Project @relation(fields: [projectId], references: [id])
|
||||
projectId Int
|
||||
}
|
||||
```
|
||||
|
||||
2. Run `blitz db migrate`
|
||||
- If this fails, you need to change the `DATABASE_URL` value in `.env` to whatever is required by your Postgres installation.
|
||||
|
||||
<br>
|
||||
|
||||
### Scaffold out all the files your basic CRUD actions
|
||||
|
||||
_CRUD = create, read, update, delete_
|
||||
|
||||
1. Run `blitz generate all project` to generate fully working queries, mutations, and pages
|
||||
2. Open [http://localhost:3000/projects](http://localhost:3000/projects) to see the default project list page
|
||||
3. Explore the generated pages and view, create, update, and delete projects.
|
||||
|
||||
<br>
|
||||
|
||||
### Pages
|
||||
|
||||
Blitz.js pages are exactly the same as Next.js pages. If you need, read [the Next.js Page documentation](https://nextjs.org/docs/basic-features/pages)
|
||||
|
||||
- Unlike Next.js, you can have many `pages/` folders nested inside `app/`. This way pages can be organized neatly, especially for larger projects. Like this:
|
||||
- `app/pages/about.tsx`
|
||||
- `app/projects/pages/projects/index.tsx`
|
||||
- `app/tasks/pages/projects/[projectId]/tasks/[id].tsx`
|
||||
- All React components inside a `pages/` folder are accessible at a URL corresponding to its path inside `pages/`. So `pages/about.tsx` will be at `localhost:3000/about`.
|
||||
|
||||
The Next.js router APIs are all exported from the `blitz` package: `useRouter()`, `withRouter()`, and `Router`. If you need, read [the Next.js Router documentation](https://nextjs.org/docs/api-reference/next/router).
|
||||
|
||||
<br>
|
||||
|
||||
### Writing Queries & Mutations
|
||||
|
||||
Blitz queries and mutations are plain, asynchronous Javascript functions that always run on the server.
|
||||
|
||||
We automatically alias the root of your project, so `import db from 'db'` is importing `<project_root>/db/index.ts`
|
||||
|
||||
**Example Query:**
|
||||
|
||||
```ts
|
||||
// app/products/queries/getProduct.tsx
|
||||
import db, {FindOneProductArgs} from 'db'
|
||||
|
||||
export default async function getProduct(args: FindOneProductArgs) {
|
||||
// Can do any pre-processing or event triggers here
|
||||
const product = await db.product.findOne(args)
|
||||
// Can do any post-processing or event triggers here
|
||||
|
||||
return product
|
||||
}
|
||||
```
|
||||
|
||||
**Example Mutation:**
|
||||
|
||||
```ts
|
||||
// app/products/mutations/createProduct.tsx
|
||||
import db, {ProductCreateArgs} from 'db'
|
||||
|
||||
export default async function createProduct(args: ProductCreateArgs) {
|
||||
// Can do any pre-processing or event triggers here
|
||||
const product = await db.product.create(args)
|
||||
// Can do any post-processing or event triggers here
|
||||
|
||||
return product
|
||||
}
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
### Using Queries
|
||||
|
||||
#### In a React Component
|
||||
|
||||
Blitz provides a `useQuery` hook, which is built on [`react-query`](https://github.com/tannerlinsley/react-query). The first argument is a query function. The second argument is the input to the query function. The third argument is any valid react-query configuration item.
|
||||
|
||||
At build time, the direct function import is swapped out for a function that executes a network call to run the query serverside.
|
||||
|
||||
**React Concurrent Mode is enabled by default for Blitz apps.** So the `<Suspense>` component is used for loading states and `<ErrorBoundary>` is used to display errors. If you need, you can read the [React Concurrent Mode Docs](https://reactjs.org/docs/concurrent-mode-intro.html).
|
||||
|
||||
```tsx
|
||||
import {Suspense} from 'react'
|
||||
import {useRouter, useQuery} from 'blitz'
|
||||
import getProduct from 'app/products/queries/getProduct'
|
||||
import ErrorBoundary from 'app/components/ErrorBoundary'
|
||||
|
||||
function Product() {
|
||||
const router = useRouter()
|
||||
const id = parseInt(router.query.id as string)
|
||||
const [product] = useQuery(getProduct, {where: {id: props.query.id}})
|
||||
|
||||
return <div>{product.name}</div>
|
||||
}
|
||||
|
||||
export default function () {
|
||||
return (
|
||||
<div>
|
||||
<ErrorBoundary fallback={(error) => <div>Error: {JSON.stringify(error)}</div>}>
|
||||
<Suspense fallback={<div>Loading...</div>}>
|
||||
<Product />
|
||||
</Suspense>
|
||||
</ErrorBoundary>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
#### On the Server
|
||||
|
||||
In `getStaticProps`, a query function can be called directly without `useQuery`
|
||||
|
||||
```tsx
|
||||
import getProduct from '/app/products/queries/getProduct'
|
||||
|
||||
export const getStaticProps = async (context) => {
|
||||
const product = await getProduct({where: {id: context.params?.id}})
|
||||
return {props: {product}}
|
||||
}
|
||||
|
||||
export default function ({product}) {
|
||||
return <div>{product.name}</div>
|
||||
}
|
||||
```
|
||||
|
||||
In `getServerSideProps`, pass a query function to `ssrQuery` which will ensure appropriate middleware is run before/after your query function.
|
||||
|
||||
```tsx
|
||||
import {ssrQuery} from 'blitz'
|
||||
import getProduct from '/app/products/queries/getProduct'
|
||||
|
||||
export const getServerSideProps = async ({params, req, res}) => {
|
||||
const product = await ssrQuery(getProduct, {where: {id: params.id}}, {req, res}))
|
||||
return {props: {product}}
|
||||
}
|
||||
|
||||
export default function({product}) {
|
||||
return <div>{product.name}</div>
|
||||
}
|
||||
```
|
||||
|
||||
For more details, read the comprehensive [Query & Mutation Usage Issue](https://github.com/blitz-js/blitz/issues/89)
|
||||
|
||||
<br>
|
||||
|
||||
### Using Mutations
|
||||
|
||||
Mutations are called directly, like a regular asynchronous function.
|
||||
|
||||
At build time, the direct function import is swapped out for a function that executes a network call to run the mutation server-side.
|
||||
|
||||
```tsx
|
||||
import {useQuery} from 'blitz'
|
||||
import getProduct from '/app/products/queries/getProduct'
|
||||
import updateProduct from '/app/products/mutations/updateProduct'
|
||||
|
||||
function (props) {
|
||||
const [product] = useQuery(getProduct, {where: {id: props.id}})
|
||||
|
||||
return (
|
||||
<Formik
|
||||
initialValues={product}
|
||||
onSubmit={async values => {
|
||||
try {
|
||||
const product = await updateProduct(values)
|
||||
} catch (error) {
|
||||
alert('Error saving product')
|
||||
}
|
||||
}}>
|
||||
{/* ... */}
|
||||
</Formik>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
For more details, read the comprehensive [Query & Mutation Usage Issue](https://github.com/blitz-js/blitz/issues/89)
|
||||
|
||||
<br>
|
||||
|
||||
### Custom API Routes
|
||||
|
||||
Blitz.js custom API routes are exactly the same as Next.js custom API routes. If you need, read [the Next.js API route documentation](https://nextjs.org/docs/api-routes/introduction)
|
||||
|
||||
- Unlike Next.js, your `api/` folder must be a sibling of `pages/` instead of being nested inside.
|
||||
- All React components inside an `api/` folder are accessible at a URL corresponding to it's path inside `api/`. So `app/projects/api/webhook.tsx` will be at `localhost:3000/api/webhook`.
|
||||
|
||||
<br>
|
||||
|
||||
### Customize the Webpack Config
|
||||
|
||||
Blitz uses the `blitz.config.js` config file at the root of your project. This is exactly the same as `next.config.js`. Read [the Next.js docs on customizing webpack](https://nextjs.org/docs/api-reference/next.config.js/custom-webpack-config).
|
||||
|
||||
<br>
|
||||
|
||||
### Deploy to Production
|
||||
|
||||
1. You need a production Postgres database. It's easy to set this up on [Digital Ocean](https://www.digitalocean.com/products/managed-databases-postgresql/?refcode=466ad3d3063d).
|
||||
2. For deploying serverless, you also need a connection pool. This is also relatively easy to set up on Digital Ocean.
|
||||
1. [Read the Digitial Ocean docs on setting up your connection pool](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/#creating-a-connection-pool?refcode=466ad3d3063d)
|
||||
2. Ensure you set your "Pool Mode" to be "Session" instead of "Transaction" (because of a bug in Prisma)
|
||||
3. Lastly, you need your entire database connection string. If you need, [read the Prisma docs on this](https://www.prisma.io/docs/reference/database-connectors/postgresql#connection-details).
|
||||
1. If deploying to serverless with a connection pool, make sure you get the connection string to your connection pool, not directly to the DB.
|
||||
|
||||
#### Serverless
|
||||
|
||||
Assuming you already have a Zeit account and the `now` cli installed, you can do the following:
|
||||
|
||||
1. Add your DB url as a secret environment variable by running `now secrets add @database-url "DATABASE_CONNECTION_STRING"`
|
||||
2. Add a `now.json` at your project root with
|
||||
|
||||
```json
|
||||
{
|
||||
"env": {
|
||||
"DATABASE_URL": "@database-url"
|
||||
},
|
||||
"build": {
|
||||
"env": {
|
||||
"DATABASE_URL": "@database-url"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Run `now`
|
||||
|
||||
Once working and deployed to production, your app should be very stable because it’s running Next.js which is already battle-tested.
|
||||
|
||||
#### Traditional, Long-Running Server
|
||||
|
||||
You can deploy a Blitz app like a regular Node or Express project.
|
||||
|
||||
`blitz start --production` will start your app in production mode. Make sure you provide the `DATABASE_URL` environment variable for your production database.
|
||||
|
||||
<br>
|
||||
|
||||
## Blitz CLI Commands
|
||||
|
||||
#### `blitz new NAME`
|
||||
|
||||
Generate a new blitz project at `<current_folder>./NAME`
|
||||
|
||||
#### `blitz start`
|
||||
|
||||
Start your app in development mode
|
||||
|
||||
#### `blitz start --production`
|
||||
|
||||
Start your app in production mode
|
||||
|
||||
#### `blitz db migrate`
|
||||
|
||||
Run any needed migrations via Prisma 2 and generate Prisma Client
|
||||
|
||||
#### `blitz db introspect`
|
||||
|
||||
Will introspect the database defined in `db/schema.prisma` and automatically generate a complete `schema.prisma` file for you. Lastly, it'll generate Prisma Client.
|
||||
|
||||
#### `blitz db studio`
|
||||
|
||||
Open the Prisma Studio UI at [http://localhost:5555](http://localhost:5555) so you can easily see and change data in your database.
|
||||
|
||||
#### `blitz generate -h`
|
||||
|
||||
Generate different types of files for a model. Your model input can be singular or plural, but the generated files will be the same in both cases.
|
||||
|
||||
#### `blitz console`
|
||||
|
||||
Start a Node.js REPL that's preloaded with your `db` object and all your queries and mutations. This is awesome for quickly trying your code without running the app!
|
||||
|
||||
<br>
|
||||
|
||||
## More Information
|
||||
|
||||
- Read the [Architecture RFC](https://github.com/blitz-js/blitz/pull/73) for more details on the architecture, our decision making, and how queries/mutations work under the hood
|
||||
- Read the [File Structure & Routing RFC](https://github.com/blitz-js/blitz/pull/74) for more details about the file structure and routing conventions.
|
||||
- View an example Blitz app at [`examples/store`](https://github.com/blitz-js/blitz/tree/canary/examples/store)
|
||||
|
||||
<br>
|
||||
|
||||
## What's Next for Blitz.js?
|
||||
|
||||
Here's the list of big things that are currently missing from Blitz but are a top priority for us:
|
||||
|
||||
- A real Blitzjs.com website and documentation
|
||||
- Translated documentation. If you're interested in helping, [comment in this issue](https://github.com/blitz-js/blitzjs.com/issues/20).
|
||||
- Authentication
|
||||
- Authorization (use auth rules both on server and client)
|
||||
- Model validation (use model validation both on server and client)
|
||||
- React-Native support
|
||||
- GUI for folks who prefer that over CLIs
|
||||
- ... and tons more 🙂
|
||||
|
||||
<br>
|
||||
|
||||
## FAQ
|
||||
|
||||
- **Does Blitz support vanilla Javascript?** Yes, but `blitz new` generates all Typescript files right now. You can add new files with JS and/or convert the generated files to JS. There's an [open issue for generating vanilla JS files](https://github.com/blitz-js/blitz/issues/160) that needs help.
|
||||
- **Will you support other ESLint configs for the `blitz new` app?** Yes, there's [an issue for this](https://github.com/blitz-js/blitz/issues/161)
|
||||
|
||||
<br>
|
||||
|
||||
## You are invited to help — let’s build the future of web dev together! 🤝
|
||||
|
||||
Blitz is just getting started, and it's going to take an entire community to bring it to fruition!
|
||||
|
||||
How you can help:
|
||||
|
||||
1. Tell others about Blitz
|
||||
2. Report bugs by opening an issue here on GitHub
|
||||
3. Send us feedback in the [Blitz slack](https://slack.blitzjs.com).
|
||||
4. Contribute code. We have a lot of issues that are ready to work on! Start by reading [The Contributing Guide](https://github.com/blitz-js/blitz/blob/canary/CONTRIBUTING.md). Let us know if you need help.
|
||||
5. Any way you want! We totally appreciate any type of contribution, such as documentation, videos, blog posts, etc. If you have a crazy idea, feel free to run it past us in Slack! :)
|
||||
6. [Sponsorships & donations](https://github.com/blitz-js/blitz#sponsors-and-donations)
|
||||
|
||||
<br>
|
||||
|
||||
That's all for now. We hope to see you in the [Blitz slack community](https://slack.blitzjs.com)!
|
||||
3
__mocks__/fs.js
Normal file
3
__mocks__/fs.js
Normal file
@@ -0,0 +1,3 @@
|
||||
const {fs} = require('memfs')
|
||||
|
||||
module.exports = fs
|
||||
4
examples/store/.babelrc.js
Normal file
4
examples/store/.babelrc.js
Normal file
@@ -0,0 +1,4 @@
|
||||
module.exports = {
|
||||
presets: ['next/babel'],
|
||||
plugins: [],
|
||||
}
|
||||
1
examples/store/.env.example
Normal file
1
examples/store/.env.example
Normal file
@@ -0,0 +1 @@
|
||||
DATABASE_URL=postgresql://USERNAME@localhost:5432/blitz-example-store
|
||||
9
examples/store/.eslintrc.js
Normal file
9
examples/store/.eslintrc.js
Normal file
@@ -0,0 +1,9 @@
|
||||
module.exports = {
|
||||
extends: ['react-app', 'plugin:jsx-a11y/recommended'],
|
||||
plugins: ['jsx-a11y'],
|
||||
rules: {
|
||||
'import/no-webpack-loader-syntax': 'off',
|
||||
'react/react-in-jsx-scope': 'off', // React is always in scope with Blitz
|
||||
'jsx-a11y/anchor-is-valid': 'off', //Doesn't play well with Blitz/Next <Link> usage
|
||||
},
|
||||
}
|
||||
37
examples/store/.gitignore
vendored
Normal file
37
examples/store/.gitignore
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
||||
|
||||
# dependencies
|
||||
/node_modules
|
||||
/.pnp
|
||||
.pnp.js
|
||||
|
||||
# testing
|
||||
/coverage
|
||||
|
||||
# next.js
|
||||
/.next/
|
||||
/out/
|
||||
/.blitz/
|
||||
*.sqlite
|
||||
.generated-prisma-client
|
||||
.blitz-console-history
|
||||
|
||||
# production
|
||||
/build
|
||||
.now
|
||||
|
||||
# misc
|
||||
.DS_Store
|
||||
|
||||
# debug
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# local env files
|
||||
.envrc
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
5
examples/store/.prettierignore
Normal file
5
examples/store/.prettierignore
Normal file
@@ -0,0 +1,5 @@
|
||||
.gitkeep
|
||||
.env
|
||||
*.ico
|
||||
*.lock
|
||||
|
||||
22
examples/store/README.md
Normal file
22
examples/store/README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## Getting Started
|
||||
|
||||
1. Ensure you have Postgres installed locally
|
||||
2. Set the `DATABASE_URL` environment variable, something like this:
|
||||
|
||||
```
|
||||
DATABASE_URL=postgresql://<your_computer_username>@localhost:5432/blitz-example-store
|
||||
```
|
||||
|
||||
3. DB migrate
|
||||
|
||||
```
|
||||
yarn blitz db migrate
|
||||
```
|
||||
|
||||
4. Start the dev server
|
||||
|
||||
```
|
||||
yarn blitz start
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
16
examples/store/app/admin/pages/admin/index.tsx
Normal file
16
examples/store/app/admin/pages/admin/index.tsx
Normal file
@@ -0,0 +1,16 @@
|
||||
import {Link} from 'blitz'
|
||||
|
||||
export default function () {
|
||||
return (
|
||||
<div>
|
||||
<h1>Store Admin</h1>
|
||||
<div>
|
||||
<p>
|
||||
<Link href="/admin/products">
|
||||
<a>Manage Products</a>
|
||||
</Link>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
30
examples/store/app/admin/pages/admin/products/[id].tsx
Normal file
30
examples/store/app/admin/pages/admin/products/[id].tsx
Normal file
@@ -0,0 +1,30 @@
|
||||
import {Suspense} from 'react'
|
||||
import {Link, useRouter, useQuery} from 'blitz'
|
||||
import getProduct from 'app/products/queries/getProduct'
|
||||
import ProductForm from 'app/products/components/ProductForm'
|
||||
|
||||
function Product() {
|
||||
const router = useRouter()
|
||||
const id = parseInt(router?.query.id as string)
|
||||
const [product] = useQuery(getProduct, {where: {id}})
|
||||
|
||||
return <ProductForm product={product} onSuccess={() => router.push('/admin/products')} />
|
||||
}
|
||||
|
||||
export default function () {
|
||||
return (
|
||||
<div>
|
||||
<h1>Edit Product</h1>
|
||||
<p>
|
||||
<Link href="/admin/products">
|
||||
<a>Manage Products</a>
|
||||
</Link>
|
||||
</p>
|
||||
<div>
|
||||
<Suspense fallback={<div>Loading...</div>}>
|
||||
<Product />
|
||||
</Suspense>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
40
examples/store/app/admin/pages/admin/products/index.tsx
Normal file
40
examples/store/app/admin/pages/admin/products/index.tsx
Normal file
@@ -0,0 +1,40 @@
|
||||
import {Suspense} from 'react'
|
||||
import {useQuery, Link} from 'blitz'
|
||||
import getProducts from 'app/products/queries/getProducts'
|
||||
|
||||
function ProductsList() {
|
||||
const [products] = useQuery(getProducts)
|
||||
|
||||
return (
|
||||
<ul>
|
||||
{products.map((product) => (
|
||||
<li key={product.id}>
|
||||
<Link href="/admin/products/[id]" as={`/admin/products/${product.id}`}>
|
||||
<a>{product.name}</a>
|
||||
</Link>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
)
|
||||
}
|
||||
|
||||
export default function () {
|
||||
return (
|
||||
<div>
|
||||
<h1>Products</h1>
|
||||
|
||||
<p>
|
||||
<Link href="/admin/products/new">
|
||||
<a>Create Product</a>
|
||||
</Link>
|
||||
<Link href="/admin">
|
||||
<a style={{marginLeft: 16}}>Admin</a>
|
||||
</Link>
|
||||
</p>
|
||||
|
||||
<Suspense fallback={<div>Loading...</div>}>
|
||||
<ProductsList />
|
||||
</Suspense>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
19
examples/store/app/admin/pages/admin/products/new.tsx
Normal file
19
examples/store/app/admin/pages/admin/products/new.tsx
Normal file
@@ -0,0 +1,19 @@
|
||||
import {Link, useRouter} from 'blitz'
|
||||
import ProductForm from 'app/products/components/ProductForm'
|
||||
|
||||
export default function () {
|
||||
const router = useRouter()
|
||||
return (
|
||||
<div>
|
||||
<h1>Create a New Product</h1>
|
||||
<p>
|
||||
<Link href="/admin/products">
|
||||
<a>Manage Products</a>
|
||||
</Link>
|
||||
</p>
|
||||
<div>
|
||||
<ProductForm onSuccess={() => router.push('/admin/products')} />
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
0
examples/store/app/components/.keep
Normal file
0
examples/store/app/components/.keep
Normal file
19
examples/store/app/components/ErrorBoundary.tsx
Normal file
19
examples/store/app/components/ErrorBoundary.tsx
Normal file
@@ -0,0 +1,19 @@
|
||||
import React from 'react'
|
||||
|
||||
export default class ErrorBoundary extends React.Component<{fallback: (error: any) => React.ReactNode}> {
|
||||
state = {hasError: false, error: null}
|
||||
|
||||
static getDerivedStateFromError(error: any) {
|
||||
return {
|
||||
hasError: true,
|
||||
error,
|
||||
}
|
||||
}
|
||||
|
||||
render() {
|
||||
if (this.state.hasError) {
|
||||
return this.props.fallback(this.state.error)
|
||||
}
|
||||
return this.props.children
|
||||
}
|
||||
}
|
||||
0
examples/store/app/layouts/.keep
Normal file
0
examples/store/app/layouts/.keep
Normal file
15
examples/store/app/pages/_app.tsx
Normal file
15
examples/store/app/pages/_app.tsx
Normal file
@@ -0,0 +1,15 @@
|
||||
import ErrorBoundary from 'app/components/ErrorBoundary'
|
||||
|
||||
export default function MyApp({Component, pageProps}) {
|
||||
return (
|
||||
<ErrorBoundary
|
||||
fallback={(error) => (
|
||||
<div>
|
||||
<h1>Unhandled Error</h1>
|
||||
<pre>{JSON.stringify(error, null, 2)}</pre>
|
||||
</div>
|
||||
)}>
|
||||
<Component {...pageProps} />
|
||||
</ErrorBoundary>
|
||||
)
|
||||
}
|
||||
22
examples/store/app/pages/_document.tsx
Normal file
22
examples/store/app/pages/_document.tsx
Normal file
@@ -0,0 +1,22 @@
|
||||
import {Document, Html, DocumentHead, Main, NextScript, DocumentContext} from '@blitzjs/core'
|
||||
|
||||
class MyDocument extends Document {
|
||||
static async getInitialProps(ctx: DocumentContext) {
|
||||
const initialProps = await Document.getInitialProps(ctx)
|
||||
return {...initialProps}
|
||||
}
|
||||
|
||||
render() {
|
||||
return (
|
||||
<Html lang="en">
|
||||
<DocumentHead />
|
||||
<body>
|
||||
<Main />
|
||||
<NextScript />
|
||||
</body>
|
||||
</Html>
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export default MyDocument
|
||||
173
examples/store/app/pages/index.tsx
Normal file
173
examples/store/app/pages/index.tsx
Normal file
@@ -0,0 +1,173 @@
|
||||
import {Head, Link} from 'blitz'
|
||||
|
||||
const Home = () => (
|
||||
<div className="container">
|
||||
<Head>
|
||||
<title>Blitz Example Store</title>
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
</Head>
|
||||
|
||||
<main>
|
||||
<h1 className="title" style={{marginBottom: 24}}>
|
||||
Blitz Store Example
|
||||
</h1>
|
||||
<p>
|
||||
<Link href="/products">
|
||||
<a>View Static Public Product Listings</a>
|
||||
</Link>
|
||||
</p>
|
||||
<p>
|
||||
<Link href="/admin">
|
||||
<a>View Dynamic Admin Section</a>
|
||||
</Link>
|
||||
</p>
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<a
|
||||
href="https://blitzjs.com?utm_source=blitz-new&utm_medium=app-template&utm_campaign=blitz-new"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer">
|
||||
Powered by Blitz.js
|
||||
</a>
|
||||
</footer>
|
||||
|
||||
<style jsx>{`
|
||||
.container {
|
||||
min-height: 100vh;
|
||||
padding: 0 0.5rem;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
main {
|
||||
padding: 5rem 0;
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
footer {
|
||||
width: 100%;
|
||||
height: 100px;
|
||||
border-top: 1px solid #eaeaea;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
footer img {
|
||||
margin-left: 0.5rem;
|
||||
}
|
||||
|
||||
footer a {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #0070f3;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.title a:hover,
|
||||
.title a:focus,
|
||||
.title a:active {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.title {
|
||||
margin: 0;
|
||||
line-height: 1.15;
|
||||
font-size: 4rem;
|
||||
}
|
||||
|
||||
.title,
|
||||
.description {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.description {
|
||||
line-height: 1.5;
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
|
||||
code {
|
||||
background: #fafafa;
|
||||
border-radius: 5px;
|
||||
padding: 0.75rem;
|
||||
font-size: 1.1rem;
|
||||
font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
|
||||
Bitstream Vera Sans Mono, Courier New, monospace;
|
||||
}
|
||||
|
||||
.grid {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
flex-wrap: wrap;
|
||||
|
||||
max-width: 800px;
|
||||
margin-top: 3rem;
|
||||
}
|
||||
|
||||
.card {
|
||||
margin: 1rem;
|
||||
flex-basis: 45%;
|
||||
padding: 1.5rem;
|
||||
text-align: left;
|
||||
color: inherit;
|
||||
text-decoration: none;
|
||||
border: 1px solid #eaeaea;
|
||||
border-radius: 10px;
|
||||
transition: color 0.15s ease, border-color 0.15s ease;
|
||||
}
|
||||
|
||||
.card:hover,
|
||||
.card:focus,
|
||||
.card:active {
|
||||
color: #0070f3;
|
||||
border-color: #0070f3;
|
||||
}
|
||||
|
||||
.card h3 {
|
||||
margin: 0 0 1rem 0;
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
|
||||
.card p {
|
||||
margin: 0;
|
||||
font-size: 1.25rem;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
@media (max-width: 600px) {
|
||||
.grid {
|
||||
width: 100%;
|
||||
flex-direction: column;
|
||||
}
|
||||
}
|
||||
`}</style>
|
||||
|
||||
<style jsx global>{`
|
||||
html,
|
||||
body {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,
|
||||
Droid Sans, Helvetica Neue, sans-serif;
|
||||
}
|
||||
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
`}</style>
|
||||
</div>
|
||||
)
|
||||
|
||||
export default Home
|
||||
74
examples/store/app/products/components/ProductForm.tsx
Normal file
74
examples/store/app/products/components/ProductForm.tsx
Normal file
@@ -0,0 +1,74 @@
|
||||
import {Form, Field} from 'react-final-form'
|
||||
import {Product, ProductCreateInput, ProductUpdateInput} from 'db'
|
||||
import createProduct from 'app/products/mutations/createProduct'
|
||||
import updateProduct from 'app/products/mutations/updateProduct'
|
||||
|
||||
type ProductInput = ProductCreateInput | ProductUpdateInput
|
||||
|
||||
function isNew(product: ProductInput): product is ProductCreateInput {
|
||||
return (product as ProductUpdateInput).id === undefined
|
||||
}
|
||||
|
||||
type ProductFormProps = {
|
||||
product?: ProductUpdateInput
|
||||
style?: React.CSSProperties
|
||||
onSuccess: (product: Product) => any
|
||||
}
|
||||
|
||||
export default function ({product, style, onSuccess, ...props}: ProductFormProps) {
|
||||
return (
|
||||
<Form
|
||||
initialValues={product || {name: null, handle: null, description: null, price: null}}
|
||||
onSubmit={async (data: ProductInput) => {
|
||||
if (isNew(data)) {
|
||||
try {
|
||||
const product = await createProduct({data})
|
||||
onSuccess(product)
|
||||
} catch (error) {
|
||||
alert('Error creating product ' + JSON.stringify(error, null, 2))
|
||||
}
|
||||
} else {
|
||||
try {
|
||||
const product = await updateProduct({where: {id: data.id}, data})
|
||||
onSuccess(product)
|
||||
} catch (error) {
|
||||
alert('Error updating product ' + JSON.stringify(error, null, 2))
|
||||
}
|
||||
}
|
||||
}}
|
||||
render={({handleSubmit}) => (
|
||||
<form onSubmit={handleSubmit} style={{maxWidth: 400, ...style}} {...props}>
|
||||
<div style={{marginBottom: 16}}>
|
||||
<label style={{display: 'flex', flexDirection: 'column'}}>
|
||||
Product Name
|
||||
<Field name="name" component="input" />
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<div style={{marginBottom: 16}}>
|
||||
<label style={{display: 'flex', flexDirection: 'column'}}>
|
||||
Handle
|
||||
<Field name="handle" component="input" />
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<div style={{marginBottom: 16}}>
|
||||
<label style={{display: 'flex', flexDirection: 'column'}}>
|
||||
Description
|
||||
<Field name="description" component="textarea" />
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<div style={{marginBottom: 16}}>
|
||||
<label style={{display: 'flex', flexDirection: 'column'}}>
|
||||
Price
|
||||
<Field name="price" component="input" parse={(value) => (value ? parseInt(value) : null)} />
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<button>{product ? 'Update' : 'Create'} Product</button>
|
||||
</form>
|
||||
)}
|
||||
/>
|
||||
)
|
||||
}
|
||||
7
examples/store/app/products/mutations/createProduct.ts
Normal file
7
examples/store/app/products/mutations/createProduct.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import db, {ProductCreateArgs} from 'db'
|
||||
|
||||
export default async function createProduct(args: ProductCreateArgs) {
|
||||
const product = await db.product.create(args)
|
||||
|
||||
return product
|
||||
}
|
||||
7
examples/store/app/products/mutations/deleteProduct.ts
Normal file
7
examples/store/app/products/mutations/deleteProduct.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import db, {ProductDeleteArgs} from 'db'
|
||||
|
||||
export default async function deleteProduct(args: ProductDeleteArgs) {
|
||||
const product = await db.product.delete(args)
|
||||
|
||||
return product
|
||||
}
|
||||
10
examples/store/app/products/mutations/updateProduct.ts
Normal file
10
examples/store/app/products/mutations/updateProduct.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import db, {ProductUpdateArgs} from 'db'
|
||||
|
||||
export default async function updateProduct(args: ProductUpdateArgs) {
|
||||
// Don't allow updating ID
|
||||
delete args.data.id
|
||||
|
||||
const product = await db.product.update(args)
|
||||
|
||||
return product
|
||||
}
|
||||
44
examples/store/app/products/pages/products/[handle].tsx
Normal file
44
examples/store/app/products/pages/products/[handle].tsx
Normal file
@@ -0,0 +1,44 @@
|
||||
import {Link, BlitzPage, GetStaticProps, GetStaticPaths} from 'blitz'
|
||||
import getProduct from 'app/products/queries/getProduct'
|
||||
import getProducts from 'app/products/queries/getProducts'
|
||||
import {Product} from 'db'
|
||||
|
||||
type StaticProps = {
|
||||
product: Product
|
||||
}
|
||||
|
||||
export const getStaticProps: GetStaticProps<StaticProps> = async (ctx) => {
|
||||
const product = await getProduct({where: {handle: ctx.params.handle as string}})
|
||||
|
||||
return {
|
||||
props: {product},
|
||||
// Unstable beacuse revalidate is still under RFC: https://nextjs.link/issg
|
||||
unstable_revalidate: 1,
|
||||
}
|
||||
}
|
||||
export const getStaticPaths: GetStaticPaths = async () => {
|
||||
const paths = (await getProducts()).map(({handle}) => ({params: {handle}}))
|
||||
return {
|
||||
paths,
|
||||
fallback: true,
|
||||
}
|
||||
}
|
||||
|
||||
const Page: BlitzPage<StaticProps> = function ({product}) {
|
||||
if (!product) {
|
||||
return <div>Building Page...</div>
|
||||
}
|
||||
|
||||
return (
|
||||
<div>
|
||||
<h1>{product.name}</h1>
|
||||
<p>{product.description}</p>
|
||||
<p>Price: ${product.price}</p>
|
||||
|
||||
<Link href="/products">
|
||||
<a>All Products</a>
|
||||
</Link>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
export default Page
|
||||
35
examples/store/app/products/pages/products/index.tsx
Normal file
35
examples/store/app/products/pages/products/index.tsx
Normal file
@@ -0,0 +1,35 @@
|
||||
import {Link, BlitzPage, GetStaticProps} from 'blitz'
|
||||
import getProducts from 'app/products/queries/getProducts'
|
||||
import {Product} from 'db'
|
||||
|
||||
type StaticProps = {
|
||||
products: Product[]
|
||||
}
|
||||
|
||||
export const getStaticProps: GetStaticProps<StaticProps> = async () => {
|
||||
const products = await getProducts()
|
||||
|
||||
return {
|
||||
props: {products},
|
||||
// Unstable beacuse revalidate is still under RFC: https://nextjs.link/issg
|
||||
unstable_revalidate: 1,
|
||||
}
|
||||
}
|
||||
|
||||
const Page: BlitzPage<StaticProps> = function ({products}) {
|
||||
return (
|
||||
<div>
|
||||
<h1>Products</h1>
|
||||
<div>
|
||||
{products.map((product) => (
|
||||
<p key={product.id}>
|
||||
<Link href="/products/[handle]" as={`/products/${product.handle}`}>
|
||||
<a>{product.name}</a>
|
||||
</Link>
|
||||
</p>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
export default Page
|
||||
33
examples/store/app/products/pages/products/ssr.tsx
Normal file
33
examples/store/app/products/pages/products/ssr.tsx
Normal file
@@ -0,0 +1,33 @@
|
||||
import {Link, BlitzPage, GetServerSideProps, ssrQuery} from '@blitzjs/core'
|
||||
import getProducts from 'app/products/queries/getProducts'
|
||||
import {Product} from 'db'
|
||||
|
||||
type PageProps = {
|
||||
products: Product[]
|
||||
}
|
||||
|
||||
export const getServerSideProps: GetServerSideProps<PageProps> = async ({req, res}) => {
|
||||
const products = await ssrQuery(getProducts, undefined, {req, res})
|
||||
|
||||
return {
|
||||
props: {products},
|
||||
}
|
||||
}
|
||||
|
||||
const Page: BlitzPage<PageProps> = function ({products}) {
|
||||
return (
|
||||
<div>
|
||||
<h1>Products</h1>
|
||||
<div>
|
||||
{products.map((product) => (
|
||||
<p key={product.id}>
|
||||
<Link href="/products/[handle]" as={`/products/${product.handle}`}>
|
||||
<a>{product.name}</a>
|
||||
</Link>
|
||||
</p>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
export default Page
|
||||
7
examples/store/app/products/queries/getProduct.ts
Normal file
7
examples/store/app/products/queries/getProduct.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import db, {FindOneProductArgs} from 'db'
|
||||
|
||||
export default async function getProduct(args: FindOneProductArgs) {
|
||||
const product = await db.product.findOne(args)
|
||||
|
||||
return product
|
||||
}
|
||||
7
examples/store/app/products/queries/getProducts.ts
Normal file
7
examples/store/app/products/queries/getProducts.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import db, {FindManyProductArgs} from 'db'
|
||||
|
||||
export default async function getProducts(args?: FindManyProductArgs) {
|
||||
const products = await db.product.findMany(args)
|
||||
|
||||
return products
|
||||
}
|
||||
13
examples/store/blitz.config.js
Normal file
13
examples/store/blitz.config.js
Normal file
@@ -0,0 +1,13 @@
|
||||
module.exports = {
|
||||
webpack: (config, {buildId, dev, isServer, defaultLoaders, webpack}) => {
|
||||
// Note: we provide webpack above so you should not `require` it
|
||||
// Perform customizations to webpack config
|
||||
// Important: return the modified config
|
||||
return config
|
||||
},
|
||||
webpackDevMiddleware: (config) => {
|
||||
// Perform customizations to webpack dev middleware config
|
||||
// Important: return the modified config
|
||||
return config
|
||||
},
|
||||
}
|
||||
6
examples/store/db/index.ts
Normal file
6
examples/store/db/index.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
import {PrismaClient} from '@prisma/client'
|
||||
export * from '@prisma/client'
|
||||
|
||||
const prisma = new PrismaClient()
|
||||
|
||||
export default prisma
|
||||
0
examples/store/db/migrations/.keep
Normal file
0
examples/store/db/migrations/.keep
Normal file
72
examples/store/db/migrations/20200414170933-init/README.md
Normal file
72
examples/store/db/migrations/20200414170933-init/README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Migration `20200414170933-init`
|
||||
|
||||
This migration has been generated by Brandon Bayer at 4/14/2020, 5:09:33 PM.
|
||||
You can check out the [state of the schema](./schema.prisma) after the migration.
|
||||
|
||||
## Database Steps
|
||||
|
||||
```sql
|
||||
CREATE TABLE "public"."User" (
|
||||
"email" text NOT NULL ,
|
||||
"id" SERIAL,
|
||||
"name" text ,
|
||||
"role" text ,
|
||||
"storeId" integer ,
|
||||
PRIMARY KEY ("id")
|
||||
)
|
||||
|
||||
CREATE TABLE "public"."Product" (
|
||||
"description" text ,
|
||||
"handle" text NOT NULL ,
|
||||
"id" SERIAL,
|
||||
"name" text ,
|
||||
"price" integer ,
|
||||
PRIMARY KEY ("id")
|
||||
)
|
||||
|
||||
CREATE UNIQUE INDEX "User.email" ON "public"."User"("email")
|
||||
|
||||
CREATE UNIQUE INDEX "Product.handle" ON "public"."Product"("handle")
|
||||
```
|
||||
|
||||
## Changes
|
||||
|
||||
```diff
|
||||
diff --git schema.prisma schema.prisma
|
||||
migration ..20200414170933-init
|
||||
--- datamodel.dml
|
||||
+++ datamodel.dml
|
||||
@@ -1,0 +1,30 @@
|
||||
+// This is your Prisma schema file,
|
||||
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
|
||||
+
|
||||
+datasource postgresql {
|
||||
+ provider = "postgresql"
|
||||
+ url = env("DATABASE_URL")
|
||||
+}
|
||||
+
|
||||
+generator client {
|
||||
+ provider = "prisma-client-js"
|
||||
+}
|
||||
+
|
||||
+
|
||||
+// --------------------------------------
|
||||
+
|
||||
+model User {
|
||||
+ id Int @default(autoincrement()) @id
|
||||
+ email String @unique
|
||||
+ name String?
|
||||
+ role String?
|
||||
+ storeId Int?
|
||||
+}
|
||||
+
|
||||
+model Product {
|
||||
+ id Int @default(autoincrement()) @id
|
||||
+ handle String @unique
|
||||
+ name String?
|
||||
+ description String?
|
||||
+ price Int?
|
||||
+}
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
// This is your Prisma schema file,
|
||||
// learn more about it in the docs: https://pris.ly/d/prisma-schema
|
||||
|
||||
datasource postgresql {
|
||||
provider = "postgresql"
|
||||
url = "***"
|
||||
}
|
||||
|
||||
generator client {
|
||||
provider = "prisma-client-js"
|
||||
}
|
||||
|
||||
|
||||
// --------------------------------------
|
||||
|
||||
model User {
|
||||
id Int @default(autoincrement()) @id
|
||||
email String @unique
|
||||
name String?
|
||||
role String?
|
||||
storeId Int?
|
||||
}
|
||||
|
||||
model Product {
|
||||
id Int @default(autoincrement()) @id
|
||||
handle String @unique
|
||||
name String?
|
||||
description String?
|
||||
price Int?
|
||||
}
|
||||
199
examples/store/db/migrations/20200414170933-init/steps.json
Normal file
199
examples/store/db/migrations/20200414170933-init/steps.json
Normal file
@@ -0,0 +1,199 @@
|
||||
{
|
||||
"version": "0.3.14-fixed",
|
||||
"steps": [
|
||||
{
|
||||
"tag": "CreateSource",
|
||||
"source": "postgresql"
|
||||
},
|
||||
{
|
||||
"tag": "CreateArgument",
|
||||
"location": {
|
||||
"tag": "Source",
|
||||
"source": "postgresql"
|
||||
},
|
||||
"argument": "provider",
|
||||
"value": "\"postgresql\""
|
||||
},
|
||||
{
|
||||
"tag": "CreateArgument",
|
||||
"location": {
|
||||
"tag": "Source",
|
||||
"source": "postgresql"
|
||||
},
|
||||
"argument": "url",
|
||||
"value": "env(\"DATABASE_URL\")"
|
||||
},
|
||||
{
|
||||
"tag": "CreateModel",
|
||||
"model": "User"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "User",
|
||||
"field": "id",
|
||||
"type": "Int",
|
||||
"arity": "Required"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "User",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "default"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateArgument",
|
||||
"location": {
|
||||
"tag": "Directive",
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "User",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "default"
|
||||
},
|
||||
"argument": "",
|
||||
"value": "autoincrement()"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "User",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "id"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "User",
|
||||
"field": "email",
|
||||
"type": "String",
|
||||
"arity": "Required"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "User",
|
||||
"field": "email"
|
||||
},
|
||||
"directive": "unique"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "User",
|
||||
"field": "name",
|
||||
"type": "String",
|
||||
"arity": "Optional"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "User",
|
||||
"field": "role",
|
||||
"type": "String",
|
||||
"arity": "Optional"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "User",
|
||||
"field": "storeId",
|
||||
"type": "Int",
|
||||
"arity": "Optional"
|
||||
},
|
||||
{
|
||||
"tag": "CreateModel",
|
||||
"model": "Product"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "Product",
|
||||
"field": "id",
|
||||
"type": "Int",
|
||||
"arity": "Required"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "Product",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "default"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateArgument",
|
||||
"location": {
|
||||
"tag": "Directive",
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "Product",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "default"
|
||||
},
|
||||
"argument": "",
|
||||
"value": "autoincrement()"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "Product",
|
||||
"field": "id"
|
||||
},
|
||||
"directive": "id"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "Product",
|
||||
"field": "handle",
|
||||
"type": "String",
|
||||
"arity": "Required"
|
||||
},
|
||||
{
|
||||
"tag": "CreateDirective",
|
||||
"location": {
|
||||
"path": {
|
||||
"tag": "Field",
|
||||
"model": "Product",
|
||||
"field": "handle"
|
||||
},
|
||||
"directive": "unique"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "Product",
|
||||
"field": "name",
|
||||
"type": "String",
|
||||
"arity": "Optional"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "Product",
|
||||
"field": "description",
|
||||
"type": "String",
|
||||
"arity": "Optional"
|
||||
},
|
||||
{
|
||||
"tag": "CreateField",
|
||||
"model": "Product",
|
||||
"field": "price",
|
||||
"type": "Int",
|
||||
"arity": "Optional"
|
||||
}
|
||||
]
|
||||
}
|
||||
6
examples/store/db/migrations/migrate.lock
Normal file
6
examples/store/db/migrations/migrate.lock
Normal file
@@ -0,0 +1,6 @@
|
||||
# IF THERE'S A GIT CONFLICT IN THIS FILE, DON'T SOLVE IT MANUALLY!
|
||||
# INSTEAD EXECUTE `prisma migrate fix`
|
||||
# Prisma Migrate lockfile v1
|
||||
# Read more about conflict resolution here: TODO
|
||||
|
||||
20200414170933-init
|
||||
30
examples/store/db/schema.prisma
Normal file
30
examples/store/db/schema.prisma
Normal file
@@ -0,0 +1,30 @@
|
||||
// This is your Prisma schema file,
|
||||
// learn more about it in the docs: https://pris.ly/d/prisma-schema
|
||||
|
||||
datasource postgresql {
|
||||
provider = "postgresql"
|
||||
url = env("DATABASE_URL")
|
||||
}
|
||||
|
||||
generator client {
|
||||
provider = "prisma-client-js"
|
||||
}
|
||||
|
||||
|
||||
// --------------------------------------
|
||||
|
||||
model User {
|
||||
id Int @default(autoincrement()) @id
|
||||
email String @unique
|
||||
name String?
|
||||
role String?
|
||||
storeId Int?
|
||||
}
|
||||
|
||||
model Product {
|
||||
id Int @default(autoincrement()) @id
|
||||
handle String @unique
|
||||
name String?
|
||||
description String?
|
||||
price Int?
|
||||
}
|
||||
0
examples/store/integrations/.keep
Normal file
0
examples/store/integrations/.keep
Normal file
0
examples/store/jobs/.keep
Normal file
0
examples/store/jobs/.keep
Normal file
10
examples/store/now.json
Normal file
10
examples/store/now.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"env": {
|
||||
"DATABASE_URL": "@store-example-db"
|
||||
},
|
||||
"build": {
|
||||
"env": {
|
||||
"DATABASE_URL": "@store-example-db"
|
||||
}
|
||||
}
|
||||
}
|
||||
23
examples/store/package.json
Normal file
23
examples/store/package.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"name": "store",
|
||||
"version": "0.6.1",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "blitz db migrate && blitz build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@prisma/cli": "2.0.0-beta.2",
|
||||
"@prisma/client": "2.0.0-beta.2",
|
||||
"blitz": "0.6.1",
|
||||
"final-form": "4.19.1",
|
||||
"react": "0.0.0-experimental-e5d06e34b",
|
||||
"react-dom": "0.0.0-experimental-e5d06e34b",
|
||||
"react-final-form": "6.4.0",
|
||||
"typescript": "3.8.3"
|
||||
},
|
||||
"NOTE": "Next.js dependency is currently only required for deploying to zeit",
|
||||
"devDependencies": {
|
||||
"@types/react": "16.9.34",
|
||||
"next": "9.3.5"
|
||||
}
|
||||
}
|
||||
BIN
examples/store/public/favicon.ico
Executable file
BIN
examples/store/public/favicon.ico
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 556 B |
BIN
examples/store/public/logo.png
Normal file
BIN
examples/store/public/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
10
examples/store/public/zeit.svg
Normal file
10
examples/store/public/zeit.svg
Normal file
@@ -0,0 +1,10 @@
|
||||
<svg width="82" height="16" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill="url(#prefix__paint0_linear)" d="M9.018 0l9.019 16H0L9.018 0z"/>
|
||||
<path fill="#333" fill-rule="evenodd" d="M51.634 12.028h-6.492V2.052h6.492v1.256H46.61v3.007h4.37V7.57h-4.37v3.202h5.024v1.255zm-14.063 0h-7.235v-1.096l5.342-7.624h-5.253V2.052h7.058v1.097l-5.342 7.623h5.43v1.256zm21.88 0h6.333v-1.256h-2.423V3.308h2.423V2.052h-6.332v1.256h2.441v7.465h-2.441v1.255zm18.22 0h-1.468v-8.72h-3.36V2.052h8.225v1.256H77.67v8.72z" clip-rule="evenodd"/>
|
||||
<defs>
|
||||
<linearGradient id="prefix__paint0_linear" x1="28.022" x2="16.189" y1="22.991" y2="8.569" gradientUnits="userSpaceOnUse">
|
||||
<stop stop-color="#fff"/>
|
||||
<stop offset="1"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 794 B |
20
examples/store/tsconfig.json
Normal file
20
examples/store/tsconfig.json
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"baseUrl": "./",
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": false,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"noEmit": true,
|
||||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "node",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "preserve"
|
||||
},
|
||||
"exclude": ["node_modules"],
|
||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"]
|
||||
}
|
||||
0
examples/store/utils/.keep
Normal file
0
examples/store/utils/.keep
Normal file
16
lerna.json
Normal file
16
lerna.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"version": "0.6.1",
|
||||
"packages": ["packages/*"],
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true,
|
||||
"command": {
|
||||
"version": {
|
||||
"exact": true
|
||||
},
|
||||
"publish": {
|
||||
"npmClient": "npm",
|
||||
"allowBranch": ["master", "canary"],
|
||||
"registry": "https://registry.npmjs.org/"
|
||||
}
|
||||
}
|
||||
}
|
||||
98
package.json
Normal file
98
package.json
Normal file
@@ -0,0 +1,98 @@
|
||||
{
|
||||
"name": "root",
|
||||
"private": true,
|
||||
"workspaces": {
|
||||
"packages": [
|
||||
"packages/*",
|
||||
"examples/*"
|
||||
],
|
||||
"nohoist": [
|
||||
"**/@prisma",
|
||||
"**/@prisma/**"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"yarn": "^1.19.1",
|
||||
"node": ">= 10.13.0"
|
||||
},
|
||||
"scripts": {
|
||||
"postinstall": "npm rebuild husky",
|
||||
"dev": "lerna run dev --no-private --stream --parallel",
|
||||
"link-cli": "yarn global remove blitz && yarn workspace blitz link",
|
||||
"unlink-cli": "yarn workspace blitz unlink",
|
||||
"build": "lerna run build --no-private --stream",
|
||||
"test": "yarn run build && yarn run testonly",
|
||||
"testonly": "lerna run test --parallel",
|
||||
"prepublishOnly": "yarn run reset && yarn run test",
|
||||
"prepack": "cpy README.md packages/blitz/",
|
||||
"postpack": "rimraf packages/blitz/README.md",
|
||||
"reset": "rimraf node_modules && git clean -xfd packages && yarn",
|
||||
"publish-canary": "lerna publish --preid canary --pre-dist-tag canary --no-push && yarn run danger:push-all && release --pre",
|
||||
"publish-latest": "lerna publish ---no-push --force-publish && yarn run danger:push-all && release",
|
||||
"danger:push-all": "git push --no-verify && git push --no-verify --tags"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@testing-library/jest-dom": "5.5.0",
|
||||
"@testing-library/react": "10.0.3",
|
||||
"@types/cross-spawn": "^6.0.1",
|
||||
"@types/debug": "^4.1.5",
|
||||
"@types/diff": "^4.0.2",
|
||||
"@types/from2": "^2.3.0",
|
||||
"@types/fs-extra": "^8.1.0",
|
||||
"@types/fs-readdir-recursive": "1.0.0",
|
||||
"@types/gulp-if": "^0.0.33",
|
||||
"@types/jest": "^25.1.3",
|
||||
"@types/mem-fs": "^1.1.2",
|
||||
"@types/mem-fs-editor": "^5.1.1",
|
||||
"@types/merge-stream": "^1.1.2",
|
||||
"@types/node": "^13.7.4",
|
||||
"@types/node-fetch": "^2.5.6",
|
||||
"@types/parallel-transform": "^1.1.0",
|
||||
"@types/path-is-absolute": "^1.0.0",
|
||||
"@types/pumpify": "^1.4.1",
|
||||
"@types/react": "16.9.34",
|
||||
"@types/readable-stream": "^2.3.5",
|
||||
"@types/through2": "^2.0.34",
|
||||
"@types/vinyl": "^2.0.4",
|
||||
"@types/vinyl-fs": "^2.4.11",
|
||||
"@wessberg/cjs-to-esm-transformer": "^0.0.19",
|
||||
"@wessberg/rollup-plugin-ts": "^1.2.24",
|
||||
"cpy-cli": "^3.1.0",
|
||||
"cross-env": "^7.0.0",
|
||||
"debug": "^4.1.1",
|
||||
"directory-tree": "^2.2.4",
|
||||
"husky": "^4.2.3",
|
||||
"jest": "24.9.0",
|
||||
"lerna": "^3.20.2",
|
||||
"lint-staged": "^10.0.8",
|
||||
"next": "^9.3.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"prettier": "^2.0.4",
|
||||
"pretty-quick": "2.0.1",
|
||||
"prompt": "^1.0.0",
|
||||
"release": "6.1.0",
|
||||
"rimraf": "3.0.2",
|
||||
"rollup": "^2.6.1",
|
||||
"rollup-plugin-commonjs": "^10.1.0",
|
||||
"rollup-plugin-json": "^4.0.0",
|
||||
"rollup-plugin-node-polyfills": "^0.2.1",
|
||||
"rollup-plugin-node-resolve": "^5.2.0",
|
||||
"rollup-plugin-peer-deps-external": "^2.2.2",
|
||||
"semver": "^7.3.2",
|
||||
"ts-jest": "24.3.0",
|
||||
"tsdx": "^0.13.1",
|
||||
"tslib": "^1.11.1",
|
||||
"typescript": "^3.8.3",
|
||||
"wait-on": "4.0.2"
|
||||
},
|
||||
"husky": {
|
||||
"hooks": {
|
||||
"pre-commit": "pretty-quick --staged",
|
||||
"pre-push": "yarn test"
|
||||
}
|
||||
},
|
||||
"resolutions": {
|
||||
"jest": "24.9.0",
|
||||
"ts-jest": "24.3.0"
|
||||
}
|
||||
}
|
||||
8
packages/blitz/.gitignore
vendored
Normal file
8
packages/blitz/.gitignore
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
*.log
|
||||
.DS_Store
|
||||
node_modules
|
||||
.rts2_cache_cjs
|
||||
.rts2_cache_esm
|
||||
.rts2_cache_umd
|
||||
.rts2_cache_system
|
||||
dist
|
||||
3
packages/blitz/bin/blitz
Executable file
3
packages/blitz/bin/blitz
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env node --experimental-repl-await
|
||||
|
||||
require('../dist/cli')
|
||||
1
packages/blitz/jest.setup.js
Normal file
1
packages/blitz/jest.setup.js
Normal file
@@ -0,0 +1 @@
|
||||
require('@testing-library/jest-dom')
|
||||
69
packages/blitz/package.json
Normal file
69
packages/blitz/package.json
Normal file
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"name": "blitz",
|
||||
"description": "Rails-like framework for monolithic, full-stack React apps without an API",
|
||||
"version": "0.6.1",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"predev": "wait-on -d 500 ../core/dist/packages/core/src/index.d.ts && wait-on ../server/dist/packages/server/src/index.d.ts",
|
||||
"dev": "rollup -c rollup.config.js --watch",
|
||||
"build": "rollup -c rollup.config.js"
|
||||
},
|
||||
"author": {
|
||||
"name": "Brandon Bayer",
|
||||
"email": "b@bayer.ws",
|
||||
"url": "https://twitter.com/flybayer"
|
||||
},
|
||||
"bin": {
|
||||
"blitz": "./bin/blitz"
|
||||
},
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/blitz.esm.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"husky": {
|
||||
"hooks": {}
|
||||
},
|
||||
"jest": {
|
||||
"setupFilesAfterEnv": [
|
||||
"<rootDir>/jest.setup.js"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 10.13.0"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/blitz-js/blitz"
|
||||
},
|
||||
"dependencies": {
|
||||
"@blitzjs/cli": "0.6.1",
|
||||
"@blitzjs/core": "0.6.1",
|
||||
"@blitzjs/server": "0.6.1",
|
||||
"os-name": "3.1.0",
|
||||
"pkg-dir": "4.2.0",
|
||||
"resolve-from": "5.0.0",
|
||||
"resolve-global": "1.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^25.1.3",
|
||||
"@types/node": "^13.7.4",
|
||||
"cross-env": "^7.0.0",
|
||||
"husky": "^4.2.3",
|
||||
"lint-staged": "^10.0.8",
|
||||
"ts-jest": "24.3.0"
|
||||
},
|
||||
"keywords": [
|
||||
"blitz",
|
||||
"blitzjs",
|
||||
"blitz.js",
|
||||
"next",
|
||||
"next.js",
|
||||
"react",
|
||||
"framework",
|
||||
"fullstack",
|
||||
"node"
|
||||
],
|
||||
"gitHead": "9c54cfaef19b63c30a7e41447541c7cc30b5c6d4"
|
||||
}
|
||||
56
packages/blitz/rollup.config.js
Normal file
56
packages/blitz/rollup.config.js
Normal file
@@ -0,0 +1,56 @@
|
||||
import pkg from './package.json'
|
||||
import typescript from '@wessberg/rollup-plugin-ts'
|
||||
import commonjs from 'rollup-plugin-commonjs'
|
||||
import external from 'rollup-plugin-peer-deps-external'
|
||||
import resolve from 'rollup-plugin-node-resolve'
|
||||
import json from 'rollup-plugin-json'
|
||||
|
||||
const common = {
|
||||
external: [
|
||||
...Object.keys(pkg.dependencies || {}),
|
||||
...Object.keys(pkg.peerDependencies || {}),
|
||||
'react',
|
||||
'react-dom',
|
||||
'next',
|
||||
'fs',
|
||||
'path',
|
||||
],
|
||||
plugins: [
|
||||
json(),
|
||||
external(),
|
||||
resolve({preferBuiltins: true}),
|
||||
typescript({
|
||||
transformers: [],
|
||||
}),
|
||||
commonjs({
|
||||
include: /node_modules/,
|
||||
namedExports: {},
|
||||
}),
|
||||
],
|
||||
}
|
||||
|
||||
const lib = {
|
||||
input: './src/index.ts',
|
||||
output: {
|
||||
file: pkg['main'],
|
||||
exports: 'named',
|
||||
sourcemap: 'true',
|
||||
format: 'cjs',
|
||||
},
|
||||
...common,
|
||||
}
|
||||
|
||||
const cli = {
|
||||
input: './src/bin/cli.ts',
|
||||
output: {
|
||||
file: './dist/cli.js',
|
||||
exports: 'named',
|
||||
sourcemap: 'true',
|
||||
format: 'cjs',
|
||||
},
|
||||
...common,
|
||||
}
|
||||
|
||||
const builds = [lib, cli]
|
||||
|
||||
export default builds
|
||||
81
packages/blitz/src/bin/cli.ts
Executable file
81
packages/blitz/src/bin/cli.ts
Executable file
@@ -0,0 +1,81 @@
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
const resolveGlobal = require('resolve-global')
|
||||
const resolveFrom = require('resolve-from')
|
||||
const pkgDir = require('pkg-dir')
|
||||
const chalk = require('chalk')
|
||||
|
||||
console.log(
|
||||
chalk.yellow(
|
||||
`You are using alpha software - if you have any problems, please open an issue here:
|
||||
https://github.com/blitz-js/blitz/issues/new/choose
|
||||
Also, this CLI may be slow as it's not yet optimized for speed\n`,
|
||||
),
|
||||
)
|
||||
|
||||
let usageType: 'local' | 'monorepo' | 'global' | 'global-linked'
|
||||
|
||||
const localCLIPkgPath = path.resolve(process.cwd(), 'node_modules', '@blitzjs/cli')
|
||||
const monorepoCLIPkgPath = path.resolve(process.cwd(), '../..', 'node_modules', '@blitzjs/cli')
|
||||
const globalCLIPkgPath = resolveFrom(__dirname, '@blitzjs/cli')
|
||||
const globalLinkedCLIPkgPath = path.resolve(pkgDir.sync(__dirname), '../cli')
|
||||
|
||||
function getBlitzPkgJsonPath() {
|
||||
switch (usageType) {
|
||||
case 'local':
|
||||
return path.join(process.cwd(), 'node_modules/blitz/package.json')
|
||||
case 'monorepo':
|
||||
return path.join(process.cwd(), '../../node_modules/blitz/package.json')
|
||||
case 'global':
|
||||
return path.join(resolveGlobal.silent('blitz') || '', 'package.json')
|
||||
case 'global-linked':
|
||||
return path.join(pkgDir.sync(__dirname), 'package.json')
|
||||
}
|
||||
}
|
||||
|
||||
let pkgPath
|
||||
if (fs.existsSync(localCLIPkgPath)) {
|
||||
usageType = 'local'
|
||||
pkgPath = localCLIPkgPath
|
||||
} else if (fs.existsSync(monorepoCLIPkgPath)) {
|
||||
usageType = 'monorepo'
|
||||
pkgPath = monorepoCLIPkgPath
|
||||
} else if (fs.existsSync(globalLinkedCLIPkgPath)) {
|
||||
usageType = 'global-linked'
|
||||
pkgPath = globalLinkedCLIPkgPath
|
||||
} else {
|
||||
usageType = 'global'
|
||||
pkgPath = globalCLIPkgPath
|
||||
}
|
||||
|
||||
const cli = require(pkgPath as string)
|
||||
|
||||
const options = require('minimist')(process.argv.slice(2))
|
||||
if (options._.length === 0 && (options.v || options.version)) {
|
||||
// TODO: remove
|
||||
console.log('debug:', usageType)
|
||||
console.log('debug: pkgPath:', pkgPath, '\n')
|
||||
try {
|
||||
const osName = require('os-name')
|
||||
console.log(`${osName()} ${process.platform}-${process.arch} node-${process.version}\n`)
|
||||
|
||||
let globalInstallPath
|
||||
let localButGlobalLinked = usageType === 'local' && fs.existsSync(globalLinkedCLIPkgPath)
|
||||
if (usageType === 'global-linked' || usageType === 'monorepo' || localButGlobalLinked) {
|
||||
globalInstallPath = pkgDir.sync(__dirname)
|
||||
} else {
|
||||
globalInstallPath = pkgDir.sync(resolveFrom(__dirname, 'blitz'))
|
||||
}
|
||||
const globalVersion = path.join(globalInstallPath, 'package.json')
|
||||
console.log(`blitz: ${require(globalVersion).version} (global)`)
|
||||
if (!usageType.includes('global')) {
|
||||
console.log(`blitz: ${require(getBlitzPkgJsonPath()).version} (local)`)
|
||||
}
|
||||
console.log('') // One last new line
|
||||
} catch (e) {
|
||||
console.log('blitz error', e)
|
||||
}
|
||||
process.exit(0)
|
||||
} else {
|
||||
cli.run()
|
||||
}
|
||||
1
packages/blitz/src/index.ts
Normal file
1
packages/blitz/src/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export * from '@blitzjs/core'
|
||||
1
packages/blitz/src/utils/index.ts
Normal file
1
packages/blitz/src/utils/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export const isServer = typeof window === 'undefined'
|
||||
3
packages/blitz/test/todo.test.ts
Normal file
3
packages/blitz/test/todo.test.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
it('todo', async () => {
|
||||
expect(true).toBe(true)
|
||||
})
|
||||
13
packages/blitz/tsconfig.json
Normal file
13
packages/blitz/tsconfig.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"include": ["src", "types", "test"],
|
||||
"exclude": ["node_modules"],
|
||||
"compilerOptions": {
|
||||
"baseUrl": "./",
|
||||
"declarationDir": "./dist",
|
||||
"downlevelIteration": true,
|
||||
"paths": {
|
||||
"*": ["src/*", "node_modules/*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
1
packages/blitz/types/index.d.ts
vendored
Normal file
1
packages/blitz/types/index.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
||||
//
|
||||
15
packages/cli/.gitignore
vendored
Normal file
15
packages/cli/.gitignore
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
*.log
|
||||
.DS_Store
|
||||
node_modules
|
||||
.rts2_cache_cjs
|
||||
.rts2_cache_esm
|
||||
.rts2_cache_umd
|
||||
.rts2_cache_system
|
||||
dist
|
||||
tmp
|
||||
.blitz
|
||||
|
||||
# good directory to use for testing app generation
|
||||
_app
|
||||
|
||||
!templates/**/.env
|
||||
3
packages/cli/bin/run
Executable file
3
packages/cli/bin/run
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env node --experimental-repl-await
|
||||
|
||||
require('@blitzjs/cli').run()
|
||||
3
packages/cli/bin/run.cmd
Normal file
3
packages/cli/bin/run.cmd
Normal file
@@ -0,0 +1,3 @@
|
||||
@echo off
|
||||
|
||||
node "%~dp0\run" %*
|
||||
26
packages/cli/jest.config.js
Normal file
26
packages/cli/jest.config.js
Normal file
@@ -0,0 +1,26 @@
|
||||
module.exports = {
|
||||
preset: 'ts-jest',
|
||||
testEnvironment: 'node',
|
||||
moduleFileExtensions: ['ts', 'js', 'json'],
|
||||
coverageReporters: ['json', 'lcov', 'text', 'clover'],
|
||||
// collectCoverage: !!`Boolean(process.env.CI)`,
|
||||
collectCoverageFrom: ['src/**/*.ts'],
|
||||
coveragePathIgnorePatterns: ['/templates/'],
|
||||
modulePathIgnorePatterns: ['tmp', 'lib'],
|
||||
testPathIgnorePatterns: ['src/commands/test.ts'],
|
||||
// TODO enable threshold
|
||||
// coverageThreshold: {
|
||||
// global: {
|
||||
// branches: 100,
|
||||
// functions: 100,
|
||||
// lines: 100,
|
||||
// statements: 100,
|
||||
// },
|
||||
// },
|
||||
|
||||
globals: {
|
||||
'ts-jest': {
|
||||
tsConfig: 'test/tsconfig.json',
|
||||
},
|
||||
},
|
||||
}
|
||||
80
packages/cli/package.json
Normal file
80
packages/cli/package.json
Normal file
@@ -0,0 +1,80 @@
|
||||
{
|
||||
"name": "@blitzjs/cli",
|
||||
"description": "Blitz.js CLI",
|
||||
"version": "0.6.1",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"b": "./bin/run",
|
||||
"predev": "wait-on -d 500 ../server/dist/packages/server/src/index.d.ts",
|
||||
"dev": "rimraf lib && yarn build:templates && tsc --watch --preserveWatchOutput",
|
||||
"build": "rimraf lib && tsc && yarn build:templates",
|
||||
"build:templates": "rimraf templates/**/node_modules && cpy --dot --parents '!/node_modules/' templates lib",
|
||||
"test": "jest || jest",
|
||||
"test:watch": "jest --watch"
|
||||
},
|
||||
"author": {
|
||||
"name": "Brandon Bayer",
|
||||
"email": "b@bayer.ws",
|
||||
"url": "https://twitter.com/flybayer"
|
||||
},
|
||||
"main": "lib/src/index.js",
|
||||
"bin": {
|
||||
"blitz": "./bin/run"
|
||||
},
|
||||
"files": [
|
||||
"/bin",
|
||||
"/lib"
|
||||
],
|
||||
"dependencies": {
|
||||
"@oclif/command": "^1.5.20",
|
||||
"@oclif/config": "^1.15.1",
|
||||
"@oclif/plugin-help": "^2.2.3",
|
||||
"@oclif/plugin-not-found": "^1.2.3",
|
||||
"camelcase": "6.0.0",
|
||||
"chalk": "^4.0.0",
|
||||
"chokidar": "^3.3.1",
|
||||
"cross-spawn": "^7.0.2",
|
||||
"diff": "^4.0.2",
|
||||
"dotenv": "8.2.0",
|
||||
"enquirer": "^2.3.4",
|
||||
"fs-extra": "^9.0.0",
|
||||
"fs-readdir-recursive": "1.1.0",
|
||||
"globby": "11.0.0",
|
||||
"has-yarn": "^2.1.0",
|
||||
"hasbin": "1.2.3",
|
||||
"mem-fs": "^1.1.3",
|
||||
"mem-fs-editor": "^6.0.0",
|
||||
"minimist": "^1.2.5",
|
||||
"node-fetch": "^2.6.0",
|
||||
"pkg-dir": "4.2.0",
|
||||
"pluralize": "^8.0.0",
|
||||
"ts-node": "8.9.0",
|
||||
"tsconfig-paths": "3.9.0",
|
||||
"username": "5.1.0",
|
||||
"vinyl": "^2.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@blitzjs/server": "0.6.1",
|
||||
"@oclif/dev-cli": "^1.22.2",
|
||||
"@oclif/test": "^1.2.5",
|
||||
"@prisma/cli": "2.0.0-beta.2",
|
||||
"@types/pluralize": "^0.0.29"
|
||||
},
|
||||
"oclif": {
|
||||
"commands": "./lib/src/commands",
|
||||
"bin": "blitz",
|
||||
"plugins": [
|
||||
"@oclif/plugin-help",
|
||||
"@oclif/plugin-not-found"
|
||||
]
|
||||
},
|
||||
"keywords": [
|
||||
"blitz",
|
||||
"cli"
|
||||
],
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/blitz-js/blitz"
|
||||
},
|
||||
"gitHead": "9c54cfaef19b63c30a7e41447541c7cc30b5c6d4"
|
||||
}
|
||||
8
packages/cli/src/command.ts
Normal file
8
packages/cli/src/command.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
import {Command as OclifCommand} from '@oclif/command'
|
||||
import Enquirer = require('enquirer')
|
||||
|
||||
abstract class Command extends OclifCommand {
|
||||
protected enquirer = new Enquirer()
|
||||
}
|
||||
|
||||
export default Command
|
||||
19
packages/cli/src/commands/build.ts
Normal file
19
packages/cli/src/commands/build.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import {Command} from '@oclif/command'
|
||||
import {build} from '@blitzjs/server'
|
||||
|
||||
export default class Build extends Command {
|
||||
static description = 'Create a production build'
|
||||
static aliases = ['b']
|
||||
|
||||
async run() {
|
||||
const config = {
|
||||
rootFolder: process.cwd(),
|
||||
}
|
||||
|
||||
try {
|
||||
await build(config)
|
||||
} catch (err) {
|
||||
process.exit(1) // clean up?
|
||||
}
|
||||
}
|
||||
}
|
||||
82
packages/cli/src/commands/console.ts
Normal file
82
packages/cli/src/commands/console.ts
Normal file
@@ -0,0 +1,82 @@
|
||||
import {Command} from '@oclif/command'
|
||||
import * as REPL from 'repl'
|
||||
import path from 'path'
|
||||
import {REPLCommand, REPLServer} from 'repl'
|
||||
import {watch} from 'chokidar'
|
||||
import pkgDir from 'pkg-dir'
|
||||
import {log} from '@blitzjs/server'
|
||||
import chalk from 'chalk'
|
||||
|
||||
// import {loadDependencies} from '../utils/load-dependencies'
|
||||
import {setupTsnode, BLITZ_MODULE_PATHS, loadBlitz} from '../utils/load-blitz'
|
||||
import {runPrismaGeneration} from './db'
|
||||
|
||||
const projectRoot = pkgDir.sync() || process.cwd()
|
||||
|
||||
export default class Console extends Command {
|
||||
static description = 'Run the Blitz console REPL'
|
||||
static aliases = ['c']
|
||||
|
||||
static replOptions = {
|
||||
prompt: '⚡️ > ',
|
||||
useColors: true,
|
||||
}
|
||||
|
||||
static commands = {
|
||||
reload: {
|
||||
help: 'Reload all modules',
|
||||
action(this: REPLServer) {
|
||||
this.clearBufferedCommand()
|
||||
console.log('Reloading all modules...')
|
||||
Console.loadModules(this)
|
||||
this.displayPrompt()
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
async run() {
|
||||
log.branded('You have entered the Blitz console')
|
||||
console.log(chalk.yellow('Tips: - Exit by typing .exit or pressing Ctrl-D'))
|
||||
console.log(chalk.yellow(' - Use your db like this: await db.user.findMany()'))
|
||||
console.log(chalk.yellow(' - Use your queries/mutations like this: await getUsers()'))
|
||||
|
||||
setupTsnode()
|
||||
await runPrismaGeneration({silent: true})
|
||||
|
||||
const repl = Console.initializeRepl()
|
||||
|
||||
const watchers = [
|
||||
// watch('package.json').on('change', () => Console.loadDependencies(repl)),
|
||||
watch(BLITZ_MODULE_PATHS).on('all', () => Console.loadBlitz(repl)),
|
||||
]
|
||||
|
||||
repl
|
||||
.on('reset', () => Console.loadModules(repl))
|
||||
.on('exit', () => watchers.forEach((watcher) => watcher.close()))
|
||||
}
|
||||
|
||||
private static initializeRepl() {
|
||||
const repl = REPL.start(Console.replOptions)
|
||||
Console.defineCommands(repl, Console.commands)
|
||||
Console.loadModules(repl)
|
||||
repl.setupHistory(path.join(projectRoot, '.blitz-console-history'), () => {})
|
||||
return repl
|
||||
}
|
||||
|
||||
private static loadModules(repl: REPLServer) {
|
||||
// Console.loadDependencies(repl)
|
||||
Console.loadBlitz(repl)
|
||||
}
|
||||
|
||||
// private static loadDependencies(repl: REPLServer) {
|
||||
// Object.assign(repl.context, loadDependencies(process.cwd()))
|
||||
// }
|
||||
|
||||
private static loadBlitz(repl: REPLServer) {
|
||||
Object.assign(repl.context, loadBlitz())
|
||||
}
|
||||
|
||||
private static defineCommands(repl: REPLServer, commands: Record<string, REPLCommand>) {
|
||||
Object.entries(commands).forEach(([keyword, cmd]) => repl.defineCommand(keyword, cmd))
|
||||
}
|
||||
}
|
||||
125
packages/cli/src/commands/db.ts
Normal file
125
packages/cli/src/commands/db.ts
Normal file
@@ -0,0 +1,125 @@
|
||||
import {spawn} from 'cross-spawn'
|
||||
import {flags} from '@oclif/command'
|
||||
import {Command} from '@oclif/command'
|
||||
import chalk from 'chalk'
|
||||
import * as path from 'path'
|
||||
import {resolveBinAsync} from '@blitzjs/server'
|
||||
|
||||
const schemaPath = path.join(process.cwd(), 'db', 'schema.prisma')
|
||||
const schemaArg = `--schema=${schemaPath}`
|
||||
const getPrismaBin = () => resolveBinAsync('@prisma/cli', 'prisma')
|
||||
|
||||
// Prisma client generation will fail if no model is defined in the schema.
|
||||
// So the silent option is here to ignore that failure
|
||||
export const runPrismaGeneration = async ({silent = false} = {}) => {
|
||||
const prismaBin = await getPrismaBin()
|
||||
|
||||
return new Promise((resolve) => {
|
||||
spawn(prismaBin, ['generate', schemaArg], {stdio: silent ? 'ignore' : 'inherit'}).on(
|
||||
'exit',
|
||||
(code: number) => {
|
||||
if (code === 0) {
|
||||
resolve()
|
||||
} else if (silent) {
|
||||
resolve()
|
||||
} else {
|
||||
process.exit(1)
|
||||
}
|
||||
},
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
export const runMigrate = async () => {
|
||||
const prismaBin = await getPrismaBin()
|
||||
|
||||
return new Promise((resolve) => {
|
||||
const cp = spawn(prismaBin, ['migrate', 'save', schemaArg, '--create-db', '--experimental'], {
|
||||
stdio: 'inherit',
|
||||
})
|
||||
cp.on('exit', (code: number) => {
|
||||
if (code == 0) {
|
||||
const cp = spawn(prismaBin, ['migrate', 'up', schemaArg, '--create-db', '--experimental'], {
|
||||
stdio: 'inherit',
|
||||
})
|
||||
cp.on('exit', async (code: number) => {
|
||||
if (code == 0) {
|
||||
await runPrismaGeneration()
|
||||
resolve()
|
||||
} else {
|
||||
process.exit(1)
|
||||
}
|
||||
})
|
||||
} else {
|
||||
process.exit(1)
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
export default class Db extends Command {
|
||||
static description = `Run database commands
|
||||
|
||||
${chalk.bold('migrate')} Run any needed migrations via Prisma 2 and generate Prisma Client.
|
||||
|
||||
${chalk.bold(
|
||||
'introspect',
|
||||
)} Will introspect the database defined in db/schema.prisma and automatically generate a complete schema.prisma file for you. Lastly, it\'ll generate Prisma Client.
|
||||
|
||||
${chalk.bold(
|
||||
'studio',
|
||||
)} Open the Prisma Studio UI at http://localhost:5555 so you can easily see and change data in your database.
|
||||
`
|
||||
|
||||
static args = [
|
||||
{
|
||||
name: 'command',
|
||||
description: 'Run specific db command',
|
||||
required: true,
|
||||
},
|
||||
]
|
||||
|
||||
static flags = {
|
||||
help: flags.help({char: 'h'}),
|
||||
}
|
||||
|
||||
async run() {
|
||||
const {args} = this.parse(Db)
|
||||
const command = args['command']
|
||||
|
||||
const prismaBin = await getPrismaBin()
|
||||
|
||||
if (command === 'migrate' || command === 'm') {
|
||||
await runMigrate()
|
||||
} else if (command === 'introspect') {
|
||||
const cp = spawn(prismaBin, ['introspect', schemaArg], {
|
||||
stdio: 'inherit',
|
||||
})
|
||||
cp.on('exit', (code: number) => {
|
||||
if (code == 0) {
|
||||
spawn(prismaBin, ['generate', schemaArg], {stdio: 'inherit'}).on('exit', (code: number) => {
|
||||
if (code !== 0) {
|
||||
process.exit(1)
|
||||
}
|
||||
})
|
||||
} else {
|
||||
process.exit(1)
|
||||
}
|
||||
})
|
||||
} else if (command === 'studio') {
|
||||
const cp = spawn(prismaBin, ['studio', schemaArg, '--experimental'], {
|
||||
stdio: 'inherit',
|
||||
})
|
||||
cp.on('exit', (code: number) => {
|
||||
if (code == 0) {
|
||||
} else {
|
||||
process.exit(1)
|
||||
}
|
||||
})
|
||||
} else {
|
||||
this.log("\nUh oh, we don't support that command.")
|
||||
this.log('You can try running a prisma command directly with:')
|
||||
this.log('\n `npm run prisma COMMAND` or `yarn prisma COMMAND`\n')
|
||||
}
|
||||
}
|
||||
}
|
||||
222
packages/cli/src/commands/generate.ts
Normal file
222
packages/cli/src/commands/generate.ts
Normal file
@@ -0,0 +1,222 @@
|
||||
import Command from '../command'
|
||||
import {flags} from '@oclif/command'
|
||||
import * as fs from 'fs'
|
||||
import * as path from 'path'
|
||||
import enquirer from 'enquirer'
|
||||
import _pluralize from 'pluralize'
|
||||
import PageGenerator from '../generators/page'
|
||||
import MutationGenerator from '../generators/mutation'
|
||||
import PromptAbortedError from '../errors/prompt-aborted'
|
||||
import QueryGenerator from '../generators/query'
|
||||
// import ModelGenerator from '../generators/model'
|
||||
import {log} from '@blitzjs/server'
|
||||
import camelCase from 'camelcase'
|
||||
const debug = require('debug')('blitz:generate')
|
||||
|
||||
const pascalCase = (str: string) => camelCase(str, {pascalCase: true})
|
||||
|
||||
enum ResourceType {
|
||||
All = 'all',
|
||||
Crud = 'crud',
|
||||
Mutation = 'mutations',
|
||||
Page = 'pages',
|
||||
Query = 'queries',
|
||||
// Resource = 'resource',
|
||||
}
|
||||
|
||||
interface Flags {
|
||||
context?: string
|
||||
'dry-run'?: boolean
|
||||
}
|
||||
|
||||
interface Args {
|
||||
type: ResourceType
|
||||
model: string
|
||||
}
|
||||
|
||||
function pluralize(input: string): string {
|
||||
return _pluralize.isPlural(input) ? input : _pluralize.plural(input)
|
||||
}
|
||||
|
||||
function singular(input: string): string {
|
||||
return _pluralize.isSingular(input) ? input : _pluralize.singular(input)
|
||||
}
|
||||
|
||||
function modelName(input: string) {
|
||||
return camelCase(singular(input))
|
||||
}
|
||||
function modelNames(input: string) {
|
||||
return camelCase(pluralize(input))
|
||||
}
|
||||
function ModelName(input: string) {
|
||||
return pascalCase(singular(input))
|
||||
}
|
||||
function ModelNames(input: string) {
|
||||
return pascalCase(pluralize(input))
|
||||
}
|
||||
|
||||
const generatorMap = {
|
||||
[ResourceType.All]: [/*ModelGenerator*/ PageGenerator, QueryGenerator, MutationGenerator],
|
||||
[ResourceType.Crud]: [MutationGenerator, QueryGenerator],
|
||||
[ResourceType.Mutation]: [MutationGenerator],
|
||||
[ResourceType.Page]: [PageGenerator],
|
||||
[ResourceType.Query]: [QueryGenerator],
|
||||
// [ResourceType.Resource]: [/*ModelGenerator*/ QueryGenerator, MutationGenerator],
|
||||
}
|
||||
|
||||
export default class Generate extends Command {
|
||||
static description = 'Generate new files for your Blitz project'
|
||||
|
||||
static aliases = ['g']
|
||||
|
||||
static args = [
|
||||
{
|
||||
name: 'type',
|
||||
required: true,
|
||||
description: 'What files to generate',
|
||||
options: [
|
||||
ResourceType.All,
|
||||
// ResourceType.Resource,
|
||||
ResourceType.Crud,
|
||||
ResourceType.Query,
|
||||
ResourceType.Mutation,
|
||||
ResourceType.Page,
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'model',
|
||||
required: true,
|
||||
description: 'The name of your model, like "user". Can be singular or plural - same result',
|
||||
},
|
||||
]
|
||||
|
||||
static flags = {
|
||||
help: flags.help({char: 'h'}),
|
||||
// context: flags.string({
|
||||
// char: 'c',
|
||||
// description:
|
||||
// 'The parent folder for nested generation. For example, generating `products` within a `store` would supply `-c store`. For nested contexts you may supply the full path.',
|
||||
// }),
|
||||
'dry-run': flags.boolean({
|
||||
char: 'd',
|
||||
description: 'Show what files will be created without writing them to disk',
|
||||
}),
|
||||
}
|
||||
|
||||
static examples = [
|
||||
`# The 'crud' type will generate all queries & mutations for a model
|
||||
> blitz generate crud productVariant
|
||||
`,
|
||||
`# The 'all' generator will scaffold out everything possible for a model
|
||||
> blitz generate all products
|
||||
`,
|
||||
]
|
||||
|
||||
async promptForTargetDirectory(paths: string[]): Promise<string> {
|
||||
return enquirer
|
||||
.prompt<{directory: string}>({
|
||||
name: 'directory',
|
||||
type: 'select',
|
||||
message: 'Please select a target directory:',
|
||||
choices: paths,
|
||||
})
|
||||
.then((resp) => resp.directory)
|
||||
}
|
||||
|
||||
async genericConfirmPrompt(message: string): Promise<boolean> {
|
||||
return enquirer
|
||||
.prompt<{continue: string}>({
|
||||
name: 'continue',
|
||||
type: 'select',
|
||||
message: message,
|
||||
choices: ['Yes', 'No'],
|
||||
})
|
||||
.then((resp) => resp.continue === 'Yes')
|
||||
}
|
||||
|
||||
async handleNoContext(message: string): Promise<void> {
|
||||
const shouldCreateNewRoot = await this.genericConfirmPrompt(message)
|
||||
if (!shouldCreateNewRoot) {
|
||||
log.error('Could not determine proper location for files. Aborting.')
|
||||
this.exit(0)
|
||||
}
|
||||
}
|
||||
|
||||
async run() {
|
||||
const {args, flags}: {args: Args; flags: Flags} = this.parse(Generate)
|
||||
debug('args: ', args)
|
||||
debug('flags: ', flags)
|
||||
|
||||
const isInRoot = fs.existsSync(path.resolve('blitz.config.js'))
|
||||
|
||||
if (!isInRoot) {
|
||||
log.error('No blitz.config.js found. `generate` must be run from the root of the project.')
|
||||
this.exit(1)
|
||||
}
|
||||
|
||||
try {
|
||||
let fileRoot: string
|
||||
let singularRootContext: string
|
||||
// let pluralRootContext: string
|
||||
let nestedContextPaths: string[] = []
|
||||
// otherwise, validate the provided path, prompting the user if it's absent or invalid
|
||||
if (!flags.context) {
|
||||
if (fs.existsSync(path.resolve('app', pluralize(args.model)))) {
|
||||
singularRootContext = modelName(args.model)
|
||||
fileRoot = modelNames(args.model)
|
||||
} else {
|
||||
singularRootContext = modelName(args.model)
|
||||
fileRoot = modelNames(args.model)
|
||||
}
|
||||
} else {
|
||||
// use [\\/] as the separator to match UNIX and Windows path formats
|
||||
const contextParts = flags.context.split(/[\\/]/)
|
||||
if (contextParts.length === 0) {
|
||||
await this.handleNoContext(
|
||||
`Couldn't determine context from context flag. Would you like to create a new context folder under /app for '${pluralize(
|
||||
args.model,
|
||||
)}'?`,
|
||||
)
|
||||
singularRootContext = modelName(args.model)
|
||||
fileRoot = modelNames(args.model)
|
||||
} else {
|
||||
// @ts-ignore shift can technically return undefined, but we already know the array isn't empty
|
||||
// so we can bypass the check
|
||||
fileRoot = modelNames(contextParts.shift())
|
||||
singularRootContext = modelName(args.model)
|
||||
// pluralRootContext = modelNames(args.model)
|
||||
nestedContextPaths = [...contextParts, pluralize(args.model)]
|
||||
}
|
||||
}
|
||||
|
||||
const generators = generatorMap[args.type]
|
||||
for (const GeneratorClass of generators) {
|
||||
const generator = new GeneratorClass({
|
||||
sourceRoot: path.join(__dirname, `../../templates/${GeneratorClass.template}`),
|
||||
destinationRoot: path.resolve(),
|
||||
modelName: modelName(singularRootContext),
|
||||
modelNames: modelNames(singularRootContext),
|
||||
ModelName: ModelName(singularRootContext),
|
||||
ModelNames: ModelNames(singularRootContext),
|
||||
dryRun: flags['dry-run'],
|
||||
// provide the file context as a relative path to the current directory (with a slash appended)
|
||||
// to generate files without changing the current directory. This allows yeoman to print out the
|
||||
// full file path rather than the current path
|
||||
fileContext:
|
||||
path.relative(
|
||||
path.resolve(),
|
||||
path.resolve('app', fileRoot, GeneratorClass.subdirectory, ...nestedContextPaths),
|
||||
) + '/',
|
||||
})
|
||||
await generator.run()
|
||||
}
|
||||
|
||||
console.log(' ') // new line
|
||||
} catch (err) {
|
||||
if (err instanceof PromptAbortedError) this.exit(0)
|
||||
|
||||
log.error(err)
|
||||
this.exit(1)
|
||||
}
|
||||
}
|
||||
}
|
||||
75
packages/cli/src/commands/new.ts
Normal file
75
packages/cli/src/commands/new.ts
Normal file
@@ -0,0 +1,75 @@
|
||||
import * as path from 'path'
|
||||
import {flags} from '@oclif/command'
|
||||
import Command from '../command'
|
||||
import AppGenerator from '../generators/app'
|
||||
import chalk from 'chalk'
|
||||
import hasbin from 'hasbin'
|
||||
const debug = require('debug')('blitz:new')
|
||||
|
||||
import PromptAbortedError from '../errors/prompt-aborted'
|
||||
|
||||
export interface Flags {
|
||||
ts: boolean
|
||||
yarn: boolean
|
||||
}
|
||||
|
||||
export default class New extends Command {
|
||||
static description = 'Create a new Blitz project'
|
||||
|
||||
static args = [
|
||||
{
|
||||
name: 'name',
|
||||
required: true,
|
||||
description: 'name of your new project',
|
||||
},
|
||||
]
|
||||
|
||||
static flags = {
|
||||
help: flags.help({char: 'h'}),
|
||||
// ts: flags.boolean({
|
||||
// char: 't',
|
||||
// description: 'generate a TypeScript project',
|
||||
// default: true,
|
||||
// allowNo: true,
|
||||
// }),
|
||||
yarn: flags.boolean({
|
||||
description: 'use Yarn as the package manager',
|
||||
default: hasbin.sync('yarn'),
|
||||
allowNo: true,
|
||||
}),
|
||||
'dry-run': flags.boolean({description: 'show what files will be created without writing them to disk'}),
|
||||
}
|
||||
|
||||
async run() {
|
||||
const {args, flags} = this.parse(New)
|
||||
debug('args: ', args)
|
||||
debug('flags: ', flags)
|
||||
|
||||
const destinationRoot = path.resolve(args.name)
|
||||
const appName = path.basename(destinationRoot)
|
||||
|
||||
const generator = new AppGenerator({
|
||||
sourceRoot: path.join(__dirname, '../../templates/app'),
|
||||
destinationRoot,
|
||||
appName,
|
||||
dryRun: flags['dry-run'],
|
||||
yarn: flags.yarn,
|
||||
version: this.config.version,
|
||||
})
|
||||
|
||||
const themeColor = '6700AB'
|
||||
|
||||
try {
|
||||
this.log('\n' + chalk.hex(themeColor).bold('Hang tight while we set up your new Blitz app!') + '\n')
|
||||
await generator.run()
|
||||
this.log('\n' + chalk.hex(themeColor).bold('Your new Blitz app is ready! Next steps:') + '\n')
|
||||
this.log(chalk.yellow(` 1. cd ${args.name}`))
|
||||
this.log(chalk.yellow(` 2. blitz start`))
|
||||
this.log(chalk.yellow(` 3. You create new pages by placing components inside app/pages/\n`))
|
||||
} catch (err) {
|
||||
if (err instanceof PromptAbortedError) this.exit(0)
|
||||
|
||||
this.error(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
34
packages/cli/src/commands/start.ts
Normal file
34
packages/cli/src/commands/start.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import {Command, flags} from '@oclif/command'
|
||||
import {dev, prod} from '@blitzjs/server'
|
||||
|
||||
import {runPrismaGeneration} from './db'
|
||||
|
||||
export default class Start extends Command {
|
||||
static description = 'Start a development server'
|
||||
static aliases = ['s']
|
||||
|
||||
static flags = {
|
||||
production: flags.boolean({
|
||||
char: 'p',
|
||||
description: 'Create and start a production server',
|
||||
}),
|
||||
}
|
||||
|
||||
async run() {
|
||||
const {flags} = this.parse(Start)
|
||||
|
||||
const config = {
|
||||
rootFolder: process.cwd(),
|
||||
}
|
||||
|
||||
if (flags.production) {
|
||||
await prod(config)
|
||||
} else {
|
||||
try {
|
||||
await dev(config, runPrismaGeneration({silent: true}))
|
||||
} catch (err) {
|
||||
process.exit(1) // clean up?
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
28
packages/cli/src/commands/test.ts
Normal file
28
packages/cli/src/commands/test.ts
Normal file
@@ -0,0 +1,28 @@
|
||||
import {spawn} from 'cross-spawn'
|
||||
import {Command} from '@oclif/command'
|
||||
import hasYarn from 'has-yarn'
|
||||
|
||||
export default class Test extends Command {
|
||||
static description = 'Run project tests'
|
||||
static aliases = ['t']
|
||||
|
||||
static args = [
|
||||
{
|
||||
name: 'watch',
|
||||
description: 'Run test:watch',
|
||||
},
|
||||
]
|
||||
|
||||
async run() {
|
||||
const {args} = this.parse(Test)
|
||||
let watchMode: boolean = false
|
||||
const watch = args['watch']
|
||||
if (watch) {
|
||||
watchMode = watch === 'watch' || watch === 'w'
|
||||
}
|
||||
const packageManager = hasYarn() ? 'yarn' : 'npm'
|
||||
|
||||
if (watchMode) spawn(packageManager, ['test:watch'], {stdio: 'inherit'})
|
||||
else spawn(packageManager, ['test'], {stdio: 'inherit'})
|
||||
}
|
||||
}
|
||||
5
packages/cli/src/errors/prompt-aborted.ts
Normal file
5
packages/cli/src/errors/prompt-aborted.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
export default class PromptAbortedError extends Error {
|
||||
constructor() {
|
||||
super('Prompt aborted')
|
||||
}
|
||||
}
|
||||
83
packages/cli/src/generator.ts
Normal file
83
packages/cli/src/generator.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import * as fs from 'fs-extra'
|
||||
import * as path from 'path'
|
||||
import {EventEmitter} from 'events'
|
||||
import {create as createStore, Store} from 'mem-fs'
|
||||
import {create as createEditor, Editor} from 'mem-fs-editor'
|
||||
import Enquirer = require('enquirer')
|
||||
|
||||
import ConflictChecker from './transforms/conflict-checker'
|
||||
|
||||
export interface GeneratorOptions {
|
||||
sourceRoot: string
|
||||
destinationRoot?: string
|
||||
dryRun?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* The base generator class.
|
||||
* Every generator must extend this class.
|
||||
*/
|
||||
abstract class Generator<T extends GeneratorOptions = GeneratorOptions> extends EventEmitter {
|
||||
private readonly store: Store
|
||||
|
||||
protected readonly fs: Editor
|
||||
protected readonly enquirer: Enquirer
|
||||
|
||||
private performedActions: string[] = []
|
||||
|
||||
constructor(protected readonly options: T) {
|
||||
super()
|
||||
|
||||
this.store = createStore()
|
||||
this.fs = createEditor(this.store)
|
||||
this.enquirer = new Enquirer()
|
||||
if (!this.options.destinationRoot) this.options.destinationRoot = process.cwd()
|
||||
}
|
||||
|
||||
abstract async write(): Promise<void>
|
||||
abstract async postWrite(): Promise<void>
|
||||
|
||||
sourcePath(...paths: string[]): string {
|
||||
return path.join(this.options.sourceRoot, ...paths)
|
||||
}
|
||||
|
||||
destinationPath(...paths: string[]): string {
|
||||
return path.join(this.options.destinationRoot!, ...paths)
|
||||
}
|
||||
|
||||
async run() {
|
||||
if (!this.options.dryRun) {
|
||||
await fs.ensureDir(this.options.destinationRoot!)
|
||||
process.chdir(this.options.destinationRoot!)
|
||||
}
|
||||
|
||||
await this.write()
|
||||
|
||||
await new Promise((resolve, reject) => {
|
||||
const conflictChecker = new ConflictChecker({
|
||||
dryRun: this.options.dryRun,
|
||||
})
|
||||
conflictChecker.on('error', (err) => {
|
||||
reject(err)
|
||||
})
|
||||
conflictChecker.on('fileStatus', (data: string) => {
|
||||
this.performedActions.push(data)
|
||||
})
|
||||
|
||||
this.fs.commit([conflictChecker], (err) => {
|
||||
if (err) reject(err)
|
||||
resolve()
|
||||
})
|
||||
})
|
||||
|
||||
this.performedActions.forEach((action) => {
|
||||
console.log(action)
|
||||
})
|
||||
|
||||
if (!this.options.dryRun) {
|
||||
await this.postWrite()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default Generator
|
||||
115
packages/cli/src/generators/app.ts
Normal file
115
packages/cli/src/generators/app.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import Generator, {GeneratorOptions} from '../generator'
|
||||
import readDirRecursive from 'fs-readdir-recursive'
|
||||
import spawn from 'cross-spawn'
|
||||
import chalk from 'chalk'
|
||||
import username from 'username'
|
||||
import {readJSONSync, writeJson} from 'fs-extra'
|
||||
import {join} from 'path'
|
||||
import {replaceDependencies} from '../utils/replace-dependencies'
|
||||
import {replaceBlitzDependency} from '../utils/replace-blitz-dependency'
|
||||
import {log} from '@blitzjs/server'
|
||||
|
||||
const themeColor = '6700AB'
|
||||
|
||||
export interface AppGeneratorOptions extends GeneratorOptions {
|
||||
appName: string
|
||||
yarn: boolean
|
||||
version: string
|
||||
}
|
||||
|
||||
const ignoredNames = ['.blitz', '.DS_Store', '.git', '.next', '.now', 'node_modules']
|
||||
|
||||
class AppGenerator extends Generator<AppGeneratorOptions> {
|
||||
async write() {
|
||||
const templateValues = {
|
||||
name: this.options.appName,
|
||||
username: await username(),
|
||||
}
|
||||
|
||||
const paths = readDirRecursive(this.sourcePath(), (name) => {
|
||||
return !ignoredNames.includes(name)
|
||||
})
|
||||
|
||||
for (let path of paths) {
|
||||
try {
|
||||
this.fs.copyTpl(this.sourcePath(path), this.destinationPath(path.replace('.ejs', '')), templateValues)
|
||||
} catch (error) {
|
||||
console.log('Error generating', path)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
this.fs.move(this.destinationPath('gitignore'), this.destinationPath('.gitignore'))
|
||||
}
|
||||
|
||||
async postWrite() {
|
||||
const pkgJsonLocation = join(this.destinationPath(), 'package.json')
|
||||
const pkg = readJSONSync(pkgJsonLocation)
|
||||
const pkgDependencies = Object.keys(pkg.dependencies)
|
||||
const pkgDevDependencies = Object.keys(pkg.devDependencies)
|
||||
|
||||
console.log('') // New line needed
|
||||
const spinner = log.spinner(log.withBranded('Retrieving the freshest of dependencies')).start()
|
||||
|
||||
const dependenciesArray = await Promise.all([
|
||||
replaceDependencies(pkg, pkgDependencies, 'dependencies'),
|
||||
replaceDependencies(pkg, pkgDevDependencies, 'devDependencies'),
|
||||
])
|
||||
|
||||
for (let i = 0; i < dependenciesArray.length; i++) {
|
||||
const {key, dependencies} = dependenciesArray[i]
|
||||
pkg[key] = replaceBlitzDependency(dependencies, this.options.version)
|
||||
}
|
||||
|
||||
await writeJson(pkgJsonLocation, pkg, {spaces: 2})
|
||||
|
||||
spinner.succeed()
|
||||
|
||||
console.log(chalk.hex(themeColor).bold('\nInstalling those dependencies...'))
|
||||
console.log('Scary warning messages during this part are unfortunately normal.\n')
|
||||
|
||||
const result = spawn.sync(this.options.yarn ? 'yarn' : 'npm', ['install'], {stdio: 'inherit'})
|
||||
if (result.status !== 0) {
|
||||
throw new Error()
|
||||
}
|
||||
|
||||
console.log(chalk.hex(themeColor).bold('\nDependencies successfully installed.'))
|
||||
|
||||
// Ensure the generated files are formatted with the installed prettier version
|
||||
const prettierResult = spawn.sync(
|
||||
this.options.yarn ? 'yarn' : 'npm',
|
||||
'run prettier --loglevel silent --write .'.split(' '),
|
||||
{
|
||||
stdio: 'ignore',
|
||||
},
|
||||
)
|
||||
if (prettierResult.status !== 0) {
|
||||
throw new Error('Failed running prettier')
|
||||
}
|
||||
|
||||
// TODO: someone please clean up this ugly code :D
|
||||
// Currently aren't failing the generation process if git repo creation fails
|
||||
const gitResult1 = spawn.sync('git', ['init'], {
|
||||
stdio: 'ignore',
|
||||
})
|
||||
if (gitResult1.status === 0) {
|
||||
const gitResult2 = spawn.sync('git', ['add', '.'], {
|
||||
stdio: 'ignore',
|
||||
})
|
||||
if (gitResult2.status === 0) {
|
||||
const gitResult3 = spawn.sync('git', ['commit', '-m', 'New baby Blitz app!'], {
|
||||
stdio: 'ignore',
|
||||
})
|
||||
if (gitResult3.status !== 0) {
|
||||
console.error('Failed to run git commit')
|
||||
}
|
||||
} else {
|
||||
console.error('Failed to run git add')
|
||||
}
|
||||
} else {
|
||||
console.error('Failed to run git init')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default AppGenerator
|
||||
49
packages/cli/src/generators/model.ts
Normal file
49
packages/cli/src/generators/model.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
import Generator, {GeneratorOptions} from '../generator'
|
||||
import enquirer from 'enquirer'
|
||||
import path from 'path'
|
||||
|
||||
export interface ModelGeneratorOptions extends GeneratorOptions {
|
||||
ModelName: string
|
||||
ModelNames: string
|
||||
modelName: string
|
||||
modelNames: string
|
||||
fileContext: string
|
||||
}
|
||||
|
||||
class ModelGenerator extends Generator<ModelGeneratorOptions> {
|
||||
// default subdirectory is /app/[name], we need to back out of there to generate the model
|
||||
static subdirectory = '../..'
|
||||
static template = ''
|
||||
|
||||
async write() {
|
||||
try {
|
||||
if (!this.fs.exists(path.resolve('db/schema.prisma'))) {
|
||||
throw new Error('Prisma schema file was not found')
|
||||
}
|
||||
const {fields: fieldsString} = await enquirer.prompt({
|
||||
name: 'fields',
|
||||
type: 'input',
|
||||
message: `Please input all fields which should exist on a ${this.options.ModelName} as a space-separated list of key:value pairs.
|
||||
An 'id' column will be auto-generated and should not be entered.
|
||||
Modifiers can be denoted with a trailing '?' (e.g. 'lastname:string?' or 'users:User[]')`,
|
||||
})
|
||||
const fields = fieldsString.split(' ')
|
||||
let modelDefinition = `\nmodel ${this.options.ModelName} {
|
||||
id Int @id @default(autoincrement())`
|
||||
for (const field of fields) {
|
||||
const [fieldName, fieldType] = field.split(':')
|
||||
modelDefinition += `\n ${fieldName} ${fieldType}`
|
||||
}
|
||||
modelDefinition += '\n}\n'
|
||||
this.fs.append(path.resolve('db/schema.prisma'), modelDefinition)
|
||||
} catch (error) {
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
async postWrite() {
|
||||
// log.success(`Successfully created prisma model for ${this.options.name.toLocaleLowerCase()}`)
|
||||
}
|
||||
}
|
||||
|
||||
export default ModelGenerator
|
||||
46
packages/cli/src/generators/mutation.ts
Normal file
46
packages/cli/src/generators/mutation.ts
Normal file
@@ -0,0 +1,46 @@
|
||||
import Generator, {GeneratorOptions} from '../generator'
|
||||
import readDirRecursive from 'fs-readdir-recursive'
|
||||
import {log} from '@blitzjs/server'
|
||||
|
||||
export interface MutationGeneratorOptions extends GeneratorOptions {
|
||||
ModelName: string
|
||||
ModelNames: string
|
||||
modelName: string
|
||||
modelNames: string
|
||||
fileContext: string
|
||||
}
|
||||
|
||||
class MutationGenerator extends Generator<MutationGeneratorOptions> {
|
||||
static subdirectory = 'mutations'
|
||||
static template = 'mutation'
|
||||
|
||||
async write() {
|
||||
const templateValues = {
|
||||
modelName: this.options.modelName,
|
||||
modelNames: this.options.modelNames,
|
||||
ModelName: this.options.ModelName,
|
||||
ModelNames: this.options.ModelNames,
|
||||
}
|
||||
|
||||
const paths = readDirRecursive(this.sourcePath())
|
||||
|
||||
for (let path of paths) {
|
||||
try {
|
||||
this.fs.copyTpl(
|
||||
this.sourcePath(path),
|
||||
this.destinationPath(this.options.fileContext + path.replace('.ejs', '')),
|
||||
templateValues,
|
||||
)
|
||||
} catch (error) {
|
||||
log.error('Error generating' + path)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async postWrite() {
|
||||
// log.success(`Successfully created mutations for ${this.options.pluralName.toLocaleLowerCase()}`)
|
||||
}
|
||||
}
|
||||
|
||||
export default MutationGenerator
|
||||
53
packages/cli/src/generators/page.ts
Normal file
53
packages/cli/src/generators/page.ts
Normal file
@@ -0,0 +1,53 @@
|
||||
import Generator, {GeneratorOptions} from '../generator'
|
||||
import readDirRecursive from 'fs-readdir-recursive'
|
||||
import {log} from '@blitzjs/server'
|
||||
import {join} from 'path'
|
||||
|
||||
export interface PageGeneratorOptions extends GeneratorOptions {
|
||||
ModelName: string
|
||||
ModelNames: string
|
||||
modelName: string
|
||||
modelNames: string
|
||||
fileContext: string
|
||||
}
|
||||
|
||||
class PageGenerator extends Generator<PageGeneratorOptions> {
|
||||
static subdirectory = 'pages'
|
||||
static template = 'page'
|
||||
|
||||
async write() {
|
||||
const templateValues = {
|
||||
modelName: this.options.modelName,
|
||||
modelNames: this.options.modelNames,
|
||||
ModelName: this.options.ModelName,
|
||||
ModelNames: this.options.ModelNames,
|
||||
}
|
||||
|
||||
const paths = readDirRecursive(this.sourcePath())
|
||||
|
||||
for (let path of paths) {
|
||||
try {
|
||||
this.fs.copyTpl(
|
||||
this.sourcePath(path),
|
||||
this.destinationPath(
|
||||
join(
|
||||
this.options.fileContext,
|
||||
this.options.modelNames,
|
||||
path.replace('.ejs', '').replace('__id__', '[id]'),
|
||||
),
|
||||
),
|
||||
templateValues,
|
||||
)
|
||||
} catch (error) {
|
||||
log.error('Error generating' + path)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async postWrite() {
|
||||
// log.success(`Successfully created pages for ${this.options.pluralName.toLocaleLowerCase()}`)
|
||||
}
|
||||
}
|
||||
|
||||
export default PageGenerator
|
||||
46
packages/cli/src/generators/query.ts
Normal file
46
packages/cli/src/generators/query.ts
Normal file
@@ -0,0 +1,46 @@
|
||||
import Generator, {GeneratorOptions} from '../generator'
|
||||
import readDirRecursive from 'fs-readdir-recursive'
|
||||
import {log} from '@blitzjs/server'
|
||||
|
||||
export interface QueryMutationGeneratorOptions extends GeneratorOptions {
|
||||
ModelName: string
|
||||
ModelNames: string
|
||||
modelName: string
|
||||
modelNames: string
|
||||
fileContext: string
|
||||
}
|
||||
|
||||
class QueryGenerator extends Generator<QueryMutationGeneratorOptions> {
|
||||
static subdirectory = 'queries'
|
||||
static template = 'query'
|
||||
|
||||
async write() {
|
||||
const templateValues = {
|
||||
modelName: this.options.modelName,
|
||||
modelNames: this.options.modelNames,
|
||||
ModelName: this.options.ModelName,
|
||||
ModelNames: this.options.ModelNames,
|
||||
}
|
||||
|
||||
const paths = readDirRecursive(this.sourcePath())
|
||||
|
||||
for (let path of paths) {
|
||||
try {
|
||||
this.fs.copyTpl(
|
||||
this.sourcePath(path),
|
||||
this.destinationPath(this.options.fileContext + path.replace('.ejs', '')),
|
||||
templateValues,
|
||||
)
|
||||
} catch (error) {
|
||||
log.error('Error generating' + path)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async postWrite() {
|
||||
// log.success(`Successfully created queries for ${this.options.pluralName.toLocaleLowerCase()}`)
|
||||
}
|
||||
}
|
||||
|
||||
export default QueryGenerator
|
||||
11
packages/cli/src/index.ts
Normal file
11
packages/cli/src/index.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import {run as oclifRun} from '@oclif/command'
|
||||
|
||||
// Load the .env environment variable so it's avaiable for all commands
|
||||
require('dotenv').config()
|
||||
|
||||
export function run() {
|
||||
oclifRun()
|
||||
.then(require('@oclif/command/flush'))
|
||||
// @ts-ignore (TS complains about using `catch`)
|
||||
.catch(require('@oclif/errors/handle'))
|
||||
}
|
||||
142
packages/cli/src/transforms/conflict-checker.ts
Normal file
142
packages/cli/src/transforms/conflict-checker.ts
Normal file
@@ -0,0 +1,142 @@
|
||||
import {Transform, TransformCallback} from 'stream'
|
||||
import * as path from 'path'
|
||||
import File from 'vinyl'
|
||||
import {diffLines, Change} from 'diff'
|
||||
import * as fs from 'fs-extra'
|
||||
import chalk = require('chalk')
|
||||
import enquirer = require('enquirer')
|
||||
|
||||
import PromptAbortedError from '../errors/prompt-aborted'
|
||||
|
||||
interface PromptAnswer {
|
||||
action: 'overwrite' | 'skip' | 'show'
|
||||
}
|
||||
|
||||
type PromptActions = 'create' | 'overwrite' | 'skip' | 'identical'
|
||||
|
||||
interface ConflictCheckerOptions {
|
||||
dryRun?: boolean
|
||||
}
|
||||
|
||||
export default class ConflictChecker extends Transform {
|
||||
private _destroyed = false
|
||||
|
||||
constructor(private readonly options?: ConflictCheckerOptions) {
|
||||
super({
|
||||
objectMode: true,
|
||||
})
|
||||
}
|
||||
|
||||
_transform(file: File, _encoding: string, cb: TransformCallback): void {
|
||||
if (file.state === null) {
|
||||
cb()
|
||||
return
|
||||
}
|
||||
|
||||
// If the file doesn't exists yet there isn't any diff to perform
|
||||
const filePath = path.resolve(file.path)
|
||||
if (!fs.existsSync(filePath)) {
|
||||
this.handlePush(file, 'create')
|
||||
cb()
|
||||
return
|
||||
}
|
||||
|
||||
this.checkDiff(file)
|
||||
.then((status) => {
|
||||
if (status !== 'skip') {
|
||||
this.handlePush(file, status)
|
||||
} else {
|
||||
this.fileStatusString(file, status)
|
||||
}
|
||||
|
||||
cb()
|
||||
})
|
||||
.catch((err) => {
|
||||
// If the error is an empty string, it means that the user has
|
||||
// stopped the prompt with ctrl-c so we return PromptAbortedError
|
||||
// to end the program without writing anything to disk
|
||||
cb(err || new PromptAbortedError())
|
||||
})
|
||||
}
|
||||
|
||||
destroy(err?: Error): void {
|
||||
if (this._destroyed) return
|
||||
this._destroyed = true
|
||||
|
||||
process.nextTick(() => {
|
||||
if (err) this.emit('err', err)
|
||||
this.emit('close')
|
||||
})
|
||||
}
|
||||
|
||||
handlePush(file: File, status: PromptActions): void {
|
||||
if (!this.options?.dryRun) this.push(file)
|
||||
|
||||
this.emit('fileStatus', this.fileStatusString(file, status))
|
||||
}
|
||||
|
||||
private async checkDiff(file: File): Promise<PromptActions> {
|
||||
let newFileContents = file.contents?.toString() ?? ''
|
||||
const oldFileContents = fs.readFileSync(path.resolve(file.path)).toString()
|
||||
|
||||
const diff = diffLines(oldFileContents, newFileContents)
|
||||
|
||||
const conflict = diff.some((line) => line.added || line.removed)
|
||||
|
||||
if (conflict) {
|
||||
let answer = null
|
||||
do {
|
||||
answer = await enquirer.prompt<PromptAnswer>({
|
||||
type: 'select',
|
||||
name: 'action',
|
||||
message: `The file "${file.path}" has conflicts. What do you want to do?`, // Maybe color file.path
|
||||
choices: [
|
||||
{name: 'overwrite', message: 'Overwrite', value: 'overwrite'},
|
||||
{name: 'skip', message: 'Skip', value: 'skip'},
|
||||
{name: 'show', message: 'Show changes', value: 'show'},
|
||||
],
|
||||
})
|
||||
|
||||
if (answer?.action === 'show') this.printDiff(diff)
|
||||
} while (answer?.action === 'show')
|
||||
|
||||
return answer.action
|
||||
}
|
||||
|
||||
return 'identical'
|
||||
}
|
||||
|
||||
private printDiff(diff: Change[]) {
|
||||
console.log('\n')
|
||||
diff.forEach((line) => {
|
||||
const value = line.value.replace('\n', '')
|
||||
if (line.added) {
|
||||
console.log(chalk.green(`+ ${value}`))
|
||||
} else if (line.removed) {
|
||||
console.log(chalk.red(`- ${value}`))
|
||||
} else {
|
||||
console.log(value)
|
||||
}
|
||||
})
|
||||
console.log('\n')
|
||||
}
|
||||
|
||||
private fileStatusString(file: File, status: PromptActions) {
|
||||
let statusLog = null
|
||||
switch (status) {
|
||||
case 'create':
|
||||
statusLog = chalk.green('CREATE ')
|
||||
break
|
||||
case 'overwrite':
|
||||
statusLog = chalk.cyan('OVERWRITE')
|
||||
break
|
||||
case 'skip':
|
||||
statusLog = chalk.blue('SKIP ')
|
||||
break
|
||||
case 'identical':
|
||||
statusLog = chalk.gray('IDENTICAL')
|
||||
}
|
||||
|
||||
return `${statusLog} ${file.relative}`
|
||||
}
|
||||
}
|
||||
24
packages/cli/src/utils/get-latest-version.ts
Normal file
24
packages/cli/src/utils/get-latest-version.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import {fetchAllVersions, fetchLatestDistVersion} from './npm-fetch'
|
||||
|
||||
export const getLatestVersion = async (dependency: string, templateVersion: string) => {
|
||||
const major = templateVersion.replace('.x', '')
|
||||
const allVersions = await fetchAllVersions(dependency)
|
||||
const latestDistVersion = await fetchLatestDistVersion(dependency)
|
||||
|
||||
if (!allVersions || !latestDistVersion) {
|
||||
return templateVersion
|
||||
}
|
||||
|
||||
const latestVersion = Object.keys(allVersions)
|
||||
.filter((version) => version.startsWith(major))
|
||||
.sort((a, b) => a.localeCompare(b, undefined, {numeric: true}))
|
||||
.reverse()[0]
|
||||
|
||||
// If the latest tagged version matches our pinned major, use that, otherwise use the
|
||||
// latest untagged which does
|
||||
if (latestDistVersion.startsWith(major)) {
|
||||
return latestDistVersion
|
||||
} else {
|
||||
return latestVersion
|
||||
}
|
||||
}
|
||||
52
packages/cli/src/utils/load-blitz.ts
Normal file
52
packages/cli/src/utils/load-blitz.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
import {forceRequire} from './module'
|
||||
import path from 'path'
|
||||
import globby from 'globby'
|
||||
import pkgDir from 'pkg-dir'
|
||||
import {REGISTER_INSTANCE} from 'ts-node'
|
||||
|
||||
const projectRoot = pkgDir.sync() || process.cwd()
|
||||
|
||||
export const setupTsnode = () => {
|
||||
if (!process[REGISTER_INSTANCE]) {
|
||||
// During blitz interal dev, oclif automaticaly sets up ts-node so we have to check
|
||||
require('ts-node').register({compilerOptions: {module: 'commonjs'}})
|
||||
}
|
||||
require('tsconfig-paths/register')
|
||||
}
|
||||
|
||||
export const BLITZ_MODULE_PATHS = [
|
||||
...globby.sync(
|
||||
[
|
||||
'app/**/{queries,mutations}/*.{js,ts,tsx}',
|
||||
'**/utils/*.{js,ts,tsx}',
|
||||
'jobs/**/*.{js,ts,tsx}',
|
||||
'integrations/**/*.{js,ts,tsx}',
|
||||
],
|
||||
{cwd: projectRoot, gitignore: true},
|
||||
),
|
||||
'db',
|
||||
].map((p) => path.join(projectRoot, p))
|
||||
|
||||
export const loadBlitz = () => {
|
||||
return Object.assign(
|
||||
{},
|
||||
...BLITZ_MODULE_PATHS.map((modulePath) => {
|
||||
let name = path.parse(modulePath).name
|
||||
if (name === 'index') {
|
||||
const dirs = path.dirname(modulePath).split(path.sep)
|
||||
name = dirs[dirs.length - 1]
|
||||
}
|
||||
|
||||
try {
|
||||
const module = forceRequire(modulePath)
|
||||
const contextObj = module.default || module
|
||||
//TODO: include all exports here, not just default
|
||||
return {
|
||||
[name]: contextObj,
|
||||
}
|
||||
} catch (e) {
|
||||
return {}
|
||||
}
|
||||
}),
|
||||
)
|
||||
}
|
||||
42
packages/cli/src/utils/load-dependencies.ts
Normal file
42
packages/cli/src/utils/load-dependencies.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
import * as path from 'path'
|
||||
import {forceRequire} from './module'
|
||||
|
||||
const modulePath = (module: string) => {
|
||||
try {
|
||||
return require.resolve(module)
|
||||
} catch (e) {
|
||||
throw new Error(`Failed to load module '${module}'`)
|
||||
}
|
||||
}
|
||||
|
||||
const isFunction = (functionToCheck: any): functionToCheck is Function =>
|
||||
typeof functionToCheck === 'function'
|
||||
|
||||
const toCamelCase = (name: string) =>
|
||||
name
|
||||
.replace(/[_-]([a-z])/g, (_match: string, group: string) => group.toUpperCase())
|
||||
.replace(/@[a-z]+\//, '')
|
||||
|
||||
const functionModuleName = (moduleName: string, fun: Function) => {
|
||||
if (fun.name && fun.name !== 'anonymous') return fun.name
|
||||
return toCamelCase(moduleName)
|
||||
}
|
||||
|
||||
export const loadDependencies = (pkgRoot: string) => {
|
||||
const pkg = forceRequire(path.join(pkgRoot, 'package.json'))
|
||||
|
||||
const modules = Object.keys(pkg.dependencies || {})
|
||||
.map((name) => [name, modulePath(name)])
|
||||
.filter(([_name, path]) => path !== null)
|
||||
.map(([name, path]) => [name, forceRequire(path)])
|
||||
.map(([name, module]) => {
|
||||
if (isFunction(module)) return {[functionModuleName(name, module)]: module}
|
||||
const defaultExport = module.default
|
||||
if (!defaultExport) return module
|
||||
if (isFunction(defaultExport)) return {[functionModuleName(name, defaultExport)]: defaultExport}
|
||||
return {
|
||||
[toCamelCase(defaultExport)]: defaultExport,
|
||||
}
|
||||
})
|
||||
return Object.assign({}, ...modules)
|
||||
}
|
||||
8
packages/cli/src/utils/module.ts
Normal file
8
packages/cli/src/utils/module.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
const invalidateCache = (module: string) => {
|
||||
delete require.cache[require.resolve(module)]
|
||||
}
|
||||
|
||||
export const forceRequire = (module: string) => {
|
||||
invalidateCache(module)
|
||||
return require(module)
|
||||
}
|
||||
21
packages/cli/src/utils/npm-fetch.ts
Normal file
21
packages/cli/src/utils/npm-fetch.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import fetch from 'node-fetch'
|
||||
|
||||
export const fetchAllVersions = async (dependency: string) => {
|
||||
const res = await fetch(`https://registry.npmjs.org/${dependency}`)
|
||||
if (res.ok) {
|
||||
const json = await res.json()
|
||||
return json.versions as string[]
|
||||
} else {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
export const fetchLatestDistVersion = async (dependency: string) => {
|
||||
const res = await fetch(`https://registry.npmjs.org/-/package/${dependency}/dist-tags`)
|
||||
if (res.ok) {
|
||||
const json = await res.json()
|
||||
return json.latest as string
|
||||
} else {
|
||||
return
|
||||
}
|
||||
}
|
||||
7
packages/cli/src/utils/replace-blitz-dependency.ts
Normal file
7
packages/cli/src/utils/replace-blitz-dependency.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export const replaceBlitzDependency = (depends: Record<string, string>, cliVersion: string) => {
|
||||
if (depends.blitz) {
|
||||
depends.blitz = cliVersion.includes('canary') ? 'canary' : 'latest'
|
||||
}
|
||||
|
||||
return depends
|
||||
}
|
||||
16
packages/cli/src/utils/replace-dependencies.ts
Normal file
16
packages/cli/src/utils/replace-dependencies.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import {getLatestVersion} from '../utils/get-latest-version'
|
||||
|
||||
export const replaceDependencies = async (pkg: any, dependencies: string[], key: string) => {
|
||||
const latestVersions = await Promise.all(
|
||||
dependencies.map(async (dependency) => {
|
||||
const templateVersion = pkg[key][dependency]
|
||||
if (templateVersion.match(/\d.x/)) {
|
||||
return await getLatestVersion(dependency, templateVersion)
|
||||
} else {
|
||||
return templateVersion
|
||||
}
|
||||
}),
|
||||
)
|
||||
|
||||
return {key, dependencies: dependencies.reduce((o, k, i) => ({...o, [k]: latestVersions[i]}), {})}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user