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>, orfkadd <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)
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
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 | |
|---|---|
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>, orfkrem <project>
As easy as using one of the previously mentioned methods, but instead of using add, using remove.
However, there's one more thing. Thanks to our innovative expertise, you can use a project's name (as in package.json > "name"):
The above would work as long as you have one added project with this package.json:
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 them. Change them with settings change <KEY> <value>
| KEY | Value Type | Description |
|---|---|---|
defaultIntensity |
normal, hard, hard-only, maxim, or maxim-only |
Changes the default intensity for the clean command. |
updateFreq |
A fixed number | Changes how frequently (in DAYS) the CLI sends an HTTP request for updates. We recommend setting it to a high value as we don't frequently update. |
flushFreq |
A fixed number | Changes how frequently (in DAYS) the CLI removes the .log file to save up space. Cannot be disabled, setting it to 0 will make it auto-flush each time. |
favEditor |
vscode, sublime, emacs, atom, vscodium, notepad++ |
Your favorite code editor. Used by kickstart and launch. |
showNotifications |
true, false |
Whether to use system notifications. Highly recommended |
thresholdNotifications |
true, false |
Enabled by default, makes system notifications only fire up if the task to be notified about takes less than 30 seconds. |
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. updateFreq
Default cleaner intensity | normal. defaultIntensity
Favorite code editor | vscode. favEditor
Auto-flush log file | Every 14 days. flushFreq
Send system notifications | Enabled. showNotifications
Threshold notifications (30") | Disabled. thresholdNotifications
As you can see, you're shown at the end the key used to change a setting (it appears italic in your terminal, if supported).
Change settings¶
To change them, execute fuckingnode settings change (KEY) (VALUE), for example:
Additional settings commands¶
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.
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?