Skip to content

Commit 2b61d18

Browse files
author
Andy
authored
Merge pull request microsoft#14985 from Microsoft/jsdoc-format
Enable jsdoc-format lint rule
2 parents 56510f1 + 73cab09 commit 2b61d18

37 files changed

Lines changed: 1400 additions & 1399 deletions

‎src/compiler/checker.ts‎

Lines changed: 85 additions & 84 deletions
Large diffs are not rendered by default.

‎src/compiler/commandLineParser.ts‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -860,9 +860,9 @@ namespace ts {
860860
}
861861

862862
/**
863-
* Read tsconfig.json file
864-
* @param fileName The path to the config file
865-
*/
863+
* Read tsconfig.json file
864+
* @param fileName The path to the config file
865+
*/
866866
export function readConfigFile(fileName: string, readFile: (path: string) => string): { config?: any; error?: Diagnostic } {
867867
let text = "";
868868
try {
@@ -875,10 +875,10 @@ namespace ts {
875875
}
876876

877877
/**
878-
* Parse the text of the tsconfig.json file
879-
* @param fileName The path to the config file
880-
* @param jsonText The text of the config file
881-
*/
878+
* Parse the text of the tsconfig.json file
879+
* @param fileName The path to the config file
880+
* @param jsonText The text of the config file
881+
*/
882882
export function parseConfigFileTextToJson(fileName: string, jsonText: string, stripComments = true): { config?: any; error?: Diagnostic } {
883883
try {
884884
const jsonTextToParse = stripComments ? removeComments(jsonText) : jsonText;
@@ -1083,12 +1083,12 @@ namespace ts {
10831083
}
10841084

10851085
/**
1086-
* Parse the contents of a config file (tsconfig.json).
1087-
* @param json The contents of the config file to parse
1088-
* @param host Instance of ParseConfigHost used to enumerate files in folder.
1089-
* @param basePath A root directory to resolve relative path entries in the config
1090-
* file to. e.g. outDir
1091-
*/
1086+
* Parse the contents of a config file (tsconfig.json).
1087+
* @param json The contents of the config file to parse
1088+
* @param host Instance of ParseConfigHost used to enumerate files in folder.
1089+
* @param basePath A root directory to resolve relative path entries in the config
1090+
* file to. e.g. outDir
1091+
*/
10921092
export function parseJsonConfigFileContent(json: any, host: ParseConfigHost, basePath: string, existingOptions: CompilerOptions = {}, configFileName?: string, resolutionStack: Path[] = [], extraFileExtensions: JsFileExtensionInfo[] = []): ParsedCommandLine {
10931093
const errors: Diagnostic[] = [];
10941094
basePath = normalizeSlashes(basePath);

‎src/compiler/comments.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ namespace ts {
411411
* Determine if the given comment is a triple-slash
412412
*
413413
* @return true if the comment is a triple-slash comment else false
414-
**/
414+
*/
415415
function isTripleSlashComment(commentPos: number, commentEnd: number) {
416416
// Verify this is /// comment, but do the regexp match only when we first can find /// in the comment text
417417
// so that we don't end up computing comment string and doing match for all // comments

‎src/compiler/core.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1358,7 +1358,7 @@ namespace ts {
13581358

13591359
/**
13601360
* Returns length of path root (i.e. length of "/", "x:/", "//server/share/, file:///user/files")
1361-
*/
1361+
*/
13621362
export function getRootLength(path: string): number {
13631363
if (path.charCodeAt(0) === CharacterCodes.slash) {
13641364
if (path.charCodeAt(1) !== CharacterCodes.slash) return 1;

‎src/compiler/moduleNameResolver.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,13 +249,13 @@ namespace ts {
249249
}
250250

251251
/**
252-
* Given a set of options, returns the set of type directive names
253-
* that should be included for this program automatically.
254-
* This list could either come from the config file,
255-
* or from enumerating the types root + initial secondary types lookup location.
256-
* More type directives might appear in the program later as a result of loading actual source files;
257-
* this list is only the set of defaults that are implicitly included.
258-
*/
252+
* Given a set of options, returns the set of type directive names
253+
* that should be included for this program automatically.
254+
* This list could either come from the config file,
255+
* or from enumerating the types root + initial secondary types lookup location.
256+
* More type directives might appear in the program later as a result of loading actual source files;
257+
* this list is only the set of defaults that are implicitly included.
258+
*/
259259
export function getAutomaticTypeDirectiveNames(options: CompilerOptions, host: ModuleResolutionHost): string[] {
260260
// Use explicit type list from tsconfig.json
261261
if (options.types) {

‎src/compiler/transformers/destructuring.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,8 @@ namespace ts {
490490
};
491491

492492
/** Given value: o, propName: p, pattern: { a, b, ...p } from the original statement
493-
* `{ a, b, ...p } = o`, create `p = __rest(o, ["a", "b"]);`*/
493+
* `{ a, b, ...p } = o`, create `p = __rest(o, ["a", "b"]);`
494+
*/
494495
function createRestCall(context: TransformationContext, value: Expression, elements: BindingOrAssignmentElement[], computedTempVariables: Expression[], location: TextRange): Expression {
495496
context.requestEmitHelper(restHelper);
496497
const propertyNames: Expression[] = [];

‎src/compiler/transformers/es2015.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ namespace ts {
315315
* Sets the `HierarchyFacts` for this node prior to visiting this node's subtree, returning the facts set prior to modification.
316316
* @param excludeFacts The existing `HierarchyFacts` to reset before visiting the subtree.
317317
* @param includeFacts The new `HierarchyFacts` to set before visiting the subtree.
318-
**/
318+
*/
319319
function enterSubtree(excludeFacts: HierarchyFacts, includeFacts: HierarchyFacts) {
320320
const ancestorFacts = hierarchyFacts;
321321
hierarchyFacts = (hierarchyFacts & ~excludeFacts | includeFacts) & HierarchyFacts.AncestorFactsMask;
@@ -328,7 +328,7 @@ namespace ts {
328328
* @param ancestorFacts The `HierarchyFacts` of the ancestor to restore after visiting the subtree.
329329
* @param excludeFacts The existing `HierarchyFacts` of the subtree that should not be propagated.
330330
* @param includeFacts The new `HierarchyFacts` of the subtree that should be propagated.
331-
**/
331+
*/
332332
function exitSubtree(ancestorFacts: HierarchyFacts, excludeFacts: HierarchyFacts, includeFacts: HierarchyFacts) {
333333
hierarchyFacts = (hierarchyFacts & ~excludeFacts | includeFacts) & HierarchyFacts.SubtreeFactsMask | ancestorFacts;
334334
}

‎src/compiler/types.ts‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -819,7 +819,7 @@ namespace ts {
819819
body?: FunctionBody;
820820
}
821821

822-
/** For when we encounter a semicolon in a class declaration. ES6 allows these as class elements.*/
822+
/** For when we encounter a semicolon in a class declaration. ES6 allows these as class elements. */
823823
export interface SemicolonClassElement extends ClassElement {
824824
kind: SyntaxKind.SemicolonClassElement;
825825
parent?: ClassDeclaration | ClassExpression;
@@ -1397,11 +1397,11 @@ namespace ts {
13971397
}
13981398

13991399
/**
1400-
* This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to
1401-
* ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be
1402-
* JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type
1403-
* ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.)
1404-
**/
1400+
* This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to
1401+
* ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be
1402+
* JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type
1403+
* ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.)
1404+
*/
14051405
export interface ObjectLiteralExpressionBase<T extends ObjectLiteralElement> extends PrimaryExpression, Declaration {
14061406
properties: NodeArray<T>;
14071407
}
@@ -2330,9 +2330,9 @@ namespace ts {
23302330
readDirectory(rootDir: string, extensions: string[], excludes: string[], includes: string[]): string[];
23312331

23322332
/**
2333-
* Gets a value indicating whether the specified path exists and is a file.
2334-
* @param path The path to test.
2335-
*/
2333+
* Gets a value indicating whether the specified path exists and is a file.
2334+
* @param path The path to test.
2335+
*/
23362336
fileExists(path: string): boolean;
23372337

23382338
readFile(path: string): string;
@@ -2680,8 +2680,7 @@ namespace ts {
26802680
errorModuleName?: string; // If the symbol is not visible from module, module's name
26812681
}
26822682

2683-
/** Indicates how to serialize the name for a TypeReferenceNode when emitting decorator
2684-
* metadata */
2683+
/** Indicates how to serialize the name for a TypeReferenceNode when emitting decorator metadata */
26852684
/* @internal */
26862685
export enum TypeReferenceSerializationKind {
26872686
Unknown, // The TypeReferenceNode could not be resolved. The type name

‎src/compiler/utilities.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,13 +1036,13 @@ namespace ts {
10361036
}
10371037

10381038
/**
1039-
* Given an super call/property node, returns the closest node where
1040-
* - a super call/property access is legal in the node and not legal in the parent node the node.
1041-
* i.e. super call is legal in constructor but not legal in the class body.
1042-
* - the container is an arrow function (so caller might need to call getSuperContainer again in case it needs to climb higher)
1043-
* - a super call/property is definitely illegal in the container (but might be legal in some subnode)
1044-
* i.e. super property access is illegal in function declaration but can be legal in the statement list
1045-
*/
1039+
* Given an super call/property node, returns the closest node where
1040+
* - a super call/property access is legal in the node and not legal in the parent node the node.
1041+
* i.e. super call is legal in constructor but not legal in the class body.
1042+
* - the container is an arrow function (so caller might need to call getSuperContainer again in case it needs to climb higher)
1043+
* - a super call/property is definitely illegal in the container (but might be legal in some subnode)
1044+
* i.e. super property access is illegal in function declaration but can be legal in the statement list
1045+
*/
10461046
export function getSuperContainer(node: Node, stopOnFunctions: boolean): Node {
10471047
while (true) {
10481048
node = node.parent;
@@ -4499,9 +4499,9 @@ namespace ts {
44994499
}
45004500

45014501
/**
4502-
* Checks to see if the locale is in the appropriate format,
4503-
* and if it is, attempts to set the appropriate language.
4504-
*/
4502+
* Checks to see if the locale is in the appropriate format,
4503+
* and if it is, attempts to set the appropriate language.
4504+
*/
45054505
export function validateLocaleAndSetLanguage(
45064506
locale: string,
45074507
sys: { getExecutingFilePath(): string, resolvePath(path: string): string, fileExists(fileName: string): boolean, readFile(fileName: string): string },

‎src/harness/fourslash.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2205,7 +2205,7 @@ namespace FourSlash {
22052205
/**
22062206
* Applies fixes for the errors in fileName and compares the results to
22072207
* expectedContents after all fixes have been applied.
2208-
2208+
*
22092209
* Note: applying one codefix may generate another (eg: remove duplicate implements
22102210
* may generate an extends -> interface conversion fix).
22112211
* @param expectedContents The contents of the file after the fixes are applied.

0 commit comments

Comments
 (0)