Enhancement: Node.js Local Document Generator #531

MutableLoss · 2017-05-14T01:11:32Z

Update One adding custom Node.js documentation building, to start the upgrade process per Issue #503 .

The new API module is setup to create new documents once learnyounode is started, generating to node_apidoc and the version reflecting the version of Node.js used to execute. To keep with the consistency of offering an offline solution, all requests are made locally so there is no need for connectivity after the deps have been installed.

Note: Once the documents are created any future requests will be ignored as long as the folder exists, making sure not to add overhead on every single run. If a user accidentally removes the doc folder, it will recreate that folder on the next run.

To remove the need to overwrite files, reduce size, and redundancy the old 0.10 apidoc folder has been removed.

MutableLoss · 2017-05-14T01:44:07Z

The CI build check is choking on the docbuild file which cannot get past the test. I am not sure what to do to get around the errors on the require calls, but everything works as intended.

AnshulMalik · 2017-06-02T03:40:13Z

lib/docbuild.js

@@ -0,0 +1,7 @@
+createDocs = require('node-offline-api').createDocs
+buildOptions = require('node-offline-api').buildOptions


can we use something like var buildOptions = require('') or const may be.

That would help the test to pass.

Thanks @AnshulMalik !

Wow, what in the world was I doing when I submitted that? I think I spent a little too much time with Ruby that day. :)

It has been done! Using var for now, until the lowest version of Node is a specific, then I can cross-check the available ES6 sugar that can be safely used.

MutableLoss · 2017-06-02T04:38:24Z

Looks like one more issue where it is checking the local file build, and adding the default folder path. Fix on the way up.

AnshulMalik · 2017-06-02T04:38:26Z

Looks like the travis is still unhappy :P

MutableLoss · 2017-06-02T05:05:27Z

Ok, it looks like it is now failing on the official Node.js document generator API that is part of the offline document API, otherwise it seems to be working as intended. I could go through those files, and change them all to standard if needed, and it should remove any of the CI errors.

Actually, going to check out this EEXISTS issue first.

MutableLoss · 2017-06-02T05:12:31Z

Ok, I see now. It is catching the fs.stat error which isn't an actual error. Let me quiet that down, and see if it will ignore the standard on the official after that. Fix coming up.

MutableLoss · 2017-06-02T06:35:21Z

Well, the fatal errors are gone now. The only issue with the tests is where the tests see some of the verbosity of the API when testing the exercises.

The reason for this is due to running that offline document API upon startup. It is run quietly per the buildOptions.quiet setting so no one actually sees this when running LYN, and it only runs when the document directory does not exist (first run unless doc dir is removed). For some reason the exercise tests still see these in the test though.

EDIT: Yep, I need to check this out. It seems when running it with next/verify/help/etc the messages still show. I'll create a new fix in the morning. Apologies for all of the surprises there at the end.

MutableLoss · 2017-06-02T08:43:53Z

Ok, refactored, and re-released module to allow 100% passing locally.

MutableLoss · 2017-06-02T16:41:39Z

It looks like there is a possible issue when validating files. I'm going to take the weekend to look for a way to limit the possible executions, instead of running on every instance.

MutableLoss · 2017-12-02T01:24:53Z

Since I rebased with the latest master, it seems that the 5.x build is now erroring, but the 6.x and 7.x tests are passing. Unfortunately the 5.0 build is giving an npm error that if cannot find the function Buffer.alloc, which requires Node.js 5.10.0+ and the CI is using 5.0.0:

Looking through my latest source, I am not finding this being called. It looks like this is an external issue, but not sure where when no node modules are being installed due to the error.

Please let me know if you need anything from me, as I would love to see this move forward so I can continue to help with new updates to help make this a more recent-friendly workshop. 😃

martinheidegger

I merged this PR against a test-branch and the build seems to be working now: https://travis-ci.org/workshopper/learnyounode/builds/343205079

But I added some response on how to improve this PR. It would be awesome if this could find its way into master.

martinheidegger · 2018-02-19T03:40:41Z

package.json

@@ -80,7 +81,7 @@
    "workshopper-adventure-test": "^1.1.2"
  },
  "scripts": {
-    "lint": "./node_modules/.bin/standard",
+    "lint": "./node_modules/.bin/standard --fix",


This should not be part of THIS pr! (Note: during development you can run npm run lint -- --fix

martinheidegger · 2018-02-19T03:42:46Z

lib/docbuild.js

+buildOptions.buildName = 'node_apidoc'
+
+fs.stat('../node-apidoc', function (err) {
+  if (err) { createDocs() }


There can theoretically be various errors here. I think the .code === "ENOENT" is the error we are looking for.

martinheidegger · 2018-02-19T03:44:33Z

lib/docbuild.js

+buildOptions.buildDir = process.cwd()
+buildOptions.buildName = 'node_apidoc'
+
+fs.stat('../node-apidoc', function (err) {


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

martinheidegger · 2018-02-19T03:48:16Z

bin/learnyounode

+require('../learnyounode').execute(process.argv.slice(2))
+
+if(process.argv.slice(2) == 0){


(This is not standard syntax)

Workshopper has a commands option that allows to register custom commands just for this purpose. Of course there should be a postinstall script that launches this command.

Huge thanks Martin. I'll get these knocked out this week.

These are all resolved. It doesn't like like I can mark these resolved, so just leaving a reminder since I know you're very busy.

MutableLoss · 2018-03-11T04:34:37Z

I went ahead and cleaned up the module, and added the postinstall script. Let me know if there is anything else that you feel would work better, or be more ideal in other situations.

EDIT: rebased the branch due to some lockfile conflicts. Not sure if you want an updated lockfile, so left it as-is until later.

…tion

…making sure documents were not created when using commands to keep the speed high

AnshulMalik reviewed Jun 2, 2017

View reviewed changes

MutableLoss force-pushed the node-docapi branch from 1b44cdb to ed2bee4 Compare December 2, 2017 01:08

martinheidegger requested changes Feb 19, 2018

View reviewed changes

MutableLoss added 11 commits March 10, 2018 22:38

clear old outdated docs

dc4934a

add node-offline-api

9185be7

docapi build on start

3617d3c

fix for standard test

1365185

readd missing endline

37aa07d

set modules to variables

7cb81ff

fix issue where build directory is not set by default

6c10a88

update to latest node-offline-api to fix fatal errors on testing

3ab9e8f

update to latest node-offline-api with less output, and quicker execu…

f82b856

…tion

made sure docs were only created when they didn't exist, as well as …

e60477e

…making sure documents were not created when using commands to keep the speed high

reduce amount of noise, and add postinstall script to create docs

8b35ab3

MutableLoss force-pushed the node-docapi branch from c766851 to 8b35ab3 Compare March 11, 2018 04:57

Merge branch 'master' into node-docapi

5b24f4c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancement: Node.js Local Document Generator #531

Enhancement: Node.js Local Document Generator #531

MutableLoss commented May 14, 2017

MutableLoss commented May 14, 2017

AnshulMalik Jun 2, 2017

MutableLoss Jun 2, 2017 •

edited

Loading

MutableLoss commented Jun 2, 2017

AnshulMalik commented Jun 2, 2017

MutableLoss commented Jun 2, 2017 •

edited

Loading

MutableLoss commented Jun 2, 2017

MutableLoss commented Jun 2, 2017 •

edited

Loading

MutableLoss commented Jun 2, 2017

MutableLoss commented Jun 2, 2017

MutableLoss commented Dec 2, 2017

martinheidegger left a comment

martinheidegger Feb 19, 2018

martinheidegger Feb 19, 2018

martinheidegger Feb 19, 2018

martinheidegger Feb 19, 2018

MutableLoss Feb 19, 2018

MutableLoss Apr 9, 2018

MutableLoss commented Mar 11, 2018 •

edited

Loading

		@@ -0,0 +1,7 @@
		createDocs = require('node-offline-api').createDocs
		buildOptions = require('node-offline-api').buildOptions

		require('../learnyounode').execute(process.argv.slice(2))

		if(process.argv.slice(2) == 0){

Enhancement: Node.js Local Document Generator #531

Are you sure you want to change the base?

Enhancement: Node.js Local Document Generator #531

Conversation

MutableLoss commented May 14, 2017

MutableLoss commented May 14, 2017

AnshulMalik Jun 2, 2017

Choose a reason for hiding this comment

MutableLoss Jun 2, 2017 • edited Loading

Choose a reason for hiding this comment

MutableLoss commented Jun 2, 2017

AnshulMalik commented Jun 2, 2017

MutableLoss commented Jun 2, 2017 • edited Loading

MutableLoss commented Jun 2, 2017

MutableLoss commented Jun 2, 2017 • edited Loading

MutableLoss commented Jun 2, 2017

MutableLoss commented Jun 2, 2017

MutableLoss commented Dec 2, 2017

martinheidegger left a comment

Choose a reason for hiding this comment

martinheidegger Feb 19, 2018

Choose a reason for hiding this comment

martinheidegger Feb 19, 2018

Choose a reason for hiding this comment

martinheidegger Feb 19, 2018

Choose a reason for hiding this comment

martinheidegger Feb 19, 2018

Choose a reason for hiding this comment

MutableLoss Feb 19, 2018

Choose a reason for hiding this comment

MutableLoss Apr 9, 2018

Choose a reason for hiding this comment

MutableLoss commented Mar 11, 2018 • edited Loading

MutableLoss Jun 2, 2017 •

edited

Loading

MutableLoss commented Jun 2, 2017 •

edited

Loading

MutableLoss commented Jun 2, 2017 •

edited

Loading

MutableLoss commented Mar 11, 2018 •

edited

Loading