vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs tweaks

Browse source
This commit is contained in:
Leo 2017-01-26 20:46:32 -05:00
parent 1780985036
commit aee13901d8
52 changed files with 8830 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/lint.js
View file

@ -37,7 +37,7 @@ function ensureCodeIsSyntaticallyValid(file, data) {
function ensureCodeIsRunnable(file, data) {
var codeBlocks = data.match(/```javascript(.|\n|\r)*?```/gim) || []
var code = codeBlocks.map(function(block) {return block.slice(13, -3)}).join(";")
//stubs
var silentConsole = {log: function() {}}
var fetch = function() {
@ -54,7 +54,7 @@ function ensureCodeIsRunnable(file, data) {
if (dep.indexOf("mithril/ospec/ospec") === 0) return global.o
if (dep.indexOf("mithril/stream") === 0) return global.stream
if (dep === "mithril") return global.m
if (dep === "../model/User") return {
list: [],
current: {},
@ -74,7 +74,6 @@ function ensureCodeIsRunnable(file, data) {
})
}
catch (e) {console.log(file + " - javascript code cannot run\n\n" + e.stack + "\n\n" + code + "\n\n---\n\n")}
}
function ensureCommentStyle(file, data) {
@ -86,7 +85,7 @@ function ensureCommentStyle(file, data) {
}
function ensureLinkIsValid(file, data) {
var links = data.match(/\]\(([^\)]+)\)/gim)
var links = data.match(/\]\(([^\)]+?)\)/gim) || []
links.forEach(function(match) {
var link = match.slice(2, -1)
var path = link.match(/[\w-]+\.md/)
@ -110,37 +109,37 @@ function initMocks() {
//routes consumed by request.md
global.window.$defineRoutes({
"GET /api/v1/users": function(request) {
"GET /api/v1/users": function() {
return {status: 200, responseText: JSON.stringify([{name: ""}])}
},
"GET /api/v1/users/search": function(request) {
"GET /api/v1/users/search": function() {
return {status: 200, responseText: JSON.stringify([{id: 1, name: ""}])}
},
"GET /api/v1/users/1/projects": function(request) {
"GET /api/v1/users/1/projects": function() {
return {status: 200, responseText: JSON.stringify([{id: 1, name: ""}])}
},
"GET /api/v1/todos": function(request) {
"GET /api/v1/todos": function() {
return {status: 200, responseText: JSON.stringify([])}
},
"PUT /api/v1/users/1": function(request) {
"PUT /api/v1/users/1": function() {
return {status: 200, responseText: request.query.callback ? request.query.callback + "([])" : "[]"}
},
"POST /api/v1/upload": function(request) {
"POST /api/v1/upload": function() {
return {status: 200, responseText: JSON.stringify([])}
},
"GET /files/icon.svg": function(request) {
"GET /files/icon.svg": function() {
return {status: 200, responseText: "<svg></svg>"}
},
"GET /files/data.csv": function(request) {
"GET /files/data.csv": function() {
return {status: 200, responseText: "a,b,c"}
},
"GET /api/v1/users/123": function(request) {
"GET /api/v1/users/123": function() {
return {status: 200, responseText: JSON.stringify({id: 123})}
},
"GET /api/v1/users/foo:bar": function(request) {
"GET /api/v1/users/foo:bar": function() {
return {status: 200, responseText: JSON.stringify({id: 123})}
},
"GET /files/image.svg": function(request) {
"GET /files/image.svg": function() {
return {status: 200, responseText: "<svg></svg>"}
},
})