Using FuckingNode: Setup a project¶
fuckingnode setup <project-path> [setup]
Don't mess terms up
It's not the same to setup FuckingNode (configure the CLI first time) than to use fuckingnode setup (here)
The setup
command in F*ckingNode basically adds a pre-made text-config file (like a preset tsconfig.json
or a preset fknode.yaml
). There's currently few setups (we refer to each "preset" / "template" / ... as a setup); however they're easy to add, so soon we'll likely have a setup for every use case. You could contribute your own, too .
Usage¶
To list available setups, run:
You'll see something like the following:
┌───────────────────────┬───────────────────────────────────────────────────────────────────────┐
│ Name │ Description │
├───────────────────────┼───────────────────────────────────────────────────────────────────────┤
│ fknode-basic │ A very basic fknode.yaml file. │
│ fknode-allow-all │ An fknode.yaml file that allows every feature to run (commits too!). │
│ gitignore-js │ A gitignore file for JavaScript projects. │
│ gitignore-js-nolock │ A gitignore file for JavaScript projects (also ignores lockfiles). │
│ ts-strictest │ Strictest way of TypeScripting, ensuring cleanest code. │
│ ts-library │ Recommended config for libraries. │
│ editorconfig-default │ A basic .editorconfig file that works for everyone. │
└───────────────────────┴───────────────────────────────────────────────────────────────────────┘
You either didn't provide a project / target setup or provided invalid ones, so up here are all possible setups.
Then, to apply a setup, run:
project-path
is obvious and mandatory, setup
is also mandatory and is the name of the setup. When listing setups you'll see their names (and a brief description).
You've now learnt how to quickly get your text-config files ready.
Next: Stats (can't think of a description for this one).