vue-docgen-api - npm Package Compare versions

Comparing version 4.31.0 to 4.31.1

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+## [4.31.1](https://github.com/vue-styleguidist/vue-styleguidist/compare/v4.31.0...v4.31.1) (2020-08-20)
+
+
+### Bug Fixes
+
+* **docgen:** keep comments in the template in prod ([b9e4a89](https://github.com/vue-styleguidist/vue-styleguidist/commit/b9e4a89817a91731a40671760f7c7dc482090a25)), closes [#942](https://github.com/vue-styleguidist/vue-styleguidist/issues/942)
+
+
+
+
+
 # [4.31.0](https://github.com/vue-styleguidist/vue-styleguidist/compare/v4.30.0...v4.31.0) (2020-08-15)
@@ -8,0 +19,0 @@

dist/Documentation.d.ts

@@ -1,101 +0,3 @@
-export declare type BlockTag = ParamTag | Tag;
-export interface Module {
-    name: string;
-    path: string;
-}
-/**
- * Universal model to display origin
- */
-export interface Descriptor {
-    extends?: Module;
-    mixin?: Module;
-}
-export interface ParamType {
-    name: string;
-    elements?: ParamType[];
-}
-export interface UnnamedParam {
-    type?: ParamType;
-    description?: string | boolean;
-}
-export interface Param extends UnnamedParam {
-    name?: string;
-}
-interface RootTag {
-    title: string;
-}
-export interface Tag extends RootTag {
-    content: string | boolean;
-}
-export interface ParamTag extends RootTag, Param {
-}
-export interface DocBlockTags {
-    description?: string;
-    tags?: Array<ParamTag | Tag>;
-}
-interface EventType {
-    names: string[];
-}
-interface EventProperty {
-    type: EventType;
-    name?: string;
-    description?: string | boolean;
-}
-export interface EventDescriptor extends DocBlockTags, Descriptor {
-    name: string;
-    type?: EventType;
-    properties?: EventProperty[];
-}
-export interface PropDescriptor extends Descriptor {
-    type?: {
-        name: string;
-        func?: boolean;
-    };
-    description?: string;
-    required?: boolean;
-    defaultValue?: {
-        value: string;
-        func?: boolean;
-    };
-    tags?: {
-        [title: string]: BlockTag[];
-    };
-    values?: string[];
-    name: string;
-}
-export interface MethodDescriptor extends Descriptor {
-    name: string;
-    description?: string;
-    returns?: UnnamedParam;
-    throws?: UnnamedParam;
-    tags?: {
-        [key: string]: BlockTag[];
-    };
-    params?: Param[];
-    modifiers?: string[];
-    [key: string]: any;
-}
-export interface SlotDescriptor extends Descriptor {
-    name: string;
-    description?: string;
-    bindings?: ParamTag[];
-    scoped?: boolean;
-    tags?: {
-        [key: string]: BlockTag[];
-    };
-}
-export interface ComponentDoc {
-    displayName: string;
-    exportName: string;
-    description?: string;
-    props?: PropDescriptor[];
-    methods?: MethodDescriptor[];
-    slots?: SlotDescriptor[];
-    events?: EventDescriptor[];
-    tags?: {
-        [key: string]: BlockTag[];
-    };
-    docsBlocks?: string[];
-    [key: string]: any;
-}
+import { Descriptor, PropDescriptor, MethodDescriptor, SlotDescriptor, EventDescriptor, ComponentDoc, DocBlockTags, BlockTag, Param, UnnamedParam, Tag, ParamTag, ParamType } from 'vue-inbrowser-compiler-utils';
+export { Descriptor, PropDescriptor, MethodDescriptor, SlotDescriptor, EventDescriptor, ComponentDoc, DocBlockTags, BlockTag, Param, UnnamedParam, Tag, ParamTag, ParamType };
 export default class Documentation {
@@ -123,2 +25,1 @@ private propsMap;
 }
-export {};

dist/main.d.ts

@@ -1,2 +0,2 @@
-import Documentation, { ComponentDoc, BlockTag, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, Param, Tag, ParamTag, ParamType } from './Documentation';
+import Documentation, { ComponentDoc, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, BlockTag, Param, Tag, ParamTag, ParamType } from './Documentation';
 import { DocGenOptions, ParseOptions } from './parse';
@@ -10,4 +10,3 @@ import * as ScriptHandlers from './script-handlers';
 export { ComponentDoc, DocGenOptions, ParseOptions, Documentation, BlockTag, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, Param, Tag, ParamTag, ParamType };
-export { default as getDefaultExample } from './utils/getDefaultExample';
-export { default as cleanName } from './utils/cleanName';
+export { cleanName, getDefaultExample } from 'vue-inbrowser-compiler-utils';
 /**
@@ -14,0 +13,0 @@ * Parse the component at filePath and return props, public methods, events and slots

dist/main.js

@@ -67,6 +67,5 @@ "use strict";
 exports.TemplateHandlers = TemplateHandlers;
-var getDefaultExample_1 = require("./utils/getDefaultExample");
-exports.getDefaultExample = getDefaultExample_1.default;
-var cleanName_1 = require("./utils/cleanName");
-exports.cleanName = cleanName_1.default;
+var vue_inbrowser_compiler_utils_1 = require("vue-inbrowser-compiler-utils");
+exports.cleanName = vue_inbrowser_compiler_utils_1.cleanName;
+exports.getDefaultExample = vue_inbrowser_compiler_utils_1.getDefaultExample;
 /**
@@ -73,0 +72,0 @@ * Parse the component at filePath and return props, public methods, events and slots

dist/parse-template.js

@@ -33,3 +33,3 @@ "use strict";
             : tpl.content;
-        var ast_1 = cacher_1.default(function () { return compiler_dom_1.parse(source_1); }, source_1);
+        var ast_1 = cacher_1.default(function () { return compiler_dom_1.parse(source_1, { comments: true }); }, source_1);
         var functional_1 = !!tpl.attrs.functional;
@@ -36,0 +36,0 @@ if (functional_1) {

package.json

 {
 	"name": "vue-docgen-api",
-	"version": "4.31.0",
+	"version": "4.31.1",
 	"description": "Toolbox to extract information from Vue component files for documentation generation purposes.",
@@ -33,4 +33,4 @@ "homepage": "https://vue-styleguidist.github.io",
 		"@babel/types": "^7.6.0",
-		"@vue/compiler-dom": "^3.0.0-rc.5",
-		"@vue/compiler-sfc": "^3.0.0-rc.5",
+		"@vue/compiler-dom": "^3.0.0-rc.6",
+		"@vue/compiler-sfc": "^3.0.0-rc.6",
 		"ast-types": "0.13.3",
@@ -41,3 +41,4 @@ "hash-sum": "^1.0.2",
 		"recast": "0.19.1",
-		"ts-map": "^1.0.3"
+		"ts-map": "^1.0.3",
+		"vue-inbrowser-compiler-utils": "^4.31.1"
 	},
@@ -52,3 +53,3 @@ "devDependencies": {
 	},
-	"gitHead": "457eb9cbe453c0ff79ab85f93629956337cd1669"
+	"gitHead": "0c94f679ae9440205744b1a141907d0e2ac3d134"
 }

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

Worsened metrics

Total package byte prevSize

322495

decreased by-1.2%

Dependency count

11

increased by10%

Number of package files

106

decreased by-3.64%

Lines of code

5410

decreased by-3.25%

Dependency changes

• + Addedvue-inbrowser-compiler-utils@^4.31.1

• + Added@vue/reactivity@3.5.12(transitive)

• + Added@vue/runtime-core@3.5.12(transitive)

• + Added@vue/runtime-dom@3.5.12(transitive)

• + Added@vue/server-renderer@3.5.12(transitive)

• + Addedcamelcase@5.3.1(transitive)

• + Addedcsstype@3.1.3(transitive)

• + Addedvue@3.5.12(transitive)

• + Addedvue-inbrowser-compiler-demi@4.71.1(transitive)

• + Addedvue-inbrowser-compiler-independent-utils@4.71.1(transitive)

• + Addedvue-inbrowser-compiler-utils@4.72.4(transitive)

• Updated@vue/compiler-dom@^3.0.0-rc.6

• Updated@vue/compiler-sfc@^3.0.0-rc.6