Skip to content

Commit be28fc9

Browse files
committed
Update our motivation page + Fix minor issues
1 parent f0429ff commit be28fc9

3 files changed

Lines changed: 17 additions & 22 deletions

File tree

docs/about/branding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can use our logo just as you'd use any app's logo in a post, video, or any k
1010

1111
## The name
1212

13-
Ideally, capitalize it as FuckingNode. Preferably use the **Mona Sans** typography, and [open source font](https://github.com/mona-sans) we use for our main branding. The asterisk (F*ckingNode) is optional. If used, censor the U and not any other letter (avoid things like <s>F\*\*kingNode</s>).
13+
Ideally, capitalize it as FuckingNode. Preferably use the **Mona Sans** typography, an [open source font](https://github.com/mona-sans) we use for our main branding. The asterisk (F*ckingNode) is optional. If used, censor the U and not any other letter (avoid things like <s>F\*\*kingNode</s>).
1414

1515
### Can acronyms or abbreviations be used?
1616

docs/about/why.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What we wanted to fix
44

5-
FuckingNode exists because of the many problems that exist and a JavaScript developer may encounter, including but not limited to:
5+
FuckingNode exists because of the many problems that a JavaScript developer can encounter, including but not limited to:
66

77
- How tiring it is to go through all of your projects to update dependencies.
88
- How boring it is to manually make "Lint code" or "Format code" commits periodically.
@@ -16,53 +16,48 @@ _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 three major releases, seven separate utilities (`clean`, `kickstart`, `release`, `commit`, `surrender`, `setup`, `stats`) with more to come (like the work in progress `audit`), DenoJS & BunJS support, and even a small amount of features bridged to Go and Cargo (Rust).
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 four major releases, eleven separate utilities (`clean`, `kickstart`, `release`, `commit`, `surrender`, `setup`, `stats`, `launch`, `build`, `migrate`, `audit`), DenoJS & BunJS support, and even a small amount of features bridged to Go and Cargo.
2020

2121
FuckingNode is a thing because it fixes all of the issues mentioned above.
2222

23-
### Bored of manually updating dependencies, linting code, or prettifying code?
24-
25-
### Bored of committing all of that?
26-
27-
### Bored of removing built output / artifacts?
23+
### Bored of manually updating dependencies, linting code, or prettifying code? Of committing all of that? Of removing built output / artifacts?
2824

2925
- [X] `fuckingnode clean -- -- --lint --pretty --commit --destroy --update`
30-
- Shorthand: `fkclean -- -- -l -p -c -d -u`
31-
- Assuming [flagless features](../manual/fknode-yaml.md#flagless) are enabled, it can be shortened to just `fkclean`
26+
- Shorthand: `fkclean -- -- -l -p -c -d -u`.
27+
- Assuming [flagless features](../manual/fknode-yaml.md#flagless) are enabled, it can be shortened to just `fkclean`.
3228

3329
### Bored of finding and pasting or writing your own `tsconfig.json`?
3430

35-
- [X] `fuckingnode setup <path> ts-strictest`
36-
- `<path>` is the path to the project, or `--self` to use the CWD.
37-
- `ts-strictest` is an example, there are more setups available. Run `fuckingnode setup` with no args to see them all.
31+
- [X] `fuckingnode setup ts-strictest`
32+
- `ts-strictest` is an example, there are more setups available. Run `fuckingnode setup` to see them all.
3833

3934
### Bored of manually cloning, installing, and launching?
4035

4136
- [X] `fuckingnode kickstart <git-url> [path] [manager]`
4237
- Shorthand: `fkstart <git-url> [path] [manager]`
38+
- `<git-url>` can be not just a Git URL, but also a shorthand (e.g., `gh:Owner/Repo` for GitHub, or `gl:*` for GitLab).
4339
- `[path]` is optional and specifies a custom path to clone to.
4440
- `[manager]` is optional and overrides the package manager to use for this project.
4541

4642
### Bored of manually writing a deprecation notice?
4743

4844
- [X] `fuckingnode surrender <path> [message] [alternatives] [learn-more]`
49-
- `<path>` is the path to the project, or `--self` to use the CWD.
45+
- `<path>` is the path to the project, or `.` to use the CWD.
5046
- `[message]` is optional and adds a custom message.
5147
- `[alternatives]` is optional and lets you write about alternatives to what is going to be deprecated.
5248
- `[learn-more]` is optional and lets you write a text or link about where the user can learn more about this deprecation.
5349

5450
### Scared of the pain of making a commit forgetting your tests?
5551

56-
- [X] `fuckingnode commit <message> [branch] [--push]`
57-
- Shorthand: `fkcommit <message> [branch] [--push]`
52+
- [X] `fuckingnode commit <message> <...files> [--branch=x] [--push]`
53+
- Shorthand: `fkcommit <message> <...files> [--branch=x] [--push]`
5854
- `<message>` is your commit message.
59-
- `[branch]` is optional and specifies the branch to commit to. If unspecified, current branch is used.
55+
- `--branch=*` is optional and specifies the branch to commit to. If unspecified, current active branch is used.
6056
- `--push` is optional and if passed the commit (and any previous local commit) will be pushed.
6157

6258
### Tired of the annoyance of npm or jsr package releases?
6359

64-
- [X] `fuckingnode release <path> <version> [--push] [--dry]`
65-
- `<path>` is the path to the project, or `--self` to use the CWD.
60+
- [X] `fuckingnode release <version> [--push] [--dry]`
6661
- `<version>` is the version to be released, we'll auto bump your package file's version field and create a Git tag with this version code. Must be SemVer parsable.
6762
- `--push` is optional and if passed, changes will be pushed to Git.
6863
- `--dry` is optional and if passed, changes will be done (and pushed if specified), but not published to npm / jsr.

docs/manual/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Install it for your platform following [the instructions here](./install.md) (ju
3232

3333
### Step 1
3434

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

3737
```bash
3838
# relative
@@ -41,10 +41,10 @@ fuckingnode add "../projects/project1"
4141
fuckingnode add "/home/Zaka/Code/project2"
4242
# self path
4343
cd project3
44-
fuckingnode add --self
44+
fuckingnode add .
4545
```
4646

47-
It's recommended that from now on you run `fkadd --self` immediately after running `npm init` (or `pnpm init` or whatever) each time you create a project.
47+
It's recommended that from now on you run `fkadd .` immediately after running `npm init` (or `pnpm init` or whatever) each time you create a project.
4848

4949
### Step 2
5050

0 commit comments

Comments
 (0)