Allow configs to be functions by trusktr · Pull Request #1189 · docsifyjs/docsify

trusktr · 2020-05-22T08:43:40Z

Summary

Allows user configs to be functions. A function config is passed an instance of the vm, which can be useful for referencing in other parts of the config, like in markdown.renderer hooks.

Also adds some unit tests in docsify.test.js to

test that the existing Docsify API is available globally when loaded via script tag.
test that Docsify accepts a config function (window.$docsify being a function that returns a config object)

What kind of change does this PR introduce? (check at least one)

Does this PR introduce a breaking change? (check one)

Yes
No

The PR fulfills these requirements:

When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

If adding a new feature, the PR's description includes:

A convincing reason for adding this feature
Related documents have been updated
Related unit tests have been updated
e2e tests have been updated

…put the Docsify instance

…hat configs can be functions

vercel · 2020-05-22T08:43:48Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/pliopfhjf
✅ Preview: https://docsify-preview-git-allow-config-function.docsify-core.vercel.app

trusktr · 2020-05-22T08:47:55Z

Gotta check what's going on with the failed e2e test.

trusktr · 2020-05-22T08:52:00Z

Running npm run test:e2e passes for me locally.

trusktr · 2020-05-22T08:53:47Z

Ooooh, is it because of older Node for one run of the test perhaps? I'll get back to this tomorrow.

trusktr · 2020-05-23T00:29:32Z

Looks like I should re-do my commits to use the feat:, fix:, etc prefixes.

trusktr · 2020-05-23T02:33:21Z

I tried switching to Node v10 locally, ran npm run test:e2e and all tests passed. Is there a different way to test it?

anikethsaha · 2020-05-23T05:48:02Z

Looks like I should re-do my commits to use the feat:, fix:, etc prefixes.

yes, refer angular commit convention. I will add commitlint soon to guide with the commit message.

src/core/index.js

trusktr · 2020-05-23T06:05:03Z

I will add commitlint soon to guide with the commit message.

Worth checking out semantic-release too. But that would be some work to set up. I feel like we need to clean things up, add tests, etc, first.

anikethsaha · 2020-05-23T06:06:40Z

Worth checking out semantic-release too. But that would be some work to set up. I feel like we need to clean things up, add tests, etc, first.

yea, this will need changes in the publish script.

trusktr · 2020-05-23T06:12:51Z

I just noticed something else! All tests pass (at least for me locally, not sure why it fails on CI yet), however, the npm run build command currently has a Rollup compile error, but the script exits 0 as if nothing happened.

I will fix this...

trusktr · 2020-05-23T07:09:11Z

