Skip to content

Commit 366ff93

Browse files
committed
Auto-fix issues.
1 parent 0e54561 commit 366ff93

File tree

597 files changed

+1832
-1358
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

597 files changed

+1832
-1358
lines changed

apps/api-documenter/src/cli/BaseAction.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
// See LICENSE in the project root for license information.
33

44
import * as path from 'path';
5-
import * as tsdoc from '@microsoft/tsdoc';
5+
import type * as tsdoc from '@microsoft/tsdoc';
66
import colors from 'colors/safe';
77

88
import {
99
CommandLineAction,
10-
CommandLineStringParameter,
10+
type CommandLineStringParameter,
1111
type ICommandLineActionOptions
1212
} from '@rushstack/ts-command-line';
1313
import { FileSystem } from '@rushstack/node-core-library';
1414
import {
1515
ApiModel,
16-
ApiItem,
16+
type ApiItem,
1717
ApiItemContainerMixin,
1818
ApiDocumentedItem,
19-
IResolveDeclarationReferenceResult
19+
type IResolveDeclarationReferenceResult
2020
} from '@microsoft/api-extractor-model';
2121

2222
export interface IBuildApiModelResult {

apps/api-documenter/src/cli/GenerateAction.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import * as path from 'path';
55

6-
import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
6+
import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
77
import { BaseAction } from './BaseAction';
88
import { DocumenterConfig } from '../documenters/DocumenterConfig';
99
import { ExperimentalYamlDocumenter } from '../documenters/ExperimentalYamlDocumenter';

apps/api-documenter/src/cli/MarkdownAction.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
4+
import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
55
import { BaseAction } from './BaseAction';
66
import { MarkdownDocumenter } from '../documenters/MarkdownDocumenter';
77

apps/api-documenter/src/cli/YamlAction.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { CommandLineFlagParameter, CommandLineChoiceParameter } from '@rushstack/ts-command-line';
4+
import type { CommandLineFlagParameter, CommandLineChoiceParameter } from '@rushstack/ts-command-line';
55

6-
import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
6+
import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
77
import { BaseAction } from './BaseAction';
88

99
import { YamlDocumenter } from '../documenters/YamlDocumenter';

apps/api-documenter/src/documenters/DocumenterConfig.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import * as path from 'path';
55
import { JsonSchema, JsonFile, NewlineKind } from '@rushstack/node-core-library';
6-
import { IConfigFile } from './IConfigFile';
6+
import type { IConfigFile } from './IConfigFile';
77
import apiDocumenterSchema from '../schemas/api-documenter.schema.json';
88

99
/**

apps/api-documenter/src/documenters/ExperimentalYamlDocumenter.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { DocComment, DocInlineTag } from '@microsoft/tsdoc';
5-
import { ApiModel, ApiItem, ApiItemKind, ApiDocumentedItem } from '@microsoft/api-extractor-model';
4+
import { type DocComment, DocInlineTag } from '@microsoft/tsdoc';
5+
import { type ApiModel, type ApiItem, ApiItemKind, ApiDocumentedItem } from '@microsoft/api-extractor-model';
66

7-
import { IConfigTableOfContents } from './IConfigFile';
8-
import { IYamlTocItem, IYamlTocFile } from '../yaml/IYamlTocFile';
7+
import type { IConfigTableOfContents } from './IConfigFile';
8+
import type { IYamlTocItem, IYamlTocFile } from '../yaml/IYamlTocFile';
99
import { YamlDocumenter } from './YamlDocumenter';
10-
import { DocumenterConfig } from './DocumenterConfig';
10+
import type { DocumenterConfig } from './DocumenterConfig';
1111

1212
/**
1313
* EXPERIMENTAL - This documenter is a prototype of a new config file driven mode of operation for

apps/api-documenter/src/documenters/IConfigFile.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { IYamlTocFile } from '../yaml/IYamlTocFile';
4+
import type { IYamlTocFile } from '../yaml/IYamlTocFile';
55

66
/**
77
* Typescript interface describing the config schema for toc.yml file format.

apps/api-documenter/src/documenters/MarkdownDocumenter.ts

+15-15
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ import {
77
DocSection,
88
DocPlainText,
99
DocLinkTag,
10-
TSDocConfiguration,
10+
type TSDocConfiguration,
1111
StringBuilder,
1212
DocNodeKind,
1313
DocParagraph,
1414
DocCodeSpan,
1515
DocFencedCode,
1616
StandardTags,
17-
DocBlock,
18-
DocComment,
19-
DocNodeContainer
17+
type DocBlock,
18+
type DocComment,
19+
type DocNodeContainer
2020
} from '@microsoft/tsdoc';
2121
import {
22-
ApiModel,
23-
ApiItem,
24-
ApiEnum,
25-
ApiPackage,
22+
type ApiModel,
23+
type ApiItem,
24+
type ApiEnum,
25+
type ApiPackage,
2626
ApiItemKind,
2727
ApiReleaseTagMixin,
2828
ApiDocumentedItem,
@@ -31,21 +31,21 @@ import {
3131
ApiStaticMixin,
3232
ApiPropertyItem,
3333
ApiInterface,
34-
Excerpt,
34+
type Excerpt,
3535
ApiAbstractMixin,
3636
ApiParameterListMixin,
3737
ApiReturnTypeMixin,
3838
ApiDeclaredItem,
39-
ApiNamespace,
39+
type ApiNamespace,
4040
ExcerptTokenKind,
41-
IResolveDeclarationReferenceResult,
41+
type IResolveDeclarationReferenceResult,
4242
ApiTypeAlias,
43-
ExcerptToken,
43+
type ExcerptToken,
4444
ApiOptionalMixin,
4545
ApiInitializerMixin,
4646
ApiProtectedMixin,
4747
ApiReadonlyMixin,
48-
IFindApiItemsResult
48+
type IFindApiItemsResult
4949
} from '@microsoft/api-extractor-model';
5050

5151
import { CustomDocNodes } from '../nodes/CustomDocNodeKind';
@@ -59,10 +59,10 @@ import { Utilities } from '../utils/Utilities';
5959
import { CustomMarkdownEmitter } from '../markdown/CustomMarkdownEmitter';
6060
import { PluginLoader } from '../plugin/PluginLoader';
6161
import {
62-
IMarkdownDocumenterFeatureOnBeforeWritePageArgs,
62+
type IMarkdownDocumenterFeatureOnBeforeWritePageArgs,
6363
MarkdownDocumenterFeatureContext
6464
} from '../plugin/MarkdownDocumenterFeature';
65-
import { DocumenterConfig } from './DocumenterConfig';
65+
import type { DocumenterConfig } from './DocumenterConfig';
6666
import { MarkdownDocumenterAccessor } from '../plugin/MarkdownDocumenterAccessor';
6767

6868
export interface IMarkdownDocumenterOptions {

apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import colors from 'colors';
55
import * as path from 'path';
66
import yaml = require('js-yaml');
77

8-
import { ApiModel } from '@microsoft/api-extractor-model';
8+
import type { ApiModel } from '@microsoft/api-extractor-model';
99
import { FileSystem } from '@rushstack/node-core-library';
1010

11-
import { IYamlTocItem } from '../yaml/IYamlTocFile';
12-
import { IYamlItem } from '../yaml/IYamlApiFile';
11+
import type { IYamlTocItem } from '../yaml/IYamlTocFile';
12+
import type { IYamlItem } from '../yaml/IYamlApiFile';
1313
import { YamlDocumenter } from './YamlDocumenter';
1414

1515
interface ISnippetsFile {

apps/api-documenter/src/documenters/YamlDocumenter.ts

+24-18
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,45 @@ import {
1212
NewlineKind,
1313
InternalError
1414
} from '@rushstack/node-core-library';
15-
import { StringBuilder, DocSection, DocComment, DocBlock, StandardTags } from '@microsoft/tsdoc';
1615
import {
17-
ApiModel,
18-
ApiItem,
16+
StringBuilder,
17+
type DocSection,
18+
type DocComment,
19+
type DocBlock,
20+
StandardTags
21+
} from '@microsoft/tsdoc';
22+
import {
23+
type ApiModel,
24+
type ApiItem,
1925
ApiItemKind,
2026
ApiDocumentedItem,
2127
ApiReleaseTagMixin,
2228
ReleaseTag,
23-
ApiPropertyItem,
29+
type ApiPropertyItem,
2430
ApiItemContainerMixin,
25-
ApiPackage,
26-
ApiEnumMember,
31+
type ApiPackage,
32+
type ApiEnumMember,
2733
ApiClass,
2834
ApiInterface,
29-
ApiMethod,
30-
ApiMethodSignature,
31-
ApiConstructor,
32-
ApiFunction,
35+
type ApiMethod,
36+
type ApiMethodSignature,
37+
type ApiConstructor,
38+
type ApiFunction,
3339
ApiReturnTypeMixin,
3440
ApiTypeParameterListMixin,
35-
Excerpt,
36-
ExcerptToken,
41+
type Excerpt,
42+
type ExcerptToken,
3743
ExcerptTokenKind,
38-
HeritageType,
39-
ApiVariable,
40-
ApiTypeAlias
44+
type HeritageType,
45+
type ApiVariable,
46+
type ApiTypeAlias
4147
} from '@microsoft/api-extractor-model';
4248
import {
43-
DeclarationReference,
49+
type DeclarationReference,
4450
Navigation,
4551
Meaning
4652
} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
47-
import {
53+
import type {
4854
IYamlApiFile,
4955
IYamlItem,
5056
IYamlSyntax,
@@ -53,7 +59,7 @@ import {
5359
IYamlReferenceSpec,
5460
IYamlInheritanceTree
5561
} from '../yaml/IYamlApiFile';
56-
import { IYamlTocFile, IYamlTocItem } from '../yaml/IYamlTocFile';
62+
import type { IYamlTocFile, IYamlTocItem } from '../yaml/IYamlTocFile';
5763
import { Utilities } from '../utils/Utilities';
5864
import { CustomMarkdownEmitter } from '../markdown/CustomMarkdownEmitter';
5965
import { convertUDPYamlToSDP } from '../utils/ToSdpConvertHelper';

apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts

+13-9
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@
33

44
import colors from 'colors';
55

6-
import { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
7-
import { ApiModel, IResolveDeclarationReferenceResult, ApiItem } from '@microsoft/api-extractor-model';
6+
import type { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
7+
import type { ApiModel, IResolveDeclarationReferenceResult, ApiItem } from '@microsoft/api-extractor-model';
88

99
import { CustomDocNodeKind } from '../nodes/CustomDocNodeKind';
10-
import { DocHeading } from '../nodes/DocHeading';
11-
import { DocNoteBox } from '../nodes/DocNoteBox';
12-
import { DocTable } from '../nodes/DocTable';
13-
import { DocTableCell } from '../nodes/DocTableCell';
14-
import { DocEmphasisSpan } from '../nodes/DocEmphasisSpan';
15-
import { MarkdownEmitter, IMarkdownEmitterContext, IMarkdownEmitterOptions } from './MarkdownEmitter';
16-
import { IndentedWriter } from '../utils/IndentedWriter';
10+
import type { DocHeading } from '../nodes/DocHeading';
11+
import type { DocNoteBox } from '../nodes/DocNoteBox';
12+
import type { DocTable } from '../nodes/DocTable';
13+
import type { DocTableCell } from '../nodes/DocTableCell';
14+
import type { DocEmphasisSpan } from '../nodes/DocEmphasisSpan';
15+
import {
16+
MarkdownEmitter,
17+
type IMarkdownEmitterContext,
18+
type IMarkdownEmitterOptions
19+
} from './MarkdownEmitter';
20+
import type { IndentedWriter } from '../utils/IndentedWriter';
1721

1822
export interface ICustomMarkdownEmitterOptions extends IMarkdownEmitterOptions {
1923
contextApiItem: ApiItem | undefined;

apps/api-documenter/src/markdown/MarkdownEmitter.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
// See LICENSE in the project root for license information.
33

44
import {
5-
DocNode,
5+
type DocNode,
66
DocNodeKind,
7-
StringBuilder,
8-
DocPlainText,
9-
DocHtmlStartTag,
10-
DocHtmlEndTag,
11-
DocCodeSpan,
12-
DocLinkTag,
13-
DocParagraph,
14-
DocFencedCode,
15-
DocSection,
7+
type StringBuilder,
8+
type DocPlainText,
9+
type DocHtmlStartTag,
10+
type DocHtmlEndTag,
11+
type DocCodeSpan,
12+
type DocLinkTag,
13+
type DocParagraph,
14+
type DocFencedCode,
15+
type DocSection,
1616
DocNodeTransforms,
17-
DocEscapedText,
18-
DocErrorText,
19-
DocBlockTag
17+
type DocEscapedText,
18+
type DocErrorText,
19+
type DocBlockTag
2020
} from '@microsoft/tsdoc';
2121
import { InternalError } from '@rushstack/node-core-library';
2222

apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import {
55
DocSection,
6-
TSDocConfiguration,
6+
type TSDocConfiguration,
77
DocPlainText,
88
StringBuilder,
99
DocParagraph,
@@ -21,7 +21,7 @@ import { DocTable } from '../../nodes/DocTable';
2121
import { DocTableRow } from '../../nodes/DocTableRow';
2222
import { DocTableCell } from '../../nodes/DocTableCell';
2323
import { CustomMarkdownEmitter } from '../CustomMarkdownEmitter';
24-
import { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
24+
import { ApiModel, type ApiItem } from '@microsoft/api-extractor-model';
2525

2626
test('render Markdown from TSDoc', () => {
2727
const configuration: TSDocConfiguration = CustomDocNodes.configuration;

apps/api-documenter/src/nodes/CustomDocNodeKind.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
2+
// See LICENSE in the project root for license information.
3+
14
import { TSDocConfiguration, DocNodeKind } from '@microsoft/tsdoc';
25
import { DocEmphasisSpan } from './DocEmphasisSpan';
36
import { DocHeading } from './DocHeading';
@@ -6,9 +9,6 @@ import { DocTable } from './DocTable';
69
import { DocTableCell } from './DocTableCell';
710
import { DocTableRow } from './DocTableRow';
811

9-
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
10-
// See LICENSE in the project root for license information.
11-
1212
/**
1313
* Identifies custom subclasses of {@link DocNode}.
1414
*/

apps/api-documenter/src/nodes/DocEmphasisSpan.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { DocNode, DocNodeContainer, IDocNodeContainerParameters } from '@microsoft/tsdoc';
4+
import { type DocNode, DocNodeContainer, type IDocNodeContainerParameters } from '@microsoft/tsdoc';
55
import { CustomDocNodeKind } from './CustomDocNodeKind';
66

77
/**

apps/api-documenter/src/nodes/DocHeading.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
4+
import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
55
import { CustomDocNodeKind } from './CustomDocNodeKind';
66

77
/**

apps/api-documenter/src/nodes/DocNoteBox.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
4+
import { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
55
import { CustomDocNodeKind } from './CustomDocNodeKind';
66

77
/**

apps/api-documenter/src/nodes/DocTable.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4-
import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
4+
import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
55
import { CustomDocNodeKind } from './CustomDocNodeKind';
66
import { DocTableRow } from './DocTableRow';
7-
import { DocTableCell } from './DocTableCell';
7+
import type { DocTableCell } from './DocTableCell';
88

99
/**
1010
* Constructor parameters for {@link DocTable}.

0 commit comments

Comments
 (0)