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
When debugging a project, it's super helpful to attach a debugger to the CLI. If you use VS Code, here's how you can do it:
93
+
When debugging a project, it's super helpful to attach a debugger to the CLI. If you use VS Code, here's how you can do
94
+
it:
95
95
96
96
1. Open this repository in VS Code.
97
-
2. Open a "JavaScript Debug Terminal" (e.g. by searching for it in the Command Palette (Shift-Cmd+P)). Every Node process that's opened in this terminal will have a debugger attached.
98
-
3. Place a breakpoint somewhere in the CLI. You will have to place them in the compiled `.js` files as opposed to the `.ts` files.
97
+
2. Open a "JavaScript Debug Terminal" (e.g. by searching for it in the Command Palette (Shift-Cmd+P)). Every Node
98
+
process that's opened in this terminal will have a debugger attached.
99
+
3. Place a breakpoint somewhere in the CLI. You will have to place them in the compiled `.js` files as opposed to the
100
+
`.ts` files.
99
101
4. In your JavaScript Debug Terminal, navigate to the project you'd like to debug.
100
102
5. Run `/path/to/netlify/cli/bin/run.js`. The debugger should be connecting automatically.
101
103
@@ -113,9 +115,9 @@ A good place to start is reading the base command README and looking at the comm
113
115
114
116
> If you’d like to learn more on how `netlify dev` works, check [here](./docs/netlify-dev.md)
115
117
116
-
117
118
### Adding or updating a command
118
-
If you're adding a new command or updating an existing one, make sure to also add docs for it by running `npm run site:build`.
119
+
120
+
If you're adding a new command or updating an existing one, make sure to also add docs for it by running `npm run docs`.
119
121
120
122
This will automatically generate documentation for you that will look like the following:
When adding a new command, you will also need to add it to the nav sidebar manually by adding it to the `navOrder` array in `site/src/_app.js`
137
+
When adding a new command, you will also need to add it to the nav sidebar manually by adding it to the `navOrder` array
138
+
in `site/src/_app.js`
137
139
138
140
### Updating our documentation
139
141
140
142
If documentation looks to be out of date, it is likely that the code for the command itself is not correct.
141
143
142
-
To update the documentation, update the code (rather than the markdown files) and then run `npm run docs` to sync the docs. To confirm that the changes to the docs are correct, run `cd site && npm run dev:start` to run the docs locally.
143
-
144
+
To update the documentation, update the code (rather than the markdown files) and then run `npm run docs` to sync the
145
+
docs. To confirm that the changes to the docs are correct, run `cd site && npm run dev:start` to run the docs locally.
144
146
145
147
### Testing
146
148
@@ -200,7 +202,8 @@ We actively welcome your pull requests.
200
202
201
203
## Releasing
202
204
203
-
Tag the 'release' pull request using the `automerge` label. This will merge the pull request on GitHub and publish the package to npm.
205
+
Tag the 'release' pull request using the `automerge` label. This will merge the pull request on GitHub and publish the
0 commit comments