Ok, now that I could debug it (PR #1192), I found out that adding the export words in src/core/index.js causes Rollup to complain You must supply "output.name" for IIFE bundles.

Let me see here...

…ld globals in favor of a single global DOCSIFY, and add tests for this

…e-new-single-global update src/core/index.js to export all global APIs, deprecate old globals…

Add build error handling

trusktr · 2020-05-23T21:27:24Z

Nice. All checks have passed. What I could do though, is remove the config function stuff, and just make this a pull requests that adds the test updates, then make a new minimal PR just for the config function. Let me know if that's what I should do.

EDIT: The PR is not that big anyways. Turning on the Hide whitespace changes option makes a couple parts easier to read.

.editorconfig

build/build.js

docs/configuration.md

trusktr · 2020-06-10T18:42:54Z

@jhildenbiddle @sy-records @Koooooo-7 Can I get one more review from one of you on this?

test/unit/docsify.test.js

…r ports

anikethsaha

LGTM

sy-records

👍🏻

Koooooo-7

I learned from it. 🚀

anikethsaha · 2020-06-11T10:44:16Z

@trusktr feel free to fix the merge conflict and merge this.

trusktr · 2020-06-13T00:12:09Z

Yay. Ok tonight or tomorrow I'll fix the conflict and merge.

* develop: chore: update auto format config

trusktr · 2020-06-13T04:53:55Z

I fixed the conflict with package-lock.json, and also I opened #1216 which should prevent conflicts from package-lock.

Also the e2e test failed. It is flaky. There's a race condition. I'll take a look soon. Let me re-run the tests...

build/css.js

build/build.js

Co-authored-by: James George <jamesgeorge998001@gmail.com>

trusktr · 2020-06-13T05:23:39Z

tests passed. Merging!

trusktr added 4 commits May 21, 2020 23:36

allow the user's $docsify config to be a function that receives as in…

f72bf4c

…put the Docsify instance

add tests to make sure the global and plugin APIs are available and t…

b4b8bdc

…hat configs can be functions

add editorconfig (tells editors which basic text format to use)

732c34d

update docs regarding configs as functions

5a5b5aa

trusktr requested a review from anikethsaha May 22, 2020 08:43

anikethsaha added the semver-minor This needs a semver-minor release label May 23, 2020

anikethsaha requested changes May 23, 2020

View reviewed changes

src/core/index.js Outdated Show resolved Hide resolved

add build error handling so builds don't silently fail

b72cb3d

anikethsaha closed this May 23, 2020

anikethsaha reopened this May 23, 2020

trusktr requested a review from a team May 23, 2020 21:04

trusktr added 3 commits May 23, 2020 14:10

feat: update src/core/index.js to export all global APIs, deprecate o…

7e002bf

…ld globals in favor of a single global DOCSIFY, and add tests for this

Merge pull request #1195 from docsifyjs/deprecate-old-globals-and-mak…

b40baae

…e-new-single-global update src/core/index.js to export all global APIs, deprecate old globals…

Merge pull request #1192 from docsifyjs/add-build-error-handling

1b8a81a

Add build error handling

vercel bot deployed to Preview May 23, 2020 21:20 View deployment

trusktr commented May 23, 2020

View reviewed changes

.editorconfig Show resolved Hide resolved

trusktr commented May 23, 2020

View reviewed changes

build/build.js Show resolved Hide resolved

trusktr commented May 23, 2020

View reviewed changes

docs/configuration.md Show resolved Hide resolved

trusktr requested a review from jhildenbiddle June 10, 2020 18:41

trusktr commented Jun 10, 2020

View reviewed changes

test/unit/docsify.test.js Outdated Show resolved Hide resolved

use a port for the tests that doesn't collide with common local serve…

64a231d

…r ports

trusktr dismissed anikethsaha’s stale review via 64a231d June 10, 2020 18:48

vercel bot deployed to Preview June 10, 2020 18:48 View deployment

trusktr requested a review from anikethsaha June 10, 2020 18:48

anikethsaha previously approved these changes Jun 10, 2020

View reviewed changes

Merge branch 'develop' into allow-config-function

abaf6f3

vercel bot deployed to Preview June 10, 2020 19:04 View deployment

trusktr mentioned this pull request Jun 10, 2020

Migrate to webpack #1168

Closed

sy-records previously approved these changes Jun 11, 2020

View reviewed changes

Koooooo-7 previously approved these changes Jun 11, 2020

View reviewed changes

jamesgeorge007 previously approved these changes Jun 11, 2020

View reviewed changes

Merge branch 'develop' into allow-config-function

8f3f263

* develop: chore: update auto format config

trusktr dismissed stale reviews from jamesgeorge007, Koooooo-7, sy-records, and anikethsaha via 8f3f263 June 13, 2020 04:38

vercel bot deployed to Preview June 13, 2020 04:38 View deployment

jamesgeorge007 reviewed Jun 13, 2020

View reviewed changes

build/css.js Show resolved Hide resolved

build/build.js Show resolved Hide resolved

Update build/css.js

146e4c4

Co-authored-by: James George <jamesgeorge998001@gmail.com>

vercel bot deployed to Preview June 13, 2020 05:16 View deployment

trusktr merged commit da9af18 into develop Jun 13, 2020

trusktr deleted the allow-config-function branch June 13, 2020 05:23

snyk-bot mentioned this pull request Jun 26, 2020

[Snyk] Security upgrade docsify from 4.11.2 to 4.11.4 #1250

Merged

Uh oh!

Conversation

trusktr commented May 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented May 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trusktr commented May 22, 2020

Uh oh!

trusktr commented May 22, 2020

Uh oh!

trusktr commented May 22, 2020

Uh oh!

trusktr commented May 23, 2020

Uh oh!

trusktr commented May 23, 2020

Uh oh!

anikethsaha commented May 23, 2020

Uh oh!

Uh oh!

trusktr commented May 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anikethsaha commented May 23, 2020

Uh oh!

trusktr commented May 23, 2020

Uh oh!

trusktr commented May 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trusktr commented May 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trusktr commented Jun 10, 2020

Uh oh!

Uh oh!

anikethsaha left a comment

Choose a reason for hiding this comment

Uh oh!

sy-records left a comment

Choose a reason for hiding this comment

Uh oh!

Koooooo-7 left a comment

Choose a reason for hiding this comment

Uh oh!

anikethsaha commented Jun 11, 2020

Uh oh!

trusktr commented Jun 13, 2020

Uh oh!

trusktr commented Jun 13, 2020

Uh oh!

Uh oh!

Uh oh!

trusktr commented Jun 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

trusktr commented May 22, 2020 •

edited

Loading

vercel bot commented May 22, 2020 •

edited

Loading

trusktr commented May 23, 2020 •

edited

Loading

trusktr commented May 23, 2020 •

edited

Loading

trusktr commented May 23, 2020 •

edited

Loading