Module
A simple, dependency free static file server for Deno with possibly the worst name ever.
Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400const { args } = Denoimport { parse, acceptWebSocket, serve, Server, serveTLS, ServerRequest, posix,} from './deps.ts'
/* Denoliver utils */import { isRoute, isValidArg, printHelp, readFile, isWebSocket, appendReloadScript, printStart, printRequest, error, isValidPort, inject404, setHeaders, encode, decode, info, prompt, joinPath, DirEntry, pipe,} from './utils/utils.ts'
import { html, css, logo } from './utils/boilerplate.ts'import { getNetworkAddr } from './utils/local-ip.ts'import dirTemplate from './directory.ts'import { InterceptorException } from './utils/errors.ts'
type DenoliverOptions = { root?: string port?: number silent?: boolean disableReload?: boolean debug?: boolean cors?: boolean secure?: boolean help?: boolean list?: boolean certFile?: string keyFile?: string entryPoint?: string before?: string | Interceptor | Interceptor[] after?: string | Interceptor | Interceptor[]}
type Interceptor = (r: ServerRequest) => ServerRequest
/* Initialize file watcher */let watcher: Deno.FsWatcher
/* Server */let server: Serverlet networkAddr: string | undefined
/* Globals */let root = '.'let port = 8080let debug = falselet silent = falselet disableReload = falselet secure = falselet help = falselet cors = falselet list = falselet certFile = 'denoliver.crt'let keyFile = 'denoliver.key'let entryPoint = 'index.html'let before: Array<Interceptor> | Interceptorlet after: Array<Interceptor> | Interceptor
const handleFileRequest = async (req: ServerRequest) => { try { const path = joinPath(root, req.url) const file = await Deno.open(path) req.done.then(() => { file.close() }) return await req.respond({ status: 200, headers: setHeaders(cors, path), body: file, }) } catch (err) { !silent && debug ? console.error(err) : error(err.message) handleNotFound(req) }}
const handleRouteRequest = async (req: ServerRequest): Promise<void> => { try { const file = await readFile(`${root}/${entryPoint}`) const { hostname, port } = req.conn.localAddr as Deno.NetAddr await req.respond({ status: 200, headers: setHeaders(cors), body: disableReload ? file : appendReloadScript(file, port, hostname, secure), }) } catch (err) { !silent && debug ? console.error(err) : error(err.message) handleDirRequest(req) }}
const handleDirRequest = async (req: ServerRequest): Promise<void> => { const path = joinPath(root, req.url) const dirUrl = `/${posix.relative(root, path)}` const entries: DirEntry[] = [] for await (const entry of Deno.readDir(path.replace(/\/$/, ''))) { const filePath = posix.join(dirUrl, '/', entry.name) entries.push({ ...entry, url: decodeURIComponent(filePath) }) }
await req.respond({ status: 200, body: encode(dirTemplate(entries, dirUrl)), headers: setHeaders(cors), })}
const handleWs = async (req: ServerRequest): Promise<void> => { if (!watcher) { watcher = Deno.watchFs(root, { recursive: true }) } try { const { conn, r: bufReader, w: bufWriter, headers } = req const socket = await acceptWebSocket({ conn, bufReader, bufWriter, headers, })
for await (const event of watcher) { if (event.kind === 'modify') { await socket.send('reload') } } } catch (err) { !silent && error(err.message) }}
const handleNotFound = async (req: ServerRequest): Promise<void> => { return req.respond({ status: 404, headers: setHeaders(cors), body: inject404(req.url), })}
const router = async (req: ServerRequest): Promise<void> => { try { if (!(req instanceof ServerRequest)) { throw new InterceptorException() } printRequest(req) if (!disableReload && isWebSocket(req)) { return await handleWs(req) } if (req.method === 'GET' && req.url === '/') { return handleRouteRequest(req) } const path = joinPath(root, req.url) if (isRoute(path)) { if (list) { try { const fileInfo = await Deno.stat(path)
if (fileInfo.isDirectory) { return handleDirRequest(req) } } catch (err) { throw err } } return handleRouteRequest(req) }
return handleFileRequest(req) } catch (err) { err instanceof Deno.errors.NotFound && handleNotFound(req) !silent && debug ? console.log(err) : error(err.message) err instanceof InterceptorException && Deno.exit() }}
const checkCredentials = async () => { try { await Deno.stat(`${root}/${certFile}`) await Deno.stat(`${root}/${keyFile}`) } catch (err) { !silent && debug ? console.error(err) : error( 'Could not certificate or key files. Make sure you have your CERT_FILE.crt & KEY_FILE.key in your working directory, or try without -t.' ) Deno.exit() }}
const callInterceptors = ( req: ServerRequest, funcs: Interceptor[] | Interceptor) => { const fns = Array.isArray(funcs) ? funcs : [funcs] const pipeline = pipe(...fns) return pipeline(req)}
const startListener = async ( handler: (req: ServerRequest) => void): Promise<void> => { try { for await (const req of server) { before ? handler(await callInterceptors(req, before)) : handler(req) after && callInterceptors(req, after) } } catch (err) { !silent && debug ? console.error(err) : error(err.message) }}
const setGlobals = async (args: DenoliverOptions): Promise<void> => { root = args.root ?? '.' help = args.help ?? false debug = args.debug ?? false silent = args.silent ?? false disableReload = args.disableReload ?? false port = args.port ?? 8080 secure = args.secure ?? false cors = args.cors ?? false list = args.list ?? false certFile = args.certFile ?? 'denoliver.crt' keyFile = args.keyFile ?? 'denoliver.key' entryPoint = args.entryPoint ?? 'index.html'
if (args.before) { if (typeof args.before === 'function') { before = args.before } else { try { const path = posix.resolve(`${root}/${args.before}`) const interceptors = await import(path) before = interceptors.default } catch (err) { !silent && debug ? console.error(err) : error(err.message) } } }
if (args.after) { if (typeof args.after === 'function') { before = args.after } else { try { const path = posix.resolve(`${root}/${args.after}`) const interceptors = await import(path) after = interceptors.default } catch (err) { !silent && debug ? console.error(err) : error(err.message) } } }}
const makeBoilerplate = async (path: string, name: string) => { await Deno.mkdir(`${path}/${name}`, { recursive: true }) const htmlData = encode(html(name)) const cssData = encode(css()) const svgData = encode(logo())
await Deno.writeFile(`${path}/${name}/index.html`, htmlData) await Deno.writeFile(`${path}/${name}/index.css`, cssData) await Deno.writeFile(`${path}/${name}/logo.svg`, svgData) await Deno.writeFile(`${path}/${name}/app.js`, encode(''))}
/** * Serve a directory over HTTP/HTTPS * * const options = { port: 8000, cors: true }; * const denoliver = await main(options) * * @param options Optional server config */const main = async (args?: DenoliverOptions): Promise<Server> => { if (args) { setGlobals(args) }
if (help) { printHelp() Deno.exit() }
if (port && !isValidPort(port)) { error(`${port} is not a valid port.`) Deno.exit() }
secure && (await checkCredentials())
// In certain browsers the server will crash if Self-signed certificates are not allowed. // Ref: https://github.com/denoland/deno/issues/5760 server = secure ? serveTLS({ port: port, certFile: `${root}/${certFile}`, keyFile: `${root}/${keyFile}`, }) : serve({ port })
networkAddr = await getNetworkAddr() printStart(root, port, networkAddr, secure)
startListener(router) return server}
if (import.meta.main) { const parsedArgs = parse(args, { default: { d: false, s: false, n: false, p: 8080, t: false, c: false, l: false, certFile: 'denoliver.crt', keyFile: 'denoliver.key', entry: 'index.html', }, })
Object.keys(parsedArgs).map((arg: string) => { if (!isValidArg(arg)) { error(`${arg} is not a valid arg.`) printHelp() Deno.exit() } })
await setGlobals({ root: parsedArgs._.length > 0 ? String(parsedArgs._[0]) : '.', debug: parsedArgs.d, silent: parsedArgs.s, disableReload: parsedArgs.n, port: parsedArgs.p, secure: parsedArgs.t, help: parsedArgs.h, cors: parsedArgs.c, list: parsedArgs.l, certFile: parsedArgs.certFile, keyFile: parsedArgs.keyFile, entryPoint: parsedArgs.entry, before: parsedArgs.before, after: parsedArgs.after, })
try { const config = await Deno.readFile(`${root}/denoliver.json`) setGlobals(JSON.parse(decode(config))) } catch (err) {}
const cwd = Deno.cwd() try { Deno.readDirSync(`${cwd}/${root}`) } catch (err) { if (err instanceof Deno.errors.NotFound) { const answer = await prompt( `The directory ${root} does not exist. Do you wish to create it? [y/n]` ) if (answer === 'y' || 'Y') { await makeBoilerplate(cwd, root) } else { info('Exiting.') Deno.exit() } } }
main()}
export default main