Skip to content

Commit 4d6b0e8

Browse files
authored
docs: fix correct nodeVersionHint description
1 parent 412c787 commit 4d6b0e8

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

OPTIONS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Environment variables passed to the program. The value <code>null</code> removes the variable from the environment.</p>
1414
<h5>Default value:</h4><pre><code>{}</pre></code><h4>envFile</h4><p>Absolute path to a file containing environment variable definitions.</p>
1515
<h5>Default value:</h4><pre><code>null</pre></code><h4>localRoot</h4><p>Path to the local directory containing the program.</p>
16-
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.</p>
16+
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Allows you to explicitly specify the Node version that&#39;s running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not working.</p>
1717
<h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
1818
<h5>Default value:</h4><pre><code>[
1919
"${workspaceFolder}/**/*.js",
@@ -57,7 +57,7 @@
5757
<h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Environment variables passed to the program. The value <code>null</code> removes the variable from the environment.</p>
5858
<h5>Default value:</h4><pre><code>{}</pre></code><h4>envFile</h4><p>Absolute path to a file containing environment variable definitions.</p>
5959
<h5>Default value:</h4><pre><code>null</pre></code><h4>localRoot</h4><p>Path to the local directory containing the program.</p>
60-
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.</p>
60+
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Allows you to explicitly specify the Node version that&#39;s running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not working.</p>
6161
<h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
6262
<h5>Default value:</h4><pre><code>[
6363
"${workspaceFolder}/**/*.js",
@@ -102,7 +102,7 @@
102102
<h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Environment variables passed to the program. The value <code>null</code> removes the variable from the environment.</p>
103103
<h5>Default value:</h4><pre><code>{}</pre></code><h4>envFile</h4><p>Absolute path to a file containing environment variable definitions.</p>
104104
<h5>Default value:</h4><pre><code>null</pre></code><h4>localRoot</h4><p>Path to the local directory containing the program.</p>
105-
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.</p>
105+
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Allows you to explicitly specify the Node version that&#39;s running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not working.</p>
106106
<h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
107107
<h5>Default value:</h4><pre><code>[
108108
"${workspaceFolder}/**/*.js",
@@ -146,7 +146,7 @@
146146
<h5>Default value:</h4><pre><code>true</pre></code><h4>env</h4><p>Environment variables passed to the program. The value <code>null</code> removes the variable from the environment.</p>
147147
<h5>Default value:</h4><pre><code>{}</pre></code><h4>envFile</h4><p>Absolute path to a file containing environment variable definitions.</p>
148148
<h5>Default value:</h4><pre><code>null</pre></code><h4>localRoot</h4><p>Path to the local directory containing the program.</p>
149-
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.</p>
149+
<h5>Default value:</h4><pre><code>null</pre></code><h4>nodeVersionHint</h4><p>Allows you to explicitly specify the Node version that&#39;s running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not working.</p>
150150
<h5>Default value:</h4><pre><code>undefined</pre></code><h4>outFiles</h4><p>If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with <code>!</code> the files are excluded. If not specified, the generated code is expected in the same directory as its source.</p>
151151
<h5>Default value:</h4><pre><code>[
152152
"${workspaceFolder}/out/**/*.js"

src/build/generate-contributions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ const nodeBaseConfigurationAttributes: ConfigurationAttributes<INodeBaseConfigur
333333
nodeVersionHint: {
334334
type: 'number',
335335
minimum: 8,
336-
description: refString('node.timeout.description'),
336+
description: refString('node.versionHint.description'),
337337
default: 12,
338338
},
339339
};

src/build/strings.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ const strings = {
219219
'node.stopOnEntry.description': 'Automatically stop program after launch.',
220220
'node.timeout.description':
221221
'Retry for this number of milliseconds to connect to Node.js. Default is 10000 ms.',
222-
'node.versionHint.descriotion':
222+
'node.versionHint.description':
223223
"Allows you to explicitly specify the Node version that's running, which can be used to disable or enable certain behaviors in cases where the automatic version detection does not working.",
224224
'timeouts.generalDescription': 'Timeouts for several debugger operations',
225225
'timeouts.generalDescription.markdown': 'Timeouts for several debugger operations',
@@ -271,7 +271,7 @@ const strings = {
271271
'configuration.autoAttachMode':
272272
'Configures which processes to automatically attach and debug when `#debug.node.autoAttach#` is on. A Node process launched with the `--inspect` flag will always be attached to, regardless of this setting.',
273273
'configuration.autoAttachSmartPatterns':
274-
'Configures glob patterns for determing when to attach in "smart" `#debug.javascript.autoAttachFilter#` mode. `$KNOWN_TOOLS$` is replaced with a list of names of common test and code runners. [Read more on the VS Code docs](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_auto-attach-smart-patterns).',
274+
'Configures glob patterns for determining when to attach in "smart" `#debug.javascript.autoAttachFilter#` mode. `$KNOWN_TOOLS$` is replaced with a list of names of common test and code runners. [Read more on the VS Code docs](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_auto-attach-smart-patterns).',
275275
'configuration.autoAttachMode.explicit': 'Only auto attach when the `--inspect` is given.',
276276
'configuration.autoAttachMode.smart':
277277
"Auto attach when running scripts that aren't in a node_modules folder.",

0 commit comments

Comments
 (0)