@microsoft/tsdoc - npm Package Compare versions

Comparing version 0.12.15 to 0.12.16

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "0.12.16",
+      "tag": "@microsoft/tsdoc_v0.12.16",
+      "date": "Tue, 19 Nov 2019 22:01:56 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.12.15",
@@ -7,0 +19,0 @@ "tag": "@microsoft/tsdoc_v0.12.15",

CHANGELOG.md

 # Change Log - @microsoft/tsdoc
 
-This log was last generated on Sat, 09 Nov 2019 05:55:42 GMT and should not be manually modified.
+This log was last generated on Tue, 19 Nov 2019 22:01:56 GMT and should not be manually modified.
 
+## 0.12.16
+Tue, 19 Nov 2019 22:01:56 GMT
+
+### Patches
+
+- Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config
+
 ## 0.12.15
@@ -6,0 +13,0 @@ Sat, 09 Nov 2019 05:55:42 GMT

lib/configuration/TSDocConfiguration.d.ts

@@ -16,3 +16,6 @@ import { TSDocTagDefinition } from './TSDocTagDefinition';
     /**
-     * The TSDoc block tag names that will be interpreted as modifier tags.
+     * The TSDoc tags that are defined in this configuration.
+     *
+     * @remarks
+     * The subset of "supported" tags is tracked by {@link TSDocConfiguration.supportedTagDefinitions}.
      */
@@ -19,0 +22,0 @@ readonly tagDefinitions: ReadonlyArray<TSDocTagDefinition>;

lib/configuration/TSDocConfiguration.js

@@ -25,3 +25,6 @@ "use strict";
         /**
-         * The TSDoc block tag names that will be interpreted as modifier tags.
+         * The TSDoc tags that are defined in this configuration.
+         *
+         * @remarks
+         * The subset of "supported" tags is tracked by {@link TSDocConfiguration.supportedTagDefinitions}.
          */
@@ -28,0 +31,0 @@ get: function () {

lib/details/StandardTags.d.ts

@@ -86,3 +86,3 @@ import { TSDocTagDefinition } from '../configuration/TSDocTagDefinition';
      * TODO: The notation for API item references is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -108,3 +108,3 @@ static readonly inheritDoc: TSDocTagDefinition;
      * TODO: The `{@label}` notation is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -120,3 +120,3 @@ static readonly label: TSDocTagDefinition;
      * TODO: The `{@link}` notation is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -123,0 +123,0 @@ static readonly link: TSDocTagDefinition;

lib/details/StandardTags.js

@@ -122,3 +122,3 @@ "use strict";
      * TODO: The notation for API item references is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -152,3 +152,3 @@ StandardTags.inheritDoc = StandardTags._defineTag({
      * TODO: The `{@label}` notation is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -168,3 +168,3 @@ StandardTags.label = StandardTags._defineTag({
      * TODO: The `{@link}` notation is still being standardized.  See this issue:
-     * https://github.com/Microsoft/tsdoc/issues/9
+     * https://github.com/microsoft/tsdoc/issues/9
      */
@@ -171,0 +171,0 @@ StandardTags.link = StandardTags._defineTag({

lib/parser/TSDocMessageId.d.ts

@@ -14,2 +14,33 @@ /**
     /**
+     * File not found
+     * @remarks
+     * Reported by the `@microsoft/tsdoc-config` package when it failed to find a `tsdoc.json` file.
+     */
+    ConfigFileNotFound = "tsdoc-config-file-not-found",
+    /**
+     * Unsupported JSON "$schema" value
+     * @remarks
+     * Reported by the `@microsoft/tsdoc-config` package when the file format is not supported.
+     */
+    ConfigFileUnsupportedSchema = "tsdoc-config-unsupported-schema",
+    /**
+     * Error loading config file: ___
+     * @remarks
+     * Reported by the `@microsoft/tsdoc-config` package when the config file doesn't conform to its schema.
+     */
+    ConfigFileSchemaError = "tsdoc-config-schema-error",
+    /**
+     * Circular reference encountered for "extends" field of "___"
+     * @remarks
+     * Reported by the `@microsoft/tsdoc-config` package when the "extends" field creates a chain of references
+     * that causes a file to indirectly extend itself.
+     */
+    ConfigFileCyclicExtends = "tsdoc-config-cyclic-extends",
+    /**
+     * Unable to resolve "extends" reference to "___"
+     * @remarks
+     * Reported by the `@microsoft/tsdoc-config` package when module resolution fails for the "extends" field.
+     */
+    ConfigFileUnresolvedExtends = "tsdoc-config-unresolved-extends",
+    /**
      * Expecting a `/**` comment.
@@ -16,0 +47,0 @@ * Unexpected end of input.

lib/parser/TSDocMessageId.js

@@ -5,2 +5,7 @@ "use strict";
 exports.allTsdocMessageIds = [
+    'tsdoc-config-file-not-found',
+    'tsdoc-config-unsupported-schema',
+    'tsdoc-config-schema-error',
+    'tsdoc-config-cyclic-extends',
+    'tsdoc-config-unresolved-extends',
     'tsdoc-comment-not-found',
@@ -7,0 +12,0 @@ 'tsdoc-comment-missing-opening-delimiter',

package.json

 {
   "name": "@microsoft/tsdoc",
-  "version": "0.12.15",
+  "version": "0.12.16",
   "description": "A parser for the TypeScript doc comment syntax",
@@ -16,5 +16,5 @@ "keywords": [
     "type": "git",
-    "url": "https://github.com/Microsoft/tsdoc"
+    "url": "https://github.com/microsoft/tsdoc"
   },
-  "homepage": "https://github.com/Microsoft/tsdoc",
+  "homepage": "https://github.com/microsoft/tsdoc",
   "main": "lib/index.js",
@@ -21,0 +21,0 @@ "typings": "lib/index.d.ts",

README.md

@@ -5,4 +5,5 @@ # @microsoft/tsdoc
 
-###  What is TSDoc?
 
+##  What is TSDoc?
+
 **TSDoc** is a proposal to standardize the doc comments used in [TypeScript](http://www.typescriptlang.org/) source files.  It allows different tools to extract content from comments without getting confused by each other's syntax.   The **TSDoc** notation looks pretty familiar:
@@ -34,2 +35,12 @@
 
+
+## API Usage
+
+The [api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo) folder on GitHub illustrates how
+to invoke the TSDoc parser.
+
+A separate NPM package [`@microsoft/tsdoc-config`](https://www.npmjs.com/package/@microsoft/tsdoc)
+is used for loading the **tsdoc.json** file.
+
+
 ## Get involved
@@ -39,2 +50,2 @@
 
-https://github.com/Microsoft/tsdoc
+https://github.com/microsoft/tsdoc

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

752628

increased by0.66%

Number of package files

183

increased by0.55%

Lines of code

13073

increased by0.82%

Number of lines in readme file

49

increased by28.95%

No dependency changes