dox - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

example.js

 
-/*!
- * Output the given `str` to _stdout_
- * or the stream specified by `options`.
- * 
- * @param {String} str
- * @param {Object} options
- * @return {Object} exports for chaining
+/**
+ * Escape the given `html`.
+ *
+ * Examples:
+ *
+ *     utils.escape('<script></script>')
+ *     // => '&lt;script&gt;&lt;/script&gt;'
+ *
+ * @param {String} html string to be escaped
+ * @return {String} escaped html
  * @api public
  */
 
-function User() {
-  
-}
-
-/**
- * test
- */
-
-User.prototype.toString = function(){
-  return '<User>';
-}
+exports.escape = function(html){
+  return String(html)
+    .replace(/&(?!\w+;)/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;');
+};

History.md

 
+0.1.1 / 2011-10-10 
+==================
+
+  * Fixed: colons in comment lines not intended as headers [Evan Owen]
+
 0.0.5 / 2011-03-02 
@@ -3,0 +8,0 @@ ==================

lib/dox.js

@@ -19,3 +19,3 @@
 
-exports.version = '0.1.0';
+exports.version = '0.1.1';
 
@@ -101,3 +101,3 @@ /**
   // parse comment body
-  description.full = str.split('\n@')[0].replace(/^([\w ]+):/gm, '## $1');
+  description.full = str.split('\n@')[0].replace(/^([\w ]+):$/gm, '## $1');
   description.summary = description.full.split('\n\n')[0];
@@ -104,0 +104,0 @@ description.body = description.full.split('\n\n').slice(1).join('\n\n');

package.json

 {   "name": "dox"
   , "description": "Markdown / JSdoc documentation generator"
-  , "version": "0.1.0"
+  , "version": "0.1.1"
   , "author": "TJ Holowaychuk <[e-mail]>"
@@ -5,0 +5,0 @@ , "keywords": ["documentation", "docs", "markdown", "jsdoc"]

Readme.md

@@ -28,2 +28,7 @@ # Dox
  *
+ * Examples:
+ *
+ *     utils.escape('<script></script>')
+ *     // => '&lt;script&gt;&lt;/script&gt;'
+ *
  * @param {String} html string to be escaped
@@ -42,3 +47,3 @@ * @return {String} escaped html
 
-output JSON:
+output:
 
@@ -51,3 +56,5 @@ ```json
         "type": "param",
-        "types": ["String"],
+        "types": [
+          "String"
+        ],
         "name": "html",
@@ -58,3 +65,5 @@ "description": "string to be escaped"
         "type": "return",
-        "types": ["String"],
+        "types": [
+          "String"
+        ],
         "description": "escaped html"
@@ -68,5 +77,5 @@ },
     "description": {
-      "full": "<p>Escape the given <code>html</code>.</p>",
+      "full": "<p>Escape the given <code>html</code>.</p>\n\n<h2>Examples</h2>\n\n<pre><code>utils.escape('&amp;lt;script&amp;gt;&amp;lt;/script&amp;gt;')\n// =&amp;gt; '&amp;lt;script&amp;gt;&amp;lt;/script&amp;gt;'\n</code></pre>",
       "summary": "<p>Escape the given <code>html</code>.</p>",
-      "body": ""
+      "body": "<h2>Examples</h2>\n\n<pre><code>utils.escape('&amp;lt;script&amp;gt;&amp;lt;/script&amp;gt;')\n// =&amp;gt; '&amp;lt;script&amp;gt;&amp;lt;/script&amp;gt;'\n</code></pre>"
     },
@@ -280,10 +289,2 @@ "isPrivate": false,
 
-```js
-ctx: 
- { type: 'method',
-   constructor: 'User',
-   name: 'toString',
-   string: 'User.prototype.toString()' } }
-```
-
 ### Ignore
@@ -290,0 +291,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34266

increased by1.67%

Lines of code

751

increased by0.13%

Number of lines in readme file

332

increased by0.3%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes