♻️ rename

Author: Hendrixer

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "ui-guide",
+  "name": "@angularclass/dope-docs",
   "version": "0.0.1",
   "description": "Starter to make Angular libs",
-  "main": "ui-guide.js",
+  "main": "dope-docs.js",
   "jsnext:main": "index.js",
   "module": "index.js",
   "types": "index.d.ts",
@@ -17,7 +17,7 @@
     "release": "rm -rf build && npm run build:esm && npm run build:bundle && npm run build:cli && npm run copy"
   },
   "bin": {
-    "ui-guide": "./cli/cli.js"
+    "acdocs": "./cli/cli.js"
   },
   "license": "MIT",
   "devDependencies": {

src/index.ts

@@ -1,2 +1,2 @@
 export * from './interfaces'
-export { uiGuideOn, createUIGuideSandbox, UIGuideBuilder } from './ui-guide-builder'
+export { docsFor, createDopeDocs, DocsBuilder} from './ui-guide-builder'

src/interfaces.ts

@@ -96,6 +96,19 @@ export interface ComponentOuput {
 }
 
 export interface ComponentAPI {
-  inputs: ComponentInput[]
-  outputs: ComponentOuput[]
+  inputs?: ComponentInput[]
+  outputs?: ComponentOuput[]
+}
+
+export interface DopeDoc extends UIGuide {
+  example(name: string, config: UIGuideExampleConfig): DopeDoc
+  xexample(name?: string, config?: UIGuideExampleConfig): DopeDoc
+  Xexample(name?: string, config?: UIGuideExampleConfig): DopeDoc
+}
+
+export declare var DocsBuilder: {
+  new(name: string, description: string, api: ComponentAPI): DopeDoc
+  example(name: string, config: UIGuideExampleConfig): DopeDoc
+  xexample(name?: string, config?: UIGuideExampleConfig): DopeDoc
+  Xexample(name?: string, config?: UIGuideExampleConfig): DopeDoc
 }

src/ui-guide-builder.ts

@@ -1,14 +1,14 @@
-import { UIGuideSandbox, UIGuide, UIGuideExample, UIGuideExampleConfig, ComponentAPI } from './interfaces'
+import { UIGuideSandbox, UIGuide, UIGuideExample, UIGuideExampleConfig, ComponentAPI, DopeDoc } from './interfaces'
 import { bootstrap } from './boostrap'
 const slugify = require('slugify')
 
-export function createUIGuideSandbox(sandbox: UIGuideSandbox) {
+export function createDopeDocs(sandbox: UIGuideSandbox) {
   bootstrap(sandbox)
 }
 
 const GuideIDS: {[id: string]: string[]} = {}
 
-export class UIGuideBuilder implements UIGuide {
+export class DocsBuilder implements DopeDoc {
   id: string
   examples: UIGuideExample[] = []
 
@@ -23,7 +23,7 @@ export class UIGuideBuilder implements UIGuide {
     this.id = id
   }
 
-  example(name: string, config: UIGuideExampleConfig): this {
+  example(name: string, config: UIGuideExampleConfig): DopeDoc {
     const id = `${this.id}-${slugify(name).toLowerCase()}`
 
     if (GuideIDS[this.id].find(i => i === id)) {
@@ -47,19 +47,19 @@ export class UIGuideBuilder implements UIGuide {
     return this
   }
 
-  xexample(description: string, config: UIGuideExampleConfig){
+  xexample(description: string, config: UIGuideExampleConfig): DopeDoc {
     return this
   }
 
-  Xexample(description: string, config: UIGuideExampleConfig) {
+  Xexample(description: string, config: UIGuideExampleConfig): DopeDoc {
     return this.xexample(description, config)
   }
 }
 
-export function uiGuideOn(
+export function docsFor(
   component: string,
   description: string,
   api: ComponentAPI
-): UIGuideBuilder {
-  return new UIGuideBuilder(component, description, api)
+): DopeDoc {
+  return new DocsBuilder(component, description, api)
 }

webpack.config.js

@@ -8,7 +8,7 @@ const moduleExternals = require('webpack-node-externals')
 module.exports = (envOptions = {}) => {
   return ({
     entry: {
-      'ui-guide': root('./src/index.ts')
+      'dope-docs': root('./src/index.ts')
     },
     output: {
       path: root('dist'),