Skip to content

Commit 2bf14d6

Browse files
committed
Update website for 5.2.0
1 parent c61127f commit 2bf14d6

5 files changed

Lines changed: 25 additions & 100 deletions

File tree

docs/_index.md

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

docs/about/why.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ _And the list goes on..._
1616

1717
## What we fixed, and how
1818

19-
I initially created FuckingNode as a `.ps1` script to automate `npm prune` and `pnpm store prune` across a fixed list of personal projects, and as you can see, it has grown into five major releases, thirteen separate utilities (`clean`, `kickstart`, `release`, `commit`, `uncommit`, `surrender`, `setup`, `stats`, `launch`, `build`, `migrate`, `audit`, `terminate`), DenoJS & BunJS support, and even a small amount of features bridged to Go and Cargo.
19+
I initially created FuckingNode as a `.ps1` script to automate `npm prune` and `pnpm store prune` across a fixed list of personal projects, and as you can see, it has grown into five major releases, more than 12 separate utilities (like `clean`, `kickstart`, `release`, `commit`, `uncommit`, `surrender`, `setup`, `stats`, `launch`, `build`, `migrate`, `audit`, `terminate`), Deno & Bun support, and even a small amount of features bridged to Go and Cargo.
2020

2121
FuckingNode exists because it fixes all of the issues mentioned above.
2222

docs/learn/audit.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ This table is only updated when compatibility changes, don't mind the version nu
123123

124124
| Support | NodeJS npm | NodeJS pnpm | NodeJS yarn | Deno | Bun | Go | Cargo |
125125
| :--------- | ---------- | ----------- | ----------- | ---- | --- | -- | ----- |
126-
| **v4.0.0** | YES | YES | YES | NO | YES | NO | NO |
126+
| **v5.2.0** | YES | YES | YES | YES | YES | NO | NO |
127+
| v4.0.0 | YES | YES | YES | NO | YES | NO | NO |
127128
| v3.3.0 | YES | YES | YES | NO | NO | NO | NO |
128129
| v3.0.0 | EXP | EXP | EXP | NO | NO | NO | NO |
129130
| v2.1.0 | EXP | NO | NO | NO | NO | NO | NO |

docs/manual/configuration.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,14 @@ Currently supported settings are the following. Change them with `settings chang
125125
| :--- | :--- | ---: |
126126
| `default-intensity` | `normal`, `hard`, `hard-only`, `maxim`, or `maxim-only` | Changes the default intensity for the `clean` command. `normal` by default. |
127127
| `update-freq` | A fixed number, represents DAYS. | Changes how frequently the CLI sends an HTTP request for updates. Recommend to be high, as we don't frequently update. Defaults to `5`. |
128-
| `fav-editor` | `vscode`, `sublime`, `emacs`, `atom`, `vscodium`, `notepad++` | Your favorite code editor. Used by `kickstart` and `launch`. VSCode by default. |
128+
| `fav-editor` | `vscode`, `sublime`, `emacs`, `atom`, `vscodium`, `notepad++` | Your favorite code editor. Used by `kickstart` and `launch`. VSCode by default. |
129129
| `default-manager` | `npm`, `pnpm`, `yarn`, `deno`, `bun`, `go`, or `cargo` | Default package manager, for use when we can't guess what to use. Makes most sense to set to a JS one; defaults to `npm`. |
130-
| `notifications` | `true`, `false` | Whether to [use system notifications](../learn/notifications.md). Highly recommended, enabled by default. |
131-
| `notification-threshold` | `true`, `false` | Disabled by default, makes system notifications only fire up if the task to be notified about takes less than the threshold value. |
132-
| `notification-threshold-value` | A fixed number, represents MILLISECONDS. | Threshold value. Defaults to `10000` (10 seconds). |
130+
| `notifications` | `true`, `false` | Whether to [use system notifications](../learn/notifications.md). Highly recommended, enabled by default. |
131+
| `notification-threshold` | `true`, `false` | Disabled by default, makes system notifications only fire up if the task to be notified about takes less than the threshold value. |
132+
| `notification-threshold-value` | A fixed number, represents MILLISECONDS. | Threshold value. Defaults to `10000` (10 seconds). |
133133
| `always-short-circuit-cleanup` | `true`, `false` | Disabled by default, makes `clean` immediately halt if an error happens. See [this](usage.md#note-about-error-handling). |
134+
| `kickstart-root` | A file path | Unset by default, automatically roots kickstarted projects to there instead of the current working directory. Useful if you have a main "projects" folder or something similar. |
135+
| `workspace-policy` | `standalone` or `unified` | Unset by default. If set, when adding a project with workspaces, you won't be prompted for how to handle them; `standalone` handling will add each workspace individually and `unified` handling will add just the root. |
134136

135137
### View current settings
136138

docs/manual/fknode-yaml.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,19 @@ releaseCmd:
281281
- $release # e.g. 'npm run release'
282282
```
283283

284+
### kickstartCmd
285+
286+
Specifies a CmdSet to be executed upon cloning the project with the `kickstart`.
287+
288+
- **Type**: `CmdSet`
289+
- **Example**:
290+
291+
```yaml
292+
kickstartCmd:
293+
- =tasks/setup-env.mjs
294+
- ~echo 'project is now ready to work on!'
295+
```
296+
284297
---
285298

286299
## Full sample
@@ -318,6 +331,9 @@ buildCmd:
318331
- =build.ts
319332
- ~mv ./out ./dist
320333
buildForRelease: true
334+
kickstartCmd:
335+
- =tasks/setup-env.mjs
336+
- ~echo 'project is now ready to work on!'
321337
```
322338

323339
---

0 commit comments

Comments
 (0)