Skip to content

Commit 0bc49e4

Browse files
committed
Fix some minor issues with the doc
1 parent 6dd9041 commit 0bc49e4

4 files changed

Lines changed: 28 additions & 6 deletions

File tree

docs/about/roadmap.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,26 @@ This page also lists all minor and major releases since 2.X. Patches aren't list
1010

1111
## 4.X
1212

13+
### Version 4.2 (Released)
14+
15+
- [x] Add more system notification prompts.
16+
- [x] Whenever a cleaning task (e.g. lint) fails.
17+
- [x] When a build finishes.
18+
- [x] Bring back showing more details into the final report.
19+
- [x] Show what features divineProtection prevented (if any).
20+
- [x] (New idea) what features failed (if any).
21+
22+
### Version 4.1 (Released)
23+
24+
- [x] Add settings to enable/disable notifications and their thresholds.
25+
- [x] Always show the cleanup report.
26+
- [x] Remove verbose flags and live output.
27+
1328
### Version 4.0 (Released)
1429

1530
- [x] New features
1631
- [x] `build`, to automate building. Especially useful in JavaScript. This would have a text-config file to define what tasks to run for building a project. It could be used in combination with `release`.
1732
- [x] `release` support for Cargo.
18-
- [ ] Dual release support: using the `FnCPF` from the interop layer to allow publishing the same JavaScript package to both npm and jsr. This would be really helpful as jsr downloads do not always work well with npm projects. (_Not done, rescheduled for v4.1_)
1933
- [x] Rebuild `commit`, so you tell it what files to commit and it:
2034
- [x] Un-stages anything else to avoid committing randomly staged files.
2135
- [x] Doesn't require you to stage the files _before_ (making it useless, as `git commit -a -m` is also just one command), and lets you stage files from the own command.

docs/learn/notifications.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# System notifications
22

3-
By default, `clean`, `migrate`, and `kickstart`, which are considered features that _can_ take a long time, will send a system UI notification if they _do_ take long. Unless you're on DND it should sound - which is the point of it. They're sent so you can safely move away from the terminal and know when we're done, so you can get back to whatever's next as soon as possible.
3+
By default, features considered as ones that _can_ take a long time, will send a system UI notification if they _do_ take long. Unless you're on Do Not Disturb or something, they should sound - which is the point of it. They're sent so you can safely move away from the terminal and know when we're done, so you can get back to whatever's next as soon as possible.
44

5-
These notifications are fired if the running task took more than 30 seconds to complete. This threshold can be disabled, so they're shown even if it takes 1 second. In future versions you'll be able to customize the threshold.
5+
We currently enable this for the following features:
6+
7+
- `clean` (on finish)
8+
- `build` (on finish)
9+
- `migrate` (on finish)
10+
- `kickstart` (on finish)
11+
- `clean` (on error; remember errors don't stop execution here)
12+
13+
On finish notifications are fired if the running task took more than 30 seconds to complete. This threshold can be disabled, so they're shown even if it takes 1 second. In future versions you'll be able to customize the threshold.
614

715
Notifications are enabled by default, but can be disabled if you don't like them.
816

docs/manual/migrate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Using FuckingNode: Migrate a project
22

3-
> `fuckingnode migrate <project> <target>`, or `fklaunch <project> <target>`
3+
> `fuckingnode migrate <target> [project]`, or `fkmigrate <target> [project]`
44
55
The `migrate` command automatically migrates your project from one JS stack to another. For example, from npm to Bun, or from npm to pnpm, or from npm to anything better.
66

@@ -13,7 +13,7 @@ As this can take time, **if it takes long, you'll receive a [system notification
1313
Just run the following:
1414

1515
```bash
16-
fuckingnode migrate <TARGET> <PROJECT>
16+
fuckingnode migrate <TARGET> [PROJECT]
1717
```
1818

1919
`TARGET` is the target package manager (the one to migrate to), can be either npm or pnpm or yarn or deno or bun. `PROJECT` is optional, specifies what project to be migrated, if not provided the CWD is used.

docs/manual/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ fuckingnode clean <PROJECT | --> <INTENSITY | --> [--update] [--lint] [--pretty]
1616

1717
When executed with no arguments, it'll do a cleanup using the default intensity (which is `normal` and can be changed from the [settings](configuration.md#settings)) across all of your projects.
1818

19-
It'll iterate through all of your projects and clean them, showing status updates one by one in the terminal. Once it ends, a report is shown, telling how much time did it take us to clean each individual project. **You'll receive a [system notification](../learn/notifications.md) once done,** so you can switch tabs and focus on something else - you'll know when to come back.
19+
It'll iterate through all of your projects and clean them, showing status updates one by one in the terminal. Once it ends, a report is shown, telling how much time did it take us to clean each individual project, as well as what features were prevented by divine protection and what features errored, if any. **You'll receive a [system notification](../learn/notifications.md) once done,** so you can switch tabs and focus on something else - you'll know when to come back.
2020

2121
## Cleaner intensities, explained
2222

0 commit comments

Comments
 (0)