Setup FuckingNode¶

Don't mess terms up

It's not the same to setup FuckingNode (here) than to use fuckingnode setup (a separate utility we provide)

Here we'll learn everything about setting up and configuring the CLI to your liking.

Adding a project¶

fuckingnode add <project>, or fkadd <project>

We care about user experience, and that's why we're constantly working to ensure peak performance... blah blah blah TL;DR: you need to add projects yourself so we don't consume your time and CPU looking in your entire drive for JavaScript projects (which trust me, would've been easier for me - kind off).

Note

Some features are addition agnostic, like commit or setup. This means they don't need the project to be added. These features usually don't even require you to be on a "supported platform".

There are 4 ways to add projects:

1 / You can add a relative or absolute path:

fuckingnode add "../projects/something/"
# or
fuckingnode add "C:\Users\Zaka\projects\something"
#                   ^^^^^^^^^^^ (or /home/whatever in linux / mac)

Spreading is supported.

fuckingnode add ./foo ./bar ./baz

2 / You can get in the root of the project and add with no args, or a dot (.)

cd generic-js-project-name-here
fuckingnode add .
# this below does the same and is two characters shorter :nerd:
fuckingnode add

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.

3 / If you have one folder for all your projects, you can use a glob pattern

cd my-projects
fuckingnode add ./*
# this will check every folder

4 / 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 & macOS it lives on HOME (or XDG_CONFIG_HOME). It looks kinda like this:

fuckingnode-motherfuckers.txt
1 2	`C:\Users\Zaka\projects\Sokora C:\Users\Zaka\projects\electronJS-clone`

Keep in mind paths must always point to the root. If any path point to the package.json itself or to anything else that isn't the root of the project (the DIR that holds package.json), you're cooked (the entire CLI won't work).

Once you're done with adding your projects, you can theoretically skip the rest of the page and get started with using the CLI. Keep reading for learning the rest about configuring the CLI.

Removing a project¶

fuckingnode remove <project>, or fkrem <project>

As easy as using one of the previously mentioned methods, but instead of using add, using remove.

fuckingnode remove "../projects/something/"
fuckingnode remove "C:\Users\Zaka\projects\something"
Spreading is supported.

fuckingnode remove ./foo ./bar ./baz

However, there's one more thing. Thanks to our innovative expertise, you can use a project's name (as in package.json > "name", or your runtime's equivalent):

fuckingnode remove flamethrower

The above would work as long as you have one added project with this package.json:

package.json
{
    "name": "flamethrower",
    "version": "6.9.0"
    // etc...
}

It also works for deno.json, Cargo.toml...

Listing projects¶

Just run fuckingnode list. It'll beautifully show you all of your projects in a name@version path format, like below, but with colors and cool stuff.

💡 Here are the m*therf*ckers you added so far:

sokora@0.3.0 /home/Zaka/Code/Sokora
vuelto.pp.ua@v1.1.2 /home/Zaka/Code/vuelto
personaplus-website@0.1.0 /home/Zaka/Code/personaplus-website
personaplus@0.0.6-preapp.30 /home/Zaka/Code/personaplus
@zakahacecosas/fuckingnode@4.0.0 /home/Zaka/Code/FuckingNode
konbini@0.0.1 /home/Zaka/Code/konbini

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.

Settings¶

As most apps, we offer settings you can tweak. We use default values that should work for most people, to save you even more time - however you might want to change them, especially if you don't use Visual Studio Code, as it's your "favorite editor" by default.

Currently supported settings are the following. Change them with settings change <KEY> <value>

KEY	Value Type	Description
`default-intensity`	`normal`, `hard`, `hard-only`, `maxim`, or `maxim-only`	Changes the default intensity for the `clean` command. `normal` by default.
`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`.
`fav-editor`	`vscode`, `sublime`, `emacs`, `atom`, `vscodium`, `notepad++`	Your favorite code editor. Used by `kickstart` and `launch`. VSCode by default.
`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`.
`notifications`	`true`, `false`	Whether to use system notifications. Highly recommended, enabled by default.
`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.
`notification-threshold-value`	A fixed number, represents MILLISECONDS.	Threshold value. Defaults to `10000` (10 seconds).
`always-short-circuit-cleanup`	`true`, `false`	Disabled by default, makes `clean` immediately halt if an error happens. See this.

View current settings¶

To view your current settings, run fuckingnode settings with no args. You should see something like this:

💡 Your current settings are:
---
Check for updates             | Every 5 days. update-freq
Default cleaner intensity     | normal. default-intensity
Default package manager       | npm. default-manager
Favorite code editor          | vscode. fav-editor
Send system notifications     | Enabled. notifications
Threshold notifications?      | Disabled. notification-threshold
Notification threshold        | 10000 milliseconds. notification-threshold
Cleanup error behavior?       | Short-circuit always-short-circuit-cleanup

As you can see, you're shown at the end the key used to change a setting (it appears italic in your terminal).

Change settings¶

To change them, execute fuckingnode settings change (KEY) (VALUE), for example:

fuckingnode settings change default-intensity "hard"
fuckingnode settings change update-freq 15

Additional settings commands¶

Settings includes an additional flush command, that takes a <file> (errors, updates, projects, or all) as an argument, removing said file from FuckingNode's configuration, located at %APPDATA%/FuckingNode on Windows and /home/USER/.config/FuckingNode on Linux & macOS. Removal of projects or all is kinda discouraged.

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

You're now fully setup and ready to put those f*cking JavaScript projects in place!

Next: Usage - How to actually put those f*cking JavaScript projects in place?