Skip to content

Commit fce5abc

Browse files
committed
chore(docs): update installation notes and add alternatives
- Updated dotnet tool requirements in installation and beta notice sections. - Added JSPM to the alternatives list. - Created global.json files for empty-fable templates. - Updated perla version in dotnet-tools.json for fable-feliz and empty-fable templates.
1 parent 705f385 commit fce5abc

File tree

7 files changed

+33
-6
lines changed

7 files changed

+33
-6
lines changed

docs/assets/content/alternatives.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
[snowpack]: https://www.snowpack.dev/
22
[vite]: https://vitejs.dev/
33
[esbuild]: https://esbuild.github.io/
4+
[jspm]: https://jspm.org/
45

56
# Alternatives
67

78
This project draws inspiration from:
89

910
- [Snowpack]
1011
- [Vite]
12+
- [JSPM]
1113

1214
These tools are well-established in the JavaScript ecosystem and offer a wide range of features, including support for JavaScript plugins. This enables them to handle assets like `sass`, `less`, `pug`, `vue files`, and more.
1315

docs/assets/content/install.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ If you prefer to use the dotnet (global | local) tool, you can install it using
2222
dotnet tool install --global Perla
2323
```
2424

25-
> **Note**: From `v1.0.0-beta-033` onwards, the dotnet tool won't be available as the playwright support makes it harder to upload to nuget, but a solution is in the works. The install scripts and manual download from the releases page still work unchanged.
25+
> **Note**: From `v1.0.0-rc-002` onwards, the dotnet tool requires `dotnet 10 preview 7 or above` to be installed as we leverage the new multi-rid nuget packaging. This is due the extra weight playwright puts over us by bundling nodejs for each target platform (win, linux, osx, and arch x64 and arm64) on net8 our nuget package goes over 400mb which is over the allowed size on NuGetUploads (they don't have this issue though 😜).
26+
>
27+
> We'll try to address this issue by splitting the testing support in a separate tool in the future if feasible.
28+
>
29+
> The install scripts and manual download from the releases page still work unchanged.
2630
2731
Once you're done with the installation, you can run `perla --help` to verify that the installation was successful.

docs/src/App.jsx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,11 @@ function BetaNotice() {
168168
<br />
169169
<small>
170170
<em>
171-
Note: From v1.0.0-beta-033 onwards, the dotnet tool won't be
172-
available we're working on it. The install scripts and download from
173-
the releases page remain unchanged.
171+
Note: From v1.0.0-rc-002 onwards, the dotnet tool requires
172+
<b>dotnet 10 preview 7 or above</b> to be installed.
173+
<br />
174+
The install scripts and download from the releases page remain
175+
unchanged.
174176
</em>
175177
</small>
176178
</p>

src/Perla/offline-templates/empty-fable/.config/dotnet-tools.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
"version": 1,
33
"isRoot": true,
44
"tools": {
5+
"perla": {
6+
"version": "1.0.0-rc-002",
7+
"commands": ["perla"],
8+
"rollForward": true
9+
},
510
"fable": {
611
"version": "4.25.0",
712
"commands": ["fable"],
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"sdk": {
3+
"version": "10.0.100-preview.7.25380.108",
4+
"allowPrerelease": true,
5+
"rollForward": "latestFeature"
6+
}
7+
}

src/Perla/offline-templates/fable-feliz/.config/dotnet-tools.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"isRoot": true,
44
"tools": {
55
"perla": {
6-
"version": "1.0.0-beta-028",
6+
"version": "1.0.0-rc-002",
77
"commands": ["perla"],
8-
"rollForward": false
8+
"rollForward": true
99
},
1010
"fable": {
1111
"version": "4.25.0",
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"sdk": {
3+
"version": "10.0.100-preview.7.25380.108",
4+
"allowPrerelease": true,
5+
"rollForward": "latestFeature"
6+
}
7+
}

0 commit comments

Comments
 (0)