typal - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

build/index.js

@@ -7,3 +7,2 @@ const $_lib_Type = require('./lib/Type');
 module.exports.Property = $_lib_Property
-module.exports.getNameWithDefault = $_lib.getNameWithDefault
-//# sourceMappingURL=index.js.map
+module.exports.getNameWithDefault = $_lib.getNameWithDefault

build/lib/index.js

@@ -56,3 +56,2 @@ /**
 module.exports.getPropType = getPropType
-module.exports.getLink = getLink
-//# sourceMappingURL=index.js.map
+module.exports.getLink = getLink

build/lib/Property.js

@@ -44,3 +44,2 @@ const { getPropType, getNameWithDefault } = require('.');
 
-module.exports = Property
-//# sourceMappingURL=Property.js.map
+module.exports = Property

build/lib/Type.js

 let extractTags = require('rexml'); if (extractTags && extractTags.__esModule) extractTags = extractTags.default;
 let mismatch = require('mismatch'); if (mismatch && mismatch.__esModule) mismatch = mismatch.default;
-let Property = require('./Property'); if (Property && Property.__esModule) Property = Property.default;
+const Property = require('./Property');
 const { getLink } = require('.');
@@ -95,2 +95,5 @@
 
+/**
+ * Iterates through the type and creates a link for it.
+ */
        const getLinks = (allTypes, type) => {
@@ -111,3 +114,3 @@ const m = mismatch(
     return typeWithLink
-  }).join('|')
+  }).join(' | ')
   return types
@@ -129,3 +132,3 @@ }
     const d = !prop.hasDefault ? '-' : `\`${prop.default}\``
-    return [name, `_${esc(linkedType)}_`, prop.description, d]
+    return [name, `_${esc(linkedType)}_`, esc(prop.description), d]
   })
@@ -159,3 +162,2 @@ const pre = [h, ...ps]
 module.exports.getLinks = getLinks
-module.exports.makePropsTable = makePropsTable
-//# sourceMappingURL=Type.js.map
+module.exports.makePropsTable = makePropsTable

CHANGELOG.md

@@ -0,1 +1,9 @@
+## 12 March 2019
+
+### 1.2.1
+
+- [package] Add module and `src`.
+- [fix] Escape pipes in description.
+- [fix] Add space before and after `|` in piped types (todo: test when types are given inside of brackets eg `(type|type2)`).
+
 ## 25 September 2018
@@ -2,0 +10,0 @@

package.json

 {
   "name": "typal",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Keeps JSDoc types in XML files and converts them to JavaScript and Markdown.",
-  "main": "build",
+  "main": "build/index.js",
+  "module": "src/index.js",
   "scripts": {
     "t": "zoroaster -a",
-    "test": "yarn t test/spec",
+    "test": "yarn t test/spec test/mask",
+    "mask": "yarn t test/mask",
     "test-build": "ALAMODE_ENV=test-build yarn test",
@@ -14,3 +16,3 @@ "test-all": "yarn-s test test-build",
     "doc": "NODE_DEBUG=doc doc documentary -o README.md",
-    "b": "alamode src -o build",
+    "b": "alamode src -o build -s",
     "d": "NODE_DEBUG=doc doc src/index.js -g",
@@ -23,3 +25,4 @@ "build": "yarn-s d b doc",
   "files": [
-    "build"
+    "build",
+    "src"
   ],
@@ -40,12 +43,12 @@ "repository": {
   "devDependencies": {
-    "alamode": "1.5.1",
-    "documentary": "1.20.0",
+    "alamode": "1.8.4",
+    "documentary": "1.22.0",
     "eslint-config-artdeco": "1.0.1",
     "yarn-s": "1.1.0",
-    "zoroaster": "3.5.1"
+    "zoroaster": "3.8.2"
   },
   "dependencies": {
     "mismatch": "1.0.3",
-    "rexml": "1.1.0"
+    "rexml": "1.3.0"
   }
 }

README.md

@@ -5,3 +5,3 @@ # typal
 
-`typal` is Keeps JSDoc types in XML files and converts them to JavaScript and Markdown.
+`typal` Keeps JSDoc types in XML files and converts them to JavaScript and Markdown.
 
@@ -16,4 +16,3 @@ ```sh
 - [API](#api)
-  * [`typal(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)
-- [TODO](#todo)
+  * [`typal(arg1: string, arg2?: boolean)`](#typalarg1-stringarg2-boolean-void)
 - [Copyright](#copyright)
@@ -42,10 +41,8 @@
 
-## TODO
+```
 
-- [ ] Add a new item to the todo list.
+```
 
 ## Copyright
 
-(c) [Art Deco][1] 2018
-
-[1]: https://artdeco.bz
+<table><tr><th><a href="https://artd.eco"><img src="https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png" alt="Art Deco" /></a></th><th>© <a href="https://artd.eco">Art Deco</a>  2019</th><th><a href="https://www.technation.sucks" title="Tech Nation Visa"><img src="https://raw.githubusercontent.com/artdecoweb/www.technation.sucks/master/anim.gif" alt="Tech Nation Visa" /></a></th><th><a href="https://www.technation.sucks">Tech Nation Visa Sucks</a></th></tr></table>

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

Lines of code

476

increased by95.08%

Worsened metrics

Total package byte prevSize

19619

decreased by-40.64%

Number of lines in readme file

45

decreased by-8.16%

Dependency changes

• + Addedrexml@1.3.0(transitive)

• - Removedrexml@1.1.0(transitive)

• Updatedrexml@1.3.0