Skip to content

Commit 1668c62

Browse files
committed
Update docs for v3.4.0
1 parent 5c615cc commit 1668c62

5 files changed

Lines changed: 54 additions & 18 deletions

File tree

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
Works with any NodeJS, Deno, or BunJS project. Even Go and Rust are partially supported![^1]
2323

24-
[:octicons-arrow-right-24: Cross-platform support](learn/cross-runtime-support.md)
24+
[:octicons-arrow-right-24: Cross-runtime support](learn/cross-runtime-support.md)
2525

2626
- :material-speedometer:{ .lg .middle } **Speed up your workflow**
2727

docs/learn/audit.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,12 @@ F\*ckingNode audit should not be allowed to have the final say over whether brea
118118

119119
## Availability
120120

121-
Where `EXP` indicates experimental, `CAVEAT` indicates partial support / support with known flaws, and `YES` and `NO` indicate the obvious.
121+
Where `EXP` indicates only experimental support, and `YES` and `NO` indicate the obvious.
122122

123123
| Support | NodeJS npm | NodeJS pnpm | NodeJS yarn | Deno | Bun | Go | Cargo |
124124
| :--------- | ---------- | ----------- | ----------- | ---- | --- | -- | ----- |
125-
| **v3.0.0** | EXP | EXP | EXP | NO | NO | NO | NO |
125+
| v3.3.0 | YES | YES | YES | NO | NO | NO | NO |
126+
| v3.0.0 | EXP | EXP | EXP | NO | NO | NO | NO |
126127
| v2.1.0 | EXP | NO | NO | NO | NO | NO | NO |
127128

128129
*[RF]: Risk Factor; a percentage computed by us to estimate the joint impact of all vulnerabilities of a NodeJS project.

docs/learn/cross-runtime-support.md

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

88
While FuckingNode can be a very powerful automation tool if properly used, in the end it's just an executable that _automates_ tasks; it doesn't do much on its own. Thus, **features that aren't supported by a runtime itself, won't work with us**. (Adding "polyfills" or "glue fixes" is not discarded as an idea, but not planned short-term anyway).
99

10-
You can run `compat` anytime from the CLI to see a table showing what works and what doesn't. **NodeJS is the only environment with 100% platform support.** As of version 3.3.0, that table looks like this:
10+
You can run `compat` anytime from the CLI to see a table showing what works and what doesn't. **NodeJS is the only environment with 100% platform support.** As of version 3.3.1, that table looks like this:
1111

1212
| Feature | NodeJS | Deno | Bun | Go | Cargo |
1313
|------------|--------|----------|----------|----------|----------|
@@ -19,6 +19,7 @@ You can run `compat` anytime from the CLI to see a table showing what works and
1919
| Surrender | Yes | Yes | Yes | Yes | Yes |
2020
| Setup | Yes | Yes | Yes | Yes | Yes |
2121
| Audit | Yes | No | No | No | No |
22+
| Launch | Yes | Yes | Yes | Yes | Yes |
2223

2324
Reasons for not supporting a feature are the following.
2425

@@ -38,18 +39,14 @@ We might add them in the future, for now they're not supported because they're h
3839

3940
`commitCmd` is not supported by these platforms. This is because Cargo and Go don't have "JS-like `run`" tasks.
4041

41-
## Partial Deno, Cargo & Go support for stats
42+
## Partial Go support for stats
4243

43-
These platforms _do_ support it but don't support the Recommended Community Standards part.
44-
45-
**Deno & Cargo**: It's planned to be added.
46-
47-
**Go**: `go.mod` doesn't have any field that can be compared to anything. No module name, no author, no license, etc...
44+
Golang _do_ support it but doesn't support the Recommended Community Standards part. `go.mod` doesn't have any field that can be compared to anything. No module name, no author, no license, etc...
4845

4946
## No Cargo & Go support for migrate
5047

5148
There's a single package manager for these platforms, `migrate` is useless.
5249

5350
## No audit support anywhere non NodeJS
5451

55-
Deno and Bun do not offer an `audit` command, neither does Go.
52+
Deno and Bun do not offer an `audit` command, neither do Go nor Cargo.

docs/manual/kickstart.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# Using FuckingNode: Kickstart a project
22

3-
> `fuckingnode kickstart <repo-url> [file-path] [package manager]`
3+
> `fuckingnode kickstart <repo-url> [file-path] [package manager]`, or `fkstart <repo-url> [file-path] [package manager]`
44
5-
The `kickstart` command is an extra command that increases even more your productivity. It does the following, from a single command:
5+
The `kickstart` command is an extra command that increases your productivity by doing all of the following from a single command:
66

77
- Clones a Git repo wherever you want
88
- Installs dependencies automatically using the project's default package manager (or at your choice, another one).
9-
- Launches your favorite code editor (defaults to VSCode, as seen on settings).
10-
- Adds the project to F\*ckingNode.
11-
12-
Of course, it only works with NodeJS (or Deno or Bun) projects.
9+
- Launches your favorite code editor (as defined by your user settings).
10+
- Adds the project to the F\*ckingNode list.
1311

1412
## Usage
1513

@@ -21,7 +19,45 @@ fuckingnode kickstart < REPO-URL > [PATH] [PKG MANAGER]
2119

2220
`REPO-URL` is obvious and mandatory. `PATH` is optional and defines the path where you want us to clone the project. If not provided, we'll create a directory in the CWD with the name of the repository (just as Git would do by default).
2321

24-
`PKG MANAGER` only works with NodeJS projects and lets you override the project's package manager, so a project that's using `npm` gets cloned with, for example, `pnpm` instead. In Bun or Deno this is ignored, and their default install commands are used.
22+
`PKG MANAGER` lets you override the project's package manager, so a project that's using `npm` gets its dependencies installed with, for example, `pnpm` instead.
23+
24+
## Git scopes / shorthands
25+
26+
We make your workflow faster by making you type this:
27+
28+
```bash
29+
fkstart https://github.com/jonathan/some_app.git
30+
```
31+
32+
instead of this:
33+
34+
```bash
35+
git clone https://github.com/jonathan/some_app.git
36+
cd dev-utils
37+
npm install
38+
code .
39+
```
40+
41+
You can save a few extra seconds, however, by typing this instead:
42+
43+
```bash
44+
fkstart gh:jonathan/some_app
45+
```
46+
47+
and we'll convert that into `https://github.com/jonathan/some_app.git`. And it's not just GitHub that we support, there are plenty of shorthands:
48+
49+
| Alias | Points to | That means |
50+
|:------|:---------------------|:-----------------------------------|
51+
| gh | GitHub | github.com/USER/REPO |
52+
| gl | GitLab | gitlab.com/USER/REPO |
53+
| bb | Bitbucket | bitbucket.org/USER/REPO |
54+
| sr | SourceForge | sourceforge.net/p/USER/REPO |
55+
| bbp | Bitbucket Pipelines | bitbucket.org/USER/REPO/pipelines |
56+
| gist | GitHub Gist | gist.github.com/USER/REPO |
57+
| cb | Codeberg | codeberg.org/USER/REPO |
58+
| gt | Gitee | gitee.com/USER/REPO |
59+
| fg | Framagit | framagit.org/USER/REPO |
60+
| op | OpenPrivacy Git | git.openprivacy.ca/USER/REPO |
2561

2662
---
2763

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ plugins:
102102
"crossruntime.md": "learn/cross-runtime-support.md"
103103
"crossplatform.md": "learn/cross-runtime-support.md"
104104
"follow-us.md": "about/social.md"
105+
"why.md": "about/why.md"
106+
"motivation.md": "about/why.md"
105107

106108
markdown_extensions:
107109
- abbr

0 commit comments

Comments
 (0)