Merge pull request #62 from vue-styleguidist/feat-noscript

Allow documented components not to have a script block

Author: elevatebart

.travis.yml

@@ -1,13 +1,9 @@
 language: node_js
 node_js:
-  - 9
-install:
-  # Use npm 5.7.x since it has introduced `npm ci`
-  - if [[ `npm -v` != 5.7* ]]; then npm install -g npm@'>=5.7.1'; fi
-  - npm ci
+  - 10
 branches:
-  except:
-    - /^v\d+\.\d+\.\d+$/
+  only:
+    - master
 script:
   - npm run test
 stages:

src/utils/getSandbox.js

@@ -7,6 +7,7 @@ import parseModule from './parseModule'
 module.exports = function getSandbox(stateDoc, file) {
   const parsedSource = parseModule(stateDoc.jscodeRequest, file, stateDoc.jscodeLang)
   const sandbox = evalComponentCode(parsedSource).exports
+  sandbox.default = sandbox.default || {}
   const component = sandbox.default
   const listRequire = getSourceInRequire(parsedSource, file)
   const mixins = getMixin(listRequire).reverse()

src/utils/stateDoc.js

@@ -23,9 +23,12 @@ class stateDoc {
     if (this.isMainComponent(file) && this.sourceComponent !== source) {
       const parts = parser(source, 'name')
       this.slots = getSlots(parts)
-      this.jscodeRequest = getComponentModuleJSCode(parts, source, file)
-      this.jscodeLang = parts.script.lang
-      this.docComponent = this.getDocFile(this.jscodeRequest, file, this.jscodeLang)
+      this.docComponent = []
+      if (parts.script) {
+        this.jscodeRequest = getComponentModuleJSCode(parts, source, file)
+        this.jscodeLang = parts.script.lang
+        this.docComponent = this.getDocFile(this.jscodeRequest, file, this.jscodeLang)
+      }
     }
   }
 

tests/components/button-noscript/MyButton.vue

@@ -0,0 +1,19 @@
+<template>
+	<button class="buttonComponent">
+		<!-- @slot Use this slot default -->
+		<slot/>
+	</button>
+</template>
+
+<style scoped>
+.button {
+  padding: 0.5em 1.5em;
+  color: #666;
+  background-color: #fff;
+  border: 1px solid blue;
+  border-radius: 0.3em;
+  text-align: center;
+  vertical-align: middle;
+  cursor: pointer;
+}
+</style>

tests/components/button-noscript/button-noscript.test.js

@@ -0,0 +1,30 @@
+const path = require('path')
+const expect = require('chai').expect
+
+const api = require('../../../dist/main')
+const button = path.join(__dirname, './MyButton.vue')
+let docButton
+
+describe.only('tests button', () => {
+  before(function(done) {
+    this.timeout(10000)
+    docButton = api.parse(button)
+    done()
+  })
+
+  it('should return an object', () => {
+    expect(docButton).to.be.an('object')
+  })
+
+  it('should have a slot.', () => {
+    expect(Object.keys(docButton['slots']).length).to.equal(1)
+  })
+
+  it('should have a default slot.', () => {
+    expect(typeof docButton['slots']['default'] !== 'undefined').to.be.true
+  })
+
+  it('the default slot should have "Use this slot default" as description', () => {
+    expect(docButton['slots']['default']['description']).to.equal('Use this slot default')
+  })
+})