Skip to content

Enhancement: Node.js Local Document Generator #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Enhancement: Node.js Local Document Generator #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dc4934a
clear old outdated docs
MutableLoss May 14, 2017
9185be7
add node-offline-api
MutableLoss May 14, 2017
3617d3c
docapi build on start
MutableLoss May 14, 2017
1365185
fix for standard test
MutableLoss May 14, 2017
37aa07d
readd missing endline
MutableLoss May 14, 2017
7cb81ff
set modules to variables
MutableLoss Jun 2, 2017
6c10a88
fix issue where build directory is not set by default
MutableLoss Jun 2, 2017
3ab9e8f
update to latest node-offline-api to fix fatal errors on testing
MutableLoss Jun 2, 2017
f82b856
update to latest node-offline-api with less output, and quicker execu…
MutableLoss Jun 2, 2017
e60477e
made sure docs were only created when they didn't exist, as well as …
MutableLoss Jun 6, 2017
8b35ab3
reduce amount of noise, and add postinstall script to create docs
MutableLoss Mar 11, 2018
5b24f4c
Merge branch 'master' into node-docapi
martinheidegger Jan 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bin/learnyounode
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/usr/bin/env node

require('../learnyounode').execute(process.argv.slice(2))
require('../learnyounode').execute(process.argv.slice(2))
6 changes: 6 additions & 0 deletions lib/docbuild.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var createDocs = require('node-offline-api')
var fs = require('fs')

fs.stat('../node-apidoc', function (err) {
Copy link
Contributor

@martinheidegger martinheidegger Feb 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I try to avoid modules without an export, can this module also wrap the operation in a module?

if (err.code === 'ENOENT') { createDocs(process.cwd(), 'node_apidoc') }
})
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"combined-stream": "^1.0.8",
"concat-stream": "^2.0.0",
"duplexer": "^0.1.1",
"node-offline-api": "0.12.0",
"hyperquest": "^2.1.3",
"rimraf": "^3.0.0",
"through": "^2.3.8",
Expand All @@ -81,7 +82,9 @@
"scripts": {
"download-node-docs": "./tools/download-node-docs.sh",
"lint": "./node_modules/.bin/standard",
"test": "npm run lint && ./node_modules/.bin/workshopper-adventure-test"
"test": "npm run lint && ./node_modules/.bin/workshopper-adventure-test",
"release": "./node_modules/.bin/standard-version",
"postinstall": "node ./lib/docbuild.js"
},
"bin": {
"learnyounode": "./bin/learnyounode"
Expand Down