@architect/docs - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

en/aws/_nav.md

 - [🌩 architect](/)
 - [Introduction](/intro)
   - [Concepts](/intro/concepts)
-  - [Limitations](/intro/limits)
+  - [Limits](/intro/limits)
   - [Community](/intro/community)
   - [Roadmap](/intro/roadmap)
-  - [Videos](/intro/videos)
 - [Quickstart](/quickstart)
   - [Setup](/quickstart/setup)
-  - [Installation](/quickstart/install)
-  - [Project layout](/quickstart/arc-project-layout)
+  - [Install](/quickstart/install)
+  - [Layout](/quickstart/arc-project-layout)
 - [Reference](/reference/)
@@ -13,0 +12,0 @@ - [Workflows](/reference/npm-run-scripts)

index.js

 var fs = require('fs')
 var md = require('marked')
+var read = fs.readFileSync
+var exists = fs.existsSync
 var join = require('path').join
@@ -10,11 +12,11 @@ var ledger = {}
   if (!cached) {
+    // TODO figure out lang and platform switcher logic
     var path = join(__dirname, 'en', 'aws', `${filename}.md`)
 
-    var exists = fs.existsSync(path)
-    if (exists) {
+    if (exists(path)) {
 
       var title = 'arc'
-      var style = fs.readFileSync(join(__dirname, 'style.css')).toString()
-      var nav = fs.readFileSync(join(__dirname, 'en', 'aws', '_nav.md')).toString()
-      var body = fs.readFileSync(path).toString()
+      var style = read(join(__dirname, 'style.css')).toString()
+      var nav = read(join(__dirname, 'en', 'aws', '_nav.md')).toString()
+      var body = read(path).toString()
 
@@ -47,7 +49,1 @@ ledger[filename] = `
 }
-
-function render(req, res) {
-  var filename = req.path.replace('/', '-')
-  var html = _render(filename)
-  res({html})
-}

package.json

 {
   "name": "@architect/docs",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "index",
+  "scripts": {
+    "test": "tape test.js | tap-spec"
+  },
   "dependencies": {
@@ -9,3 +12,7 @@ "marked": "^0.3.6",
     "run-waterfall": "^1.1.3"
+  },
+  "devDependencies": {
+    "tap-spec": "^4.1.1",
+    "tape": "^4.7.0"
   }
 }

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

51262

increased by1.64%

Number of package files

46

increased by9.52%

Lines of code

263

increased by3.54%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

8

increased byInfinity%

Worsened metrics

Dev dependency count

2

increased byInfinity%

No dependency changes