Skip to content

Commit 79141ae

Browse files
committed
Enable the tsdoc/syntax rule for node-core-library to test it
1 parent 98e4316 commit 79141ae

3 files changed

Lines changed: 6 additions & 2 deletions

File tree

‎libraries/node-core-library/.eslintrc.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ require("@rushstack/eslint-config/patch-eslint6");
44
module.exports = {
55
extends: [ "@rushstack/eslint-config" ],
66
parserOptions: { tsconfigRootDir: __dirname },
7+
8+
// TODO: Remove this once "tsdoc/syntax" is enabled by default
9+
rules: { "tsdoc/syntax": "error" }
710
};

‎libraries/node-core-library/src/LockFile.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const procStatStartTimePos: number = 22;
1919

2020
/**
2121
* Parses the process start time from the contents of a linux /proc/[pid]/stat file.
22-
* @param stat The contents of a linux /proc/[pid]/stat file.
22+
* @param stat - The contents of a linux /proc/[pid]/stat file.
2323
* @returns The process start time in jiffies, or undefined if stat has an unexpected format.
2424
*/
2525
export function getProcessStartTimeFromProcStat (stat: string): string | undefined {

‎stack/eslint-config/index.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ module.exports = {
88
plugins: [
99
"@typescript-eslint/eslint-plugin",
1010
"eslint-plugin-promise",
11-
"eslint-plugin-security"
11+
"eslint-plugin-security",
12+
"eslint-plugin-tsdoc"
1213
],
1314

1415
overrides: [

0 commit comments

Comments
 (0)