From 686cf297d282b7ba96e1ae3f09cf39e54d305319 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Sun, 20 Nov 2016 18:19:58 -0500 Subject: [PATCH] Clean up various script things --- docs/deploy/deploy.sh | 2 +- docs/generator/{generator.js => index.js} | 10 +++++++--- package.json | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-) rename docs/generator/{generator.js => index.js} (86%) diff --git a/docs/deploy/deploy.sh b/docs/deploy/deploy.sh index fa0cdfa70..4b71f8f5c 100644 --- a/docs/deploy/deploy.sh +++ b/docs/deploy/deploy.sh @@ -4,7 +4,7 @@ set -e function build { - node docs/generator/generator.js + node docs/generator } # Ignore Travis checking PRs diff --git a/docs/generator/generator.js b/docs/generator/index.js similarity index 86% rename from docs/generator/generator.js rename to docs/generator/index.js index bd6786e89..ce8e06b6d 100644 --- a/docs/generator/generator.js +++ b/docs/generator/index.js @@ -1,6 +1,6 @@ +#!/usr/bin/env node /* eslint-disable no-console */ const fs = require('fs'); -const zlib = require('zlib'); const jsdoc2md = require('jsdoc-to-markdown'); const Documentation = require('./documentation'); const custom = require('../custom/index'); @@ -14,16 +14,20 @@ console.log('Parsing JSDocs in source files...'); jsdoc2md.getTemplateData({ files: [`./src/*.js`, `./src/**/*.js`] }).then(data => { console.log(`${data.length} items found.`); const documentation = new Documentation(data, custom); + console.log('Serializing...'); let output = JSON.stringify(documentation.serialize(), null, 0); + if (config.compress) { console.log('Compressing...'); - output = zlib.deflateSync(output).toString('utf8'); + output = require('zlib').deflateSync(output).toString('utf8'); } - if (!process.argv.slice(2).includes('silent')) { + + if (!process.argv.slice(2).includes('test')) { console.log('Writing to docs.json...'); fs.writeFileSync('./docs/docs.json', output); } + console.log('Done!'); process.exit(0); }).catch(console.error); diff --git a/package.json b/package.json index c5b4c712c..7a4c0e72f 100644 --- a/package.json +++ b/package.json @@ -4,8 +4,10 @@ "description": "A powerful library for interacting with the Discord API", "main": "./src/index", "scripts": { - "test": "eslint src/ && node docs/generator/generator.js silent", - "docs": "node docs/generator/generator.js" + "test": "eslint src && node docs/generator test", + "docs": "node docs/generator", + "test-docs": "node docs/generator test", + "lint": "eslint src" }, "repository": { "type": "git",