typal - npm Package Compare versions

Comparing version 1.24.10 to 1.24.11

CHANGELOG.md

 ## 18 December 2019
 
+### [1.24.11](https://github.com/artdecocode/typal/compare/v1.24.10...v1.24.11)
+
+- [fix] Add location to the template.
+
 ### [1.24.10](https://github.com/artdecocode/typal/compare/v1.24.9...v1.24.10)
@@ -4,0 +8,0 @@

compile/index.js

@@ -7,10 +7,7 @@ const { _parseFile, _getLinks } = require('./typal')
  * @param {string=} [namespace] Namespace to ignore in types and properties.
- * @return {{
-    namespace: string,
-    types: !Array<!_typal.Type>,
-    imports: !Array<!_typal.Import>
-  }}
+ * @param {string=} [location] The path to the file. Used to resolve relative paths for examples.
+ * @return {{ namespace: string, types: !Array<!_typal.Type>, imports: !Array<!_typal.Import> }}
  */
-function parseFile(xml, namespace) {
-  return _parseFile(xml, namespace)
+function parseFile(xml, namespace, location) {
+  return _parseFile(xml, namespace, location)
 }
@@ -17,0 +14,0 @@

compile/template.js

@@ -6,4 +6,4 @@ const { _parseFile, _getLinks } = require('./typal')
  */
-function parseFile(xml, namespace) {
-  return _parseFile(xml, namespace)
+function parseFile(xml, namespace, location) {
+  return _parseFile(xml, namespace, location)
 }
@@ -27,3 +27,6 @@
 /**
+ * @typedef {import('../types').Import} _typal.Import
+ */
+/**
  * @typedef {import('../types').LinkingOptions} _typal.LinkingOptions
  */

package.json

 {
   "name": "typal",
-  "version": "1.24.10",
+  "version": "1.24.11",
   "description": "Organises TypeDefs By Placing Them Into Types.Xml File To Be Embedded Into Source Code Compatible With VSCode And Google Closure Compiler, Generates Externs And Allows To Place Documentation In README Markdown.",
@@ -5,0 +5,0 @@ "main": "compile/index.js",

types/externs.js

@@ -15,7 +15,2 @@ /**
 /**
- * The type's namespace, e.g., `_typal`. Default `null`.
- * @type {?string}
- */
-_typal.Type.prototype.namespace
-/**
  * The name of the type.
@@ -26,2 +21,7 @@ * @type {string}
 /**
+ * The type of the type. Default `null`.
+ * @type {?string}
+ */
+_typal.Type.prototype.type
+/**
  * An overriding type for closure to generate externs, e.g., `function(string): boolean` instead of `(s:string) => boolean`. Default `null`.
@@ -67,6 +67,6 @@ * @type {?string}
 /**
- * The type of the type. Default `null`.
+ * The type's namespace, e.g., `_typal`. Default `null`.
  * @type {?string}
  */
-_typal.Type.prototype.type
+_typal.Type.prototype.namespace
 /**
@@ -171,7 +171,2 @@ * The namespace or an empty string.
 /**
- * Function properties can have arguments specified inside of their tags. Default `null`.
- * @type {Array<!_typal.Arg>}
- */
-_typal.Property.prototype.args
-/**
  * The name of the property.
@@ -182,2 +177,7 @@ * @type {string}
 /**
+ * The description of the property. Default `null`.
+ * @type {?string}
+ */
+_typal.Property.prototype.description
+/**
  * The type of the property. Default `*`.
@@ -203,6 +203,6 @@ * @type {string}
 /**
- * The description of the property. Default `null`.
- * @type {?string}
+ * Function properties can have arguments specified inside of their tags. Default `null`.
+ * @type {Array<!_typal.Arg>}
  */
-_typal.Property.prototype.description
+_typal.Property.prototype.args
 /**
@@ -209,0 +209,0 @@ * Whether the property is a function which was parsed. Default `false`.

types/index.js

@@ -7,4 +7,4 @@ export {}
  * @typedef {Object} _typal.Type `＠interface` A representation of a type.
- * @prop {?string} namespace The type's namespace, e.g., `_typal`. Default `null`.
  * @prop {string} name The name of the type.
+ * @prop {?string} type The type of the type. Default `null`.
  * @prop {?string} closureType An overriding type for closure to generate externs, e.g., `function(string): boolean` instead of `(s:string) => boolean`. Default `null`.
@@ -18,3 +18,3 @@ * @prop {?string} description The description of the type. Default `null`.
  * @prop {!Array<!(_typal.Property|_typal.Fn)>} properties The properties of the type. Default `[]`.
- * @prop {?string} type The type of the type. Default `null`.
+ * @prop {?string} namespace The type's namespace, e.g., `_typal`. Default `null`.
  * @prop {string} ns The namespace or an empty string.
@@ -57,4 +57,4 @@ * @prop {string} fullName The type name with the namespace if it has with one.
  * @typedef {Object} _typal.Property `＠interface` A property of a type.
- * @prop {Array<!_typal.Arg>} args Function properties can have arguments specified inside of their tags. Default `null`.
  * @prop {string} name The name of the property.
+ * @prop {?string} description The description of the property. Default `null`.
  * @prop {string} type The type of the property. Default `*`.
@@ -64,3 +64,3 @@ * @prop {boolean} hasDefault Whether the property has the default value. Default `false`.
  * @prop {boolean} optional If the property is optional. Default `false`.
- * @prop {?string} description The description of the property. Default `null`.
+ * @prop {Array<!_typal.Arg>} args Function properties can have arguments specified inside of their tags. Default `null`.
  * @prop {boolean} isParsedFunction Whether the property is a function which was parsed. Default `false`.
@@ -67,0 +67,0 @@ * @prop {!Array<string>} aliases What aliases the property has. Default `[]`.

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

471646

increased by0.06%

No dependency changes