Skip to content
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.

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

feat(docz-core): updates to plugin hooks #431

Merged
merged 1 commit into from
Nov 14, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions packages/docz-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"lodash.get": "^4.4.2",
"mini-html-webpack-plugin": "^0.2.3",
"react-dev-utils": "^6.1.0",
"p-reduce": "^1.0.0",
"react-docgen-typescript-loader": "^3.0.0-rc.0",
"react-hot-loader": "4.3.11",
"rehype-docz": "^0.12.9",
Expand Down Expand Up @@ -96,6 +97,7 @@
"@types/koa": "^2.0.46",
"@types/lodash.get": "^4.4.4",
"@types/node": "10.12.1",
"@types/p-reduce": "^1.0.0",
"@types/prettier": "^1.13.2",
"@types/resolve": "^0.0.8",
"@types/webpack": "^4.4.17",
Expand Down
9 changes: 7 additions & 2 deletions packages/docz-core/src/Entries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export class Entries {
}

private async getMap(config: Config): Promise<EntryMap> {
const { src, files: pattern, ignore } = config
const { src, files: pattern, ignore, plugins } = config
const arr = Array.isArray(pattern) ? pattern : [pattern]
const toMatch = matchFilesWithSrc(config)

Expand Down Expand Up @@ -109,8 +109,13 @@ export class Entries {
}
}

const reduce = Plugin.reduceFromPlugins<string[]>(plugins)
const modifiedFiles = reduce('modifyFiles', files)

const map = new Map()
const entries = await Promise.all(files.map(createEntry).filter(Boolean))
const entries = await Promise.all(
modifiedFiles.map(createEntry).filter(Boolean)
)

for (const entry of entries) {
if (entry) {
Expand Down
22 changes: 21 additions & 1 deletion packages/docz-core/src/Plugin.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
import get from 'lodash.get'
import pReduce from 'p-reduce'

import { Config } from './commands/args'
import { isFn } from './utils/helpers'
import { BabelRC } from './utils/babel-config'

export type SetConfig = (config: Config) => Config
export type SetConfig = (config: Config) => Config | Promise<Config>
export type ModifyBundlerConfig<C = any> = (
config: C,
dev: boolean,
args: Config
) => C
export type ModifyBabelRC = (babelrc: BabelRC, args: Config) => BabelRC
export type ModifyFiles = (files: string[], args: Config) => string[]
export type onCreateApp = <A>(app: A) => void
export type OnServerListening = <S>(server: S) => void
export type OnPreBuild = (args: Config) => void
Expand All @@ -22,6 +24,7 @@ export interface PluginFactory {
setConfig?: SetConfig
modifyBundlerConfig?: ModifyBundlerConfig
modifyBabelRc?: ModifyBabelRC
modifyFiles?: ModifyFiles
onCreateApp?: onCreateApp
onServerListening?: OnServerListening
onPreBuild?: OnPreBuild
Expand Down Expand Up @@ -64,9 +67,25 @@ export class Plugin<C = any> implements PluginFactory {
}
}

public static reduceFromPluginsAsync<C>(
plugins: Plugin[] | undefined
): (method: keyof Plugin, initial: C, ...args: any[]) => Promise<C> {
return (method, initial, ...args) => {
return pReduce(
[...(plugins || [])],
(obj: any, plugin: any) => {
const fn = get(plugin, method)
return Promise.resolve(fn && isFn(fn) ? fn(obj, ...args) : obj)
},
initial
)
}
}

public readonly setConfig?: SetConfig
public readonly modifyBundlerConfig?: ModifyBundlerConfig<C>
public readonly modifyBabelRc?: ModifyBabelRC
public readonly modifyFiles?: ModifyFiles
public readonly onCreateApp?: onCreateApp
public readonly onServerListening?: OnServerListening
public readonly onPreBuild?: OnPreBuild
Expand All @@ -78,6 +97,7 @@ export class Plugin<C = any> implements PluginFactory {
this.setConfig = p.setConfig
this.modifyBundlerConfig = p.modifyBundlerConfig
this.modifyBabelRc = p.modifyBabelRc
this.modifyFiles = p.modifyFiles
this.onCreateApp = p.onCreateApp
this.onServerListening = p.onServerListening
this.onPreBuild = p.onPreBuild
Expand Down
2 changes: 1 addition & 1 deletion packages/docz-core/src/commands/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Config } from './args'

export const build = async (args: Config) => {
const env = envDotProp.get('node.env')
const config = loadConfig(args)
const config = await loadConfig(args)
const entries = new Entries(config)

const bundler = webpack(config, env)
Expand Down
2 changes: 1 addition & 1 deletion packages/docz-core/src/commands/dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { loadConfig } from '../utils/load-config'

export const dev = async (args: Config) => {
const env = envDotProp.get('node.env')
const config = loadConfig(args)
const config = await loadConfig(args)
const port = await detectPort(config.port)
const hotPort = await detectPort(config.hotPort)
const websocketPort = await detectPort(config.websocketPort)
Expand Down
1 change: 1 addition & 0 deletions packages/docz-core/src/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ declare module 'detect-port'
declare module 'react-dev-utils/FileSizeReporter'
declare module 'react-dev-utils/formatWebpackMessages'
declare module 'react-dev-utils/printBuildError'
declare module 'p-reduce'
9 changes: 6 additions & 3 deletions packages/docz-core/src/utils/load-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const defaultHtmlContext = {
lang: 'en',
}

export const loadConfig = (args: Config): Config => {
export const loadConfig = async (args: Config): Promise<Config> => {
const defaultConfig = {
...args,
hashRouter: false,
Expand All @@ -33,6 +33,9 @@ export const loadConfig = (args: Config): Config => {
? loadFrom<Config>(path.resolve(args.config), defaultConfig)
: load<Config>('docz', defaultConfig)

const reduce = Plugin.reduceFromPlugins<Config>(config.plugins)
return omit<Config>(toOmit, reduce('setConfig', { ...config, paths }))
const reduceAsync = Plugin.reduceFromPluginsAsync<Config>(config.plugins)
return omit<Config>(
toOmit,
await reduceAsync('setConfig', { ...config, paths })
)
}