@microsoft/api-documenter - npm Package Compare versions

Comparing version 7.23.3 to 7.23.4

dist/rollup.d.ts

@@ -9,4 +9,4 @@ /**
 
-import { ApiItem } from '@microsoft/api-extractor-model';
-import { ApiModel } from '@microsoft/api-extractor-model';
+import type { ApiItem } from '@microsoft/api-extractor-model';
+import type { ApiModel } from '@microsoft/api-extractor-model';
 
@@ -13,0 +13,0 @@ /**

lib/cli/GenerateAction.d.ts

@@ -1,2 +0,2 @@
-import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
+import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
@@ -3,0 +3,0 @@ export declare class GenerateAction extends BaseAction {

lib/cli/MarkdownAction.d.ts

@@ -1,2 +0,2 @@
-import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
+import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
@@ -3,0 +3,0 @@ export declare class MarkdownAction extends BaseAction {

lib/cli/YamlAction.d.ts

@@ -1,2 +0,2 @@
-import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
+import type { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
@@ -3,0 +3,0 @@ export declare class YamlAction extends BaseAction {

lib/documenters/DocumenterConfig.d.ts

 import { JsonSchema, NewlineKind } from '@rushstack/node-core-library';
-import { IConfigFile } from './IConfigFile';
+import type { IConfigFile } from './IConfigFile';
 /**
@@ -4,0 +4,0 @@ * Helper for loading the api-documenter.json file format.  Later when the schema is more mature,

lib/documenters/ExperimentalYamlDocumenter.d.ts

@@ -1,5 +0,5 @@
-import { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
-import { IYamlTocFile } from '../yaml/IYamlTocFile';
+import { type ApiModel, type ApiItem } from '@microsoft/api-extractor-model';
+import type { IYamlTocFile } from '../yaml/IYamlTocFile';
 import { YamlDocumenter } from './YamlDocumenter';
-import { DocumenterConfig } from './DocumenterConfig';
+import type { DocumenterConfig } from './DocumenterConfig';
 /**
@@ -6,0 +6,0 @@ * EXPERIMENTAL - This documenter is a prototype of a new config file driven mode of operation for

lib/documenters/IConfigFile.d.ts

@@ -1,2 +0,2 @@
-import { IYamlTocFile } from '../yaml/IYamlTocFile';
+import type { IYamlTocFile } from '../yaml/IYamlTocFile';
 /**
@@ -3,0 +3,0 @@ * Typescript interface describing the config schema for toc.yml file format.

lib/documenters/MarkdownDocumenter.d.ts

@@ -1,3 +0,3 @@
-import { ApiModel } from '@microsoft/api-extractor-model';
-import { DocumenterConfig } from './DocumenterConfig';
+import { type ApiModel } from '@microsoft/api-extractor-model';
+import type { DocumenterConfig } from './DocumenterConfig';
 export interface IMarkdownDocumenterOptions {
@@ -4,0 +4,0 @@ apiModel: ApiModel;

lib/documenters/OfficeYamlDocumenter.d.ts

@@ -1,4 +0,4 @@
-import { ApiModel } from '@microsoft/api-extractor-model';
-import { IYamlTocItem } from '../yaml/IYamlTocFile';
-import { IYamlItem } from '../yaml/IYamlApiFile';
+import type { ApiModel } from '@microsoft/api-extractor-model';
+import type { IYamlTocItem } from '../yaml/IYamlTocFile';
+import type { IYamlItem } from '../yaml/IYamlApiFile';
 import { YamlDocumenter } from './YamlDocumenter';
@@ -5,0 +5,0 @@ /**

lib/documenters/YamlDocumenter.d.ts

@@ -1,5 +0,5 @@
-import { ApiModel, ApiItem, ApiItemKind } from '@microsoft/api-extractor-model';
-import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
-import { IYamlItem } from '../yaml/IYamlApiFile';
-import { IYamlTocFile, IYamlTocItem } from '../yaml/IYamlTocFile';
+import { type ApiModel, type ApiItem, ApiItemKind } from '@microsoft/api-extractor-model';
+import { type DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import type { IYamlItem } from '../yaml/IYamlApiFile';
+import type { IYamlTocFile, IYamlTocItem } from '../yaml/IYamlTocFile';
 /**
@@ -6,0 +6,0 @@ * Writes documentation in the Universal Reference YAML file format, as defined by typescript.schema.json.

lib/markdown/CustomMarkdownEmitter.d.ts

@@ -1,4 +0,4 @@
-import { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
-import { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
-import { MarkdownEmitter, IMarkdownEmitterContext, IMarkdownEmitterOptions } from './MarkdownEmitter';
+import type { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
+import type { ApiModel, ApiItem } from '@microsoft/api-extractor-model';
+import { MarkdownEmitter, type IMarkdownEmitterContext, type IMarkdownEmitterOptions } from './MarkdownEmitter';
 export interface ICustomMarkdownEmitterOptions extends IMarkdownEmitterOptions {
@@ -5,0 +5,0 @@ contextApiItem: ApiItem | undefined;

lib/markdown/MarkdownEmitter.d.ts

@@ -1,2 +0,2 @@
-import { DocNode, StringBuilder, DocLinkTag } from '@microsoft/tsdoc';
+import { type DocNode, type StringBuilder, type DocLinkTag } from '@microsoft/tsdoc';
 import { IndentedWriter } from '../utils/IndentedWriter';
@@ -3,0 +3,0 @@ export interface IMarkdownEmitterOptions {

lib/nodes/CustomDocNodeKind.js

 "use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,0 +5,0 @@ exports.CustomDocNodes = void 0;

lib/nodes/DocEmphasisSpan.d.ts

@@ -1,2 +0,2 @@
-import { DocNode, DocNodeContainer, IDocNodeContainerParameters } from '@microsoft/tsdoc';
+import { type DocNode, DocNodeContainer, type IDocNodeContainerParameters } from '@microsoft/tsdoc';
 /**
@@ -3,0 +3,0 @@ * Constructor parameters for {@link DocEmphasisSpan}.

lib/nodes/DocHeading.d.ts

@@ -1,2 +0,2 @@
-import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
 /**
@@ -3,0 +3,0 @@ * Constructor parameters for {@link DocHeading}.

lib/nodes/DocNoteBox.d.ts

@@ -1,2 +0,2 @@
-import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
+import { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
 /**
@@ -3,0 +3,0 @@ * Constructor parameters for {@link DocNoteBox}.

lib/nodes/DocTable.d.ts

@@ -1,4 +0,4 @@
-import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
 import { DocTableRow } from './DocTableRow';
-import { DocTableCell } from './DocTableCell';
+import type { DocTableCell } from './DocTableCell';
 /**
@@ -5,0 +5,0 @@ * Constructor parameters for {@link DocTable}.

lib/nodes/DocTableCell.d.ts

@@ -1,2 +0,2 @@
-import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
+import { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
 /**
@@ -3,0 +3,0 @@ * Constructor parameters for {@link DocTableCell}.

lib/nodes/DocTableRow.d.ts

@@ -1,2 +0,2 @@
-import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
 import { DocTableCell } from './DocTableCell';
@@ -3,0 +3,0 @@ /**

lib/plugin/IApiDocumenterPluginManifest.d.ts

@@ -1,3 +0,3 @@
-import { MarkdownDocumenterFeature } from './MarkdownDocumenterFeature';
-import { PluginFeatureInitialization } from './PluginFeature';
+import type { MarkdownDocumenterFeature } from './MarkdownDocumenterFeature';
+import type { PluginFeatureInitialization } from './PluginFeature';
 /**
@@ -4,0 +4,0 @@ * Defines a "feature" that is provided by an API Documenter plugin.  A feature is a user-defined module

lib/plugin/MarkdownDocumenterAccessor.d.ts

@@ -1,2 +0,2 @@
-import { ApiItem } from '@microsoft/api-extractor-model';
+import type { ApiItem } from '@microsoft/api-extractor-model';
 /** @internal */
