You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/about/roadmap.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,9 @@ This page also lists all minor and major releases since 2.X. Patches aren't list
8
8
9
9
**Patch releases are made on a weekly basis, and feature releases are made on a monthly basis.** You can check more info in [our release schedule document here](https://github.com/FuckingNode/FuckingNode/blob/master/RELEASE_SCHEDULE.md).
10
10
11
+
!!! warning
12
+
This page is no longer actively maintained. This does not mean that development is not planned to continue.
Copy file name to clipboardExpand all lines: docs/learn/errors.md
-13Lines changed: 0 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -183,16 +183,3 @@ If FuckingNode references a file embedded within the binary that's indeed not em
183
183
`Internal__Lazy`
184
184
185
185
More casual way to call a "NotImplemented" error. If we're lazy to finish a feature or can't finish it on time to fullfil our [release schedule](https://github.com/FuckingNode/FuckingNode/blob/master/RELEASE_SCHEDULE.md), instead of removing references to the feature we'll make it trigger this error, indicating we were indeed lazy to implement it.
186
-
187
-
## External errors
188
-
189
-
!!! warning
190
-
This category will be removed by version 5.1, and these errors will be moved somewhere else.
191
-
192
-
Errors that depend on something external.
193
-
194
-
### Setting / Favorite IDE
195
-
196
-
`External__Setting__FavIde`
197
-
198
-
If you changed your favorite IDE to something unsupported, then got us to attempt to launch it, this happens. You cannot directly set this setting to something invalid, you'd have to manually edit the config file - making this an "external" error.
Copy file name to clipboardExpand all lines: docs/manual/configuration.md
+33-21Lines changed: 33 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,14 +55,14 @@ fkn add ./*
55
55
# this will check every folder
56
56
```
57
57
58
-
**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 :fontawesome-brands-windows: Windows it lives at your local `%APPDATA%`, and on :simple-linux: Linux & :simple-apple: macOS it lives on `HOME` (or `XDG_CONFIG_HOME`). It looks kinda like this:
58
+
**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 :fontawesome-brands-windows: Windows it lives at your local `%APPDATA%`, and on :simple-linux: Linux & :simple-apple: macOS it lives on `HOME` (or `XDG_CONFIG_HOME`). It looks like this:
**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).
65
+
**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`), the entire CLI will just break.
66
66
67
67
**Once you're done with adding your projects, you can** theoretically **skip the rest of the page and get started with [using the CLI](usage.md)**. Keep reading for learning the rest about configuring the CLI.
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):
82
+
## Smart Project Referencing
83
+
84
+
There's one more thing to `fkn remove` (and to many more commands). **Thanks to our innovative expertise, you can use a project's _name_ (as in `package.json > "name"`, or your runtime's equivalent)**:
83
85
84
86
```bash
85
87
fkn remove flamethrower
@@ -97,6 +99,13 @@ The above would work as long as you have one added project with this `package.js
97
99
98
100
It also works for `deno.json`, `Cargo.toml`...
99
101
102
+
Some facts:
103
+
104
+
- Any command that takes a project as an input can take a name, except for illogical things like `fkn add`.
105
+
- Feature's _not_ officially called "Smart Project Referencing".
106
+
- If two projects have the same name... there's no code to explicitly handle it, actually. This thing reads the project list in order, so first one to have the name wins.
107
+
- We like to consider our beloved users "smart". Be smart enough not to keep duplicate project names.
108
+
100
109
## Listing projects
101
110
102
111
Just run `fkn list`. It'll beautifully show you all of your projects in a table like below, but with CLI colors and cool stuff.
@@ -109,30 +118,31 @@ Just run `fkn list`. It'll beautifully show you all of your projects in a table
[deno+deno] @zakahacecosas/fuckingnode v5.3.0 /home/zaka/Code/FuckingNode (protected from cleaner)
114
122
```
115
123
116
-
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.
124
+
Data is shown as `[Runtime+PackageManager] ([Name] (v[Version])) [Root] [DivineProtection]`.
125
+
126
+
Later on we'll see how to "protect" projects; here we'll tell you that you can pass `--ignored` to only list protected projects (or ignored; later we'll talk about terminology), 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.
117
127
118
128
## Settings
119
129
120
-
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.
130
+
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; for example if you don't use Visual Studio Code (your "favorite editor" by default).
121
131
122
132
Currently supported settings are the following. Change them with `settings change <KEY> <value>`
123
133
124
-
| KEY | Value Type | Description |
125
-
| :--- | :--- | ---: |
126
-
|`default-intensity`|`normal`, `hard`, `hard-only`, `maxim`, or `maxim-only`| Changes the default intensity for the `clean` command. `normal` by default. |
127
-
|`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`. |
128
-
|`fav-editor`|`vscode`, `sublime`, `emacs`, `atom`, `vscodium`, `notepad++`| Your favorite code editor. Used by `kickstart` and `launch`. VSCode by default. |
129
-
|`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`. |
130
-
|`notifications`|`true`, `false`| Whether to [use system notifications](../learn/notifications.md). Highly recommended, enabled by default. |
131
-
|`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. |
132
-
|`notification-threshold-value`| A fixed number, represents MILLISECONDS. |Threshold value. Defaults to `10000` (10 seconds). |
133
-
|`always-short-circuit-cleanup`|`true`, `false`|Disabled by default, makes`clean` immediately halt if an error happens. See [this](usage.md#note-about-error-handling). |
134
-
|`kickstart-root`| A file path |Unset by default, automatically roots kickstarted projects to there instead of the current working directory. Useful if you have a main "projects" folder or something similar. |
135
-
|`workspace-policy`|`standalone` or `unified`|Unset by default. If set, when adding a project with workspaces, you won't be prompted for how to handle them; `standalone` handling will add each workspace individually and `unified` handling will add just the root. |
134
+
| KEY | Value Type |Default |Description |
135
+
| :--- | :--- | ---: | ---: |
136
+
|`default-intensity`|`normal`, `hard`, `hard-only`, `maxim`, or `maxim-only`|`normal`|Changes the default intensity for the `clean` command. |
137
+
|`update-freq`| A fixed number, represents DAYS. |5 |Changes how frequently the CLI sends an HTTP request for updates. Recommend to be high, as we don't frequently update. |
138
+
|`fav-editor`|`vscode`, `sublime`, `emacs`, `atom`, `vscodium`, `notepad++`|`vscode`|Your favorite code editor. Used by `kickstart` and `launch`. |
139
+
|`default-manager`|`npm`, `pnpm`, `yarn`, `deno`, `bun`, `go`, or `cargo`|`npm`| Used when a manager is required and we can't guess what to use. |
140
+
|`notifications`|`true`, `false`|`true`|Whether to [use system notifications](../learn/notifications.md). Highly recommended. |
141
+
|`notification-threshold`|`true`, `false`|`false`| Makes system notifications only fire up if the task to be notified about takes more than the threshold value. |
|`always-short-circuit-cleanup`|`true`, `false`|`false`| Makes`clean` immediately halt if an error happens. See [this](usage.md#note-about-error-handling). |
144
+
|`kickstart-root`| A file path |(Undefined) | Automatically roots kickstarted projects to there instead of the current working directory. Useful if you have a main "projects" folder or something similar. |
145
+
|`workspace-policy`|`standalone` or `unified`|(Undefined) | If set, when adding a project with workspaces, you won't be prompted for how to handle them; `standalone` handling will add each workspace individually and `unified` handling will add just the root. |
Copy file name to clipboardExpand all lines: docs/manual/surrender.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Below, in case you provided additional params, like `learn-more` or `alternative
28
28
At the end, there will always be a small disclaimer looking like this:
29
29
30
30
!!! quote "The disclaimer shown looks like this:"
31
-
This project was _automatically deprecated_ using the FuckingNode v5.0.0 CLI utility (found at [this repo](https://github.com/FuckingNode/FuckingNode/)), and this message was auto-generated based on their input - so if something feels off, it might be because of that. Below proceeds the old README from this project, unedited
31
+
This project was _automatically deprecated_ using the FuckingNode v5.3.0 CLI utility (found at [this repo](https://github.com/FuckingNode/FuckingNode/)), and this message was auto-generated based on their input - so if something feels off, it might be because of that. Below proceeds the old README from this project, unedited
32
32
33
33
Below is an example of how a full deprecation README, assuming example values for all optional arguments, could look like.
0 commit comments