Skip to content

Commit d815c73

Browse files
committed
Update docs to match v3.2.0 & fix minor issues
1 parent b73f8fa commit d815c73

14 files changed

Lines changed: 81 additions & 33 deletions

File tree

.vscode/settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"cSpell.words": [
3+
"arithmatex",
34
"ckers",
45
"cking",
56
"fkadd",
@@ -14,10 +15,16 @@
1415
"fksurrender",
1516
"fontawesome",
1617
"fuckingnode",
18+
"googlecloudstorage",
1719
"linenums",
1820
"lockfiles",
21+
"personaplus",
1922
"pkgs",
23+
"preapp",
24+
"sokora",
2025
"therf",
26+
"vuelto",
27+
"zaka",
2128
"zakahacecosas"
2229
]
2330
}

docs/about/roadmap.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ We'll expand (and rarely, but not impossibly, shrink) this roadmap as we make pr
1818
- [x] `fuckingnode setup <project> <setup>` to automatically add preset `tsconfig.json`, `.gitignore`, and `fknode.yaml` files to a project.
1919
- [x] `fuckingnode compat` to show cross-runtime compatibility without the need to open the browser.
2020
- [x] Better installer
21-
- [x] Revamped `.ps1` based installer for Windows.
22-
- [x] New `.sh` based installed for mac and Linux.
21+
- [x] Revamped `.ps1` based installer for :fontawesome-brands-windows: Windows.
22+
- [x] New `.sh` based installed for :simple-apple: macOS and :simple-linux: Linux.
2323
- [x] Cross-runtime migration.
2424
- [x] Bun. Implies generating `bun.lock` in `bun.lockb` projects.
2525
- [x] Deno.
@@ -64,9 +64,9 @@ We'll expand (and rarely, but not impossibly, shrink) this roadmap as we make pr
6464
- [X] Add `launchCmd` to `fklaunch` for users to define how a project should start up.
6565
- [X] Better `migrate` feature.
6666
- [X] Respect exact versions from the previous lockfile.
67-
- [ ] Support `stats`' Recommended Community Standards across:
67+
- [X] Support `stats`' Recommended Community Standards across:
6868
- [X] Deno
69-
- [ ] Cargo
69+
- [X] Cargo
7070

7171
### Version 3.3
7272

docs/about/social.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
77

88
---
99

10-
Our community server is probably the most important part of the community. Sneak peeks, feature suggestions, and important announcements live here.
10+
Our community server is probably the most important part of the community, since sneak peeks, feature suggestions, and important announcements live here.
1111

1212
[:octicons-arrow-right-24: Join us](https://discord.gg/AA2jYAFNmq)
1313

1414
- :fontawesome-brands-bluesky:{ .lg .middle } __[Bluesky](https://bsky.app/profile/fknode.bsky.social)__
1515

1616
---
1717

18-
Basically Twitter but better because these guys kept their bird (I mean it's a butterfly not a bird but you get my point).
18+
It's basically Twitter but better because these guys kept their bird (I mean it's a butterfly and not a bird but you get my point). We post updates and tips here.
1919

2020
[:octicons-arrow-right-24: Follow us](https://bsky.app/profile/fknode.bsky.social)
2121

2222
- :fontawesome-brands-twitter:{ .lg .middle } __[Twitter](https://x.com/FuckingNode)__
2323

2424
---
2525

26-
Users who refer to this platform as "X" instead of "Twitter" will be prohibited from using FuckingNode.
26+
Users who refer to this platform as "X" instead of "Twitter" will be prohibited from using FuckingNode. We make here the same posts we make on Bluesky, literally.
2727

2828
[:octicons-arrow-right-24: Follow us](https://x.com/FuckingNode)
2929

docs/learn/audit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
An attempt to make security reports easier.
44

55
!!! danger "Outdated"
6-
**This section will not be updated until V3.3.** To prevent updates from taking ages, as we've recently planned a full rewrite of this feature, we will not waste our time on fixing a feature that is not considered stable for use anyway.
6+
**This section will not be updated until V3.3**. To prevent updates from taking ages, as we've recently planned a full rewrite of this feature, we will not waste our time on fixing a feature that is not considered stable for use anyway.
77
**Avoid using audit as of now.**
88

99
!!! danger "Work in Progress feature"

docs/manual/commit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You'll see a confirmation like this one, showing what will be made:
3333
Run deno task test
3434
If everything above went alright, commit 0 file(s) to branch v3 with message "test"
3535

36-
- all of this at @zakahacecosas/fuckingnode@3.0.0-alpha.3 C:\Users\Zaka\FuckingNode
36+
- all of this at @zakahacecosas/fuckingnode@3.2.0 C:\Users\Zaka\FuckingNode
3737
Confirm? [y/N]
3838
```
3939

docs/manual/configuration.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ fuckingnode manager add --self
3636

3737
This is our recommended way, as you can run it right after running `npm init` and you don't have to type a long folder name.
3838

39-
**3 /** You also can waste your time opening the config file. It's a plain text file that stores absolute paths separated by line breaks. On Windows it lives at your local `%APPDATA%`, and on Linux & mac it lives on `HOME` (or `XDG_CONFIG_HOME`). It looks kinda like this:
39+
**3 /** You also can waste your time opening the config file. It's a plain text file that stores absolute paths separated by line breaks. On :fontawesome-brands-windows: Windows it lives at your local `%APPDATA%`, and on :simple-linux: Linux & :simple-apple: macOS it lives on `HOME` (or `XDG_CONFIG_HOME`). It looks kinda like this:
4040

4141
```txt title="fuckingnode-motherfuckers.txt" linenums="1"
4242
C:\Users\JohnDoe\projects\Sokora
@@ -76,15 +76,16 @@ The above would work as long as you have one added project with this package.jso
7676

7777
### Listing projects
7878

79-
Just run `fuckingnode manager list`. It'll beautifully show you all of your projects in a `name@version path` format, kinda like this (but with colors and cool stuff):
79+
Just run `fuckingnode manager list`. It'll beautifully show you all of your projects in a `name@version path` format, like below, but with colors and cool stuff.
8080

8181
```bash
8282
💡 Here are the m*therf*ckers you added so far:
8383

84-
personaplus@0.0.6-preapp.29 C:\\Users\\Zaka\\personaplus
85-
@zakahacecosas/fuckingnode@3.1.0 C:\\Users\\Zaka\\FuckingNode
86-
@zakahacecosas/string-utils@1.11.0 C:\\Users\\Zaka\\string-utils
87-
...
84+
sokora@0.3.0 /home/zaka/Code/Sokora
85+
vuelto.pp.ua@v1.1.2 /home/zaka/Code/vuelto
86+
personaplus-website@0.1.0 /home/zaka/Code/personaplus-website
87+
personaplus@0.0.6-preapp.30 /home/zaka/Code/personaplus
88+
@zakahacecosas/fuckingnode@3.1.1 /home/zaka/Code/FuckingNode
8889
```
8990

9091
Later on we'll see how to "ignore" projects; here we'll tell you that you can pass `--ignored` to only list ignored projects, or `--alive` to only list non-ignored projects. If you try to mix both flags to create a loophole and break the matrix, you won't break anything; the flag you write first will overrule the second one.
@@ -128,7 +129,7 @@ fuckingnode settings change update-freq 15
128129

129130
### Additional settings commands
130131

131-
Settings includes an additional `flush` command, that takes a `<file>` (`logs`, `updates`, `projects`, or `all`) as an argument, removing that from F\*ckingNode's configuration. Removing `logs` is particularly recommended. Removals of `projects` and `all` are discouraged - by the way, yes, we store all logs in a `.log` file, it lives in `%APPDATA%/FuckingNode` on Windows and `/home/USER/.config/FuckingNode` on Linux & macOS.
132+
Settings includes an additional `flush` command, that takes a `<file>` (`logs`, `updates`, `projects`, or `all`) as an argument, removing that from F\*ckingNode's configuration. Removing `logs` is particularly recommended. Removals of `projects` and `all` are discouraged - by the way, yes, we store all logs in a `.log` file, it lives in `%APPDATA%/FuckingNode` on :fontawesome-brands-windows: Windows and `/home/USER/.config/FuckingNode` on :simple-linux: Linux & :simple-apple: macOS.
132133

133134
There's another settings command, `settings repair`. It simply resets settings to defaults.
134135

docs/manual/fknode-yaml.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,43 @@ Specifies a task to be executed upon running the `commit` command.
154154
commitCmd: "commit" # equals "npm run commit"
155155
```
156156

157+
## launchCmd
158+
159+
Specifies a task to be executed upon running the `launch` command. Only used for NodeJS and Bun, analog to [`launchFile`](#launchfile) in other runtimes.
160+
161+
- **Type**: `string`
162+
- **Example**:
163+
164+
```yaml
165+
launchCmd: "start" # equals "npm run start"
166+
```
167+
168+
## launchFile
169+
170+
Specifies a path to a code file to be executed upon running the `launch` command. Only used for DenoJS, Cargo and Golang, analog to [`launchCmd`](#launchcmd) in other runtimes.
171+
172+
- **Type**: `string`
173+
- **Example**:
174+
175+
```yaml
176+
launchFile: "src/main.go" # runs "<PROJECT-ROOT>/src/main.go"
177+
```
178+
179+
## launchWithUpdate
180+
181+
Specifies whether to update a project's dependencies upon running the `launch` command. False by default.
182+
183+
- **Type**: `boolean`
184+
- **Example**:
185+
186+
```yaml
187+
launchWithUpdate: true # updates deps of a project when launching it
188+
```
189+
157190
---
158191

192+
## Full sample
193+
159194
This is an example of a full `fknode.yaml` file.
160195

161196
```yaml
@@ -177,10 +212,12 @@ flagless:
177212
releaseCmd: "release"
178213
releaseAlwaysDry: true
179214
commitCmd: "commit"
215+
launchCmd: "dev"
216+
launchWithUpdate: true
180217
```
181218

182219
---
183220

184-
You've now learn how to configure each project to your liking.
221+
You've now learnt how to configure each project to your liking.
185222

186223
Next: Kickstart - Now proceed a bunch of extra features from the CLI to enhance productivity; kickstart is the first one.

docs/manual/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ For further learning:
2525

2626
## TL;DR for getting started as soon as possible
2727

28+
### Step 0
29+
30+
Install it for your platform following the instructions [here](./install.md) (just like any professional tool, installation is as easy as running one CLI command).
31+
2832
### Step 1
2933

3034
Add your projects to FuckingNode's project list. This is done manually with the `fuckingnode manager add <path>` (or `fkadd <path>`) command. `<path>` can be any file path, or `--self` to use the CWD.

docs/manual/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ First thing first, install the CLI:
44

55
## Standard installation
66

7-
### Microsoft Windows
7+
### :fontawesome-brands-windows: Microsoft Windows
88

99
Copy and paste the following code in a terminal session.
1010

1111
```powershell
1212
powershell -c "irm fuckingnode.github.io/install.ps1 | iex"
1313
```
1414

15-
### Linux and macOS
15+
### :simple-linux: Linux and :simple-apple: macOS
1616

1717
Copy and paste the following code in a terminal session.
1818

1919
```bash
2020
curl -fsSL fuckingnode.github.io/install.sh | bash
2121
```
2222

23-
### Nix / NixOS
23+
### :simple-nixos: Nix / NixOS
2424

2525
!!! warning
2626
ARM (`aarch64-linux`) support is available, but NOT tested!
@@ -41,7 +41,7 @@ Then, add this to your system packages:
4141
inputs.fuckingnode.packages."${pkgs.system}".default;
4242
```
4343

44-
## Compile from source
44+
## :simple-deno: Compile from source
4545

4646
For contributors and nerds who clone the entire source just to change one line they don't like, compiling is extremely easy:
4747

docs/manual/launch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> `fuckingnode launcher <project>`, or `fklaunch <project>`
44
5-
The `launch` command is a simple extra command that automatically launches your favorite editor with a project open and updates your dependencies. It can take a project's name from the `package.json` / `deno.json` / `Cargo.toml`, so it's as simple as doing `fklaunch my-project`.
5+
The `launch` command is a command that automatically launches your favorite editor with a project open, and automatically runs a "launch task", e.g. `npm run start`. It can also auto-update your dependencies on launch. It can take a project's name from the `package.json` / `deno.json` / `Cargo.toml`, so it's as simple as doing `fklaunch my-project`.
66

77
## Usage
88

@@ -14,6 +14,8 @@ fuckingnode launch < PROJECT >
1414

1515
`PROJECT` is obvious and mandatory. It can be a relative file path, absolute file path, or the project's name as mentioned before.
1616

17+
By default it just launches your favorite editor with your project opened. For us to be able to run a task or update your dependencies, [setup those features from the project's `fknode.yaml` file](./fknode-yaml.md#launchcmd).
18+
1719
---
1820

1921
You've now learnt how to speed up launching your projects.

0 commit comments

Comments
 (0)