@@ -3,0 +3,0 @@ export interface IMarkdownDocumenterAccessorImplementation {

lib/plugin/MarkdownDocumenterFeature.d.ts

@@ -1,4 +0,4 @@
-import { ApiItem, ApiModel } from '@microsoft/api-extractor-model';
+import type { ApiItem, ApiModel } from '@microsoft/api-extractor-model';
 import { PluginFeature } from './PluginFeature';
-import { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';
+import type { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';
 /**
@@ -5,0 +5,0 @@ * Context object for {@link MarkdownDocumenterFeature}.

lib/plugin/PluginLoader.d.ts

@@ -1,3 +0,3 @@
-import { MarkdownDocumenterFeature, MarkdownDocumenterFeatureContext } from './MarkdownDocumenterFeature';
-import { DocumenterConfig } from '../documenters/DocumenterConfig';
+import { MarkdownDocumenterFeature, type MarkdownDocumenterFeatureContext } from './MarkdownDocumenterFeature';
+import type { DocumenterConfig } from '../documenters/DocumenterConfig';
 export declare class PluginLoader {
@@ -4,0 +4,0 @@ markdownDocumenterFeature: MarkdownDocumenterFeature | undefined;

lib/utils/IndentedWriter.d.ts

@@ -1,2 +0,2 @@
-import { IStringBuilder } from '@rushstack/node-core-library';
+import { type IStringBuilder } from '@rushstack/node-core-library';
 /**
@@ -3,0 +3,0 @@ * A utility for writing indented text.

lib/utils/ToSdpConvertHelper.js

 "use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -3,0 +5,0 @@ return (mod && mod.__esModule) ? mod : { "default": mod };

lib/utils/Utilities.d.ts

@@ -1,2 +0,2 @@
-import { ApiItem } from '@microsoft/api-extractor-model';
+import { type ApiItem } from '@microsoft/api-extractor-model';
 export declare class Utilities {
@@ -3,0 +3,0 @@ private static readonly _badFilenameCharsRegExp;

lib/yaml/ISDPYamlFile.js

 "use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ISDPYamlFile.js.map

package.json

 {
   "name": "@microsoft/api-documenter",
-  "version": "7.23.3",
+  "version": "7.23.4",
   "description": "Read JSON files from api-extractor, generate documentation pages",
@@ -22,5 +22,5 @@ "repository": {
     "resolve": "~1.22.1",
-    "@microsoft/api-extractor-model": "7.28.0",
-    "@rushstack/node-core-library": "3.60.0",
-    "@rushstack/ts-command-line": "4.16.0"
+    "@microsoft/api-extractor-model": "7.28.1",
+    "@rushstack/node-core-library": "3.60.1",
+    "@rushstack/ts-command-line": "4.16.1"
   },
@@ -30,4 +30,3 @@ "devDependencies": {
     "@types/resolve": "1.20.2",
-    "@rushstack/eslint-config": "3.3.4",
-    "@rushstack/heft": "0.61.1",
+    "@rushstack/heft": "0.61.2",
     "local-node-rig": "1.0.0"
@@ -34,0 +33,0 @@ },

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

609714

increased by0.29%

Dev dependency count

4

decreased by-20%

Lines of code

6644

increased by0.09%

Dependency changes

• + Added@microsoft/api-extractor-model@7.28.1(transitive)

• + Added@rushstack/node-core-library@3.60.1(transitive)

• + Added@rushstack/ts-command-line@4.16.1(transitive)

• - Removed@microsoft/api-extractor-model@7.28.0(transitive)

• - Removed@rushstack/node-core-library@3.60.0(transitive)

• - Removed@rushstack/ts-command-line@4.16.0(transitive)

• Updated@microsoft/api-extractor-model@7.28.1

• Updated@rushstack/node-core-library@3.60.1

• Updated@rushstack/ts-command-line@4.16.1