Skip to content

Commit e17671c

Browse files
committed
feat: engine
1 parent c009801 commit e17671c

File tree

1,049 files changed

+26919
-14484
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,049 files changed

+26919
-14484
lines changed

.eleventyignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

.eslintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@ __output
1212
__output-dev
1313

1414
docs/_merged*
15+
*-mdjs-generated.js
16+
17+
/packages/engine/test-node/fixtures/06-error-handling/01-page-error/docs/index.rocket.js
18+
/packages/engine/test-node/fixtures/03b-format-markdown/c01-md-in-js-to-md-html/md-in-js.js

.gitignore

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
## editors
22
/.idea
3-
/.vscode
43

54
## system files
65
.DS_Store
@@ -28,9 +27,7 @@ stats.html
2827
*.tsbuildinfo
2928

3029
## Rocket ignore files (need to be the full relative path to the folders)
31-
docs/_merged_data/
32-
docs/_merged_assets/
33-
docs/_merged_includes/
30+
*-mdjs-generated.js
3431
_site
3532
_site-dev
3633

@@ -40,3 +37,4 @@ _merged_assets
4037
_merged_includes
4138
__output
4239
__output-dev
40+
docs_backup

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v14
1+
v16

.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
// See http://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
"dbaeumer.vscode-eslint"
6+
]
7+
}

.vscode/launch.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// A launch configuration that compiles the extension and then opens it inside a new window
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
{
6+
"version": "0.2.0",
7+
"configurations": [
8+
{
9+
"name": "Run Web Dev Server Extension",
10+
"type": "extensionHost",
11+
"request": "launch",
12+
"args": [
13+
"--extensionDevelopmentPath=${workspaceFolder}/packages/vscode-rocket"
14+
],
15+
"outFiles": [
16+
"${workspaceFolder}/packages/vscode-rocket/out/**/*.js"
17+
],
18+
"preLaunchTask": "Compile vscode-rocket"
19+
},
20+
{
21+
"name": "Extension Tests",
22+
"type": "extensionHost",
23+
"request": "launch",
24+
"args": [
25+
"--extensionDevelopmentPath=${workspaceFolder}",
26+
"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
27+
],
28+
"outFiles": [
29+
"${workspaceFolder}/out/test/**/*.js"
30+
],
31+
"preLaunchTask": "${defaultBuildTask}"
32+
}
33+
]
34+
}

.vscode/settings.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"gitdoc.enabled": false,
3+
"typescript.tsdk": "node_modules/typescript/lib",
4+
"files.exclude": {
5+
"**/*-mdjs-generated.js": false,
6+
},
7+
"search.exclude": {
8+
"**/*-mdjs-generated.js": true,
9+
"**/dist-types": true,
10+
}
11+
}

.vscode/tasks.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// See https://go.microsoft.com/fwlink/?LinkId=733558
2+
// for the documentation about the tasks.json format
3+
{
4+
"version": "2.0.0",
5+
"tasks": [
6+
{
7+
"type": "npm",
8+
"script": "watch",
9+
"problemMatcher": "$tsc-watch",
10+
"isBackground": true,
11+
"presentation": {
12+
"reveal": "never"
13+
},
14+
"group": {
15+
"kind": "build",
16+
"isDefault": true
17+
}
18+
},
19+
{
20+
"label": "Compile vscode-rocket",
21+
"type": "npm",
22+
"script": "compile",
23+
"path": "packages/vscode-rocket/",
24+
"group": "build",
25+
"problemMatcher": [],
26+
"detail": "tsc -p ./"
27+
}
28+
]
29+
}

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
**The modern web setup for static sites with a sprinkle of JavaScript!**
4040

41-
- **Meta Framework:** Build on top of giants like <a href="https://www.11ty.dev/">Eleventy</a>, <a href="https://rollupjs.org/">Rollup</a>, and <a href="https://www.modern-web.dev/">Modern Web</a>.
41+
- **Meta Framework:** Build on top of giants like <a href="https://lit.dev/">Lit</a>, <a href="https://rollupjs.org/">Rollup</a> and <a href="https://www.modern-web.dev/">Modern Web</a>.
4242
- **Powerful Default Template:** Provide content and you are ready to go.
4343
- **Small:** No overblown tools or frontend frameworks, add JavaScript and/or Web Components only on pages where needed..
4444

@@ -55,6 +55,16 @@ You can still tweak every detail of every underlying tool that gets used.
5555

5656
Rocket is part of the [Modern Web Family](https://twitter.com/modern_web_dev).
5757

58+
## Quick Start
59+
60+
```
61+
mkdir test-rocket
62+
cd test-rocket
63+
npm init -y
64+
npm i @rocket/cli@alpha @rocket/launch@alpha @11ty/eleventy-cache-assets typescript
65+
npx rocket init
66+
```
67+
5868
## 🤝 Contributing
5969

6070
We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/modernweb-dev/rocket/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).

TODO.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Features
2+
3+
- ssr render can just be a string concat
4+
- recursive rendering of lit / html / and markdown
5+
- "import" markdown with frontmatter
6+
- mdjs update to unified v10 AND go esm only (only cjs pkg we have now)
7+
8+
## Nice to have
9+
10+
- Add "menuExclude" => to actually exclude the menu item
11+
12+
## Bugs
13+
14+
- write to `_site-dev` instead of `_site` while using `rocket start`
15+
- nested `recursive.data.js` do not overwrite the parent data
16+
- support <!-- asdf --> in markdown
17+
18+
## Error Handling
19+
20+
- make error nice for parent page not found in index => auto generate page? 🤔
21+
22+
## Examples
23+
24+
- docs site, blog (simple), blog (complex), minimal
25+
- add stackblitz/codesandbox examples => does not work because of `@parcel/watcher` https://github.com/parcel-bundler/watcher/issues/99
26+
27+
- Example: export variable and use it in rendering
28+
- Example: fetch data from an api and display it
29+
- Example: usage of image
30+
31+
## later
32+
33+
- support `@change` in markdown
34+
- support "hey ${foo.map(f => `${f} + 1`)}"
35+
- ENGINE: Rename "options.docsDir" to "options.inputDir"
36+
37+
## consider
38+
39+
- Replace magic "resolve:pkg/foo.css" with a directive `${resolve()}`?

0 commit comments

Comments
 (0)