Skip to content

add context handlers #260

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

Merged
merged 4 commits into from
Jun 6, 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
38 changes: 36 additions & 2 deletions src/Documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@

class Documentation {
_props: Object;
_context: Object;
_childContext: Object;
_composes: Set<string>;
_data: Object;

constructor() {
this._props = new Map();
this._context = new Map();
this._childContext = new Map();
this._composes = new Set();
this._data = new Map();
}
Expand All @@ -41,6 +45,22 @@ class Documentation {
return propDescriptor;
}

getContextDescriptor(propName: string): PropDescriptor {
var propDescriptor = this._context.get(propName);
if (!propDescriptor) {
this._context.set(propName, propDescriptor = {});
}
return propDescriptor;
}

getChildContextDescriptor(propName: string): PropDescriptor {
var propDescriptor = this._childContext.get(propName);
if (!propDescriptor) {
this._childContext.set(propName, propDescriptor = {});
}
return propDescriptor;
}

toObject(): Object {
var obj = {};

Expand All @@ -50,8 +70,22 @@ class Documentation {

if (this._props.size > 0) {
obj.props = {};
for (var [name, descriptor] of this._props) {
obj.props[name] = descriptor;
for (var [propName, propDescriptor] of this._props) {
obj.props[propName] = propDescriptor;
}
}

if (this._context.size > 0) {
obj.context = {};
for (var [contextName, contextDescriptor] of this._context) {
obj.context[contextName] = contextDescriptor;
}
}

if (this._childContext.size > 0) {
obj.childContext = {};
for (var [childContextName, childContextDescriptor] of this._childContext) {
obj.childContext[childContextName] = childContextDescriptor;
}
}

Expand Down
32 changes: 32 additions & 0 deletions src/__tests__/__snapshots__/main-test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,22 @@ Object {

exports[`main fixtures processes component "component_5.js" without errors 1`] = `
Object {
"childContext": Object {
"color": Object {
"required": false,
"type": Object {
"name": "string",
},
},
},
"context": Object {
"config": Object {
"required": false,
"type": Object {
"name": "object",
},
},
},
"description": "",
"displayName": "Button",
"methods": Array [],
Expand Down Expand Up @@ -137,6 +153,22 @@ Object {

exports[`main fixtures processes component "component_6.js" without errors 1`] = `
Object {
"childContext": Object {
"color": Object {
"required": false,
"type": Object {
"name": "string",
},
},
},
"context": Object {
"config": Object {
"required": false,
"type": Object {
"name": "object",
},
},
},
"description": "",
"displayName": "Button",
"methods": Array [],
Expand Down
8 changes: 8 additions & 0 deletions src/__tests__/fixtures/component_5.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,12 @@ Button.propTypes = {
style: React.PropTypes.object,
};

Button.childContextTypes = {
color: React.PropTypes.string,
};

Button.contextTypes = {
config: React.PropTypes.object,
};

export default Button;
7 changes: 7 additions & 0 deletions src/__tests__/fixtures/component_6.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,11 @@ Button.propTypes = {
style: PropTypes.object,
};

Button.childContextTypes = {
color: PropTypes.string,
};

Button.contextTypes = {
config: PropTypes.object,
};
export default Button;
2 changes: 1 addition & 1 deletion src/handlers/__tests__/propTypeHandler-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jest.mock('../../utils/getPropType', () => jest.fn(() => ({})));

import {statement, expression} from '../../../tests/utils';
import Documentation from '../../Documentation';
import propTypeHandler from '../propTypeHandler';
import {propTypeHandler} from '../propTypeHandler';

describe('propTypeHandler', () => {
var getPropTypeMock;
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export {default as componentDocblockHandler} from './componentDocblockHandler';
export {default as componentMethodsHandler} from './componentMethodsHandler';
export {default as componentMethodsJsDocHandler} from './componentMethodsJsDocHandler';
export {default as defaultPropsHandler} from './defaultPropsHandler';
export {default as propTypeHandler} from './propTypeHandler';
export {propTypeHandler, contextTypeHandler, childContextTypeHandler} from './propTypeHandler';
export {default as propTypeCompositionHandler} from './propTypeCompositionHandler';
export {default as propDocBlockHandler} from './propDocBlockHandler';
export {default as displayNameHandler} from './displayNameHandler';
Expand Down
47 changes: 32 additions & 15 deletions src/handlers/propTypeHandler.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ function isPropTypesExpression(path) {
return false;
}

function amendPropTypes(documentation, path) {
function amendPropTypes(getDescriptor, path) {
if (!types.ObjectExpression.check(path.node)) {
return;
}

path.get('properties').each(function(propertyPath) {
switch (propertyPath.node.type) {
case types.Property.name:
var propDescriptor = documentation.getPropDescriptor(
var propDescriptor = getDescriptor(
getPropertyName(propertyPath)
);
var valuePath = propertyPath.get('value');
Expand All @@ -59,25 +59,42 @@ function amendPropTypes(documentation, path) {
var resolvedValuePath = resolveToValue(propertyPath.get('argument'));
switch (resolvedValuePath.node.type) {
case types.ObjectExpression.name: // normal object literal
amendPropTypes(documentation, resolvedValuePath);
amendPropTypes(getDescriptor, resolvedValuePath);
break;
}
break;
}
});
}

export default function propTypeHandler(
documentation: Documentation,
path: NodePath
) {
var propTypesPath = getMemberValuePath(path, 'propTypes');
if (!propTypesPath) {
return;
}
propTypesPath = resolveToValue(propTypesPath);
if (!propTypesPath) {
return;
function getPropTypeHandler(propName: string) {
return function (
documentation: Documentation,
path: NodePath
) {
var propTypesPath = getMemberValuePath(path, propName);
if (!propTypesPath) {
return;
}
propTypesPath = resolveToValue(propTypesPath);
if (!propTypesPath) {
return;
}
let getDescriptor;
switch(propName) {
case 'childContextTypes':
getDescriptor = documentation.getChildContextDescriptor;
break;
case 'contextTypes':
getDescriptor = documentation.getContextDescriptor;
break;
default:
getDescriptor = documentation.getPropDescriptor;
}
amendPropTypes(getDescriptor.bind(documentation), propTypesPath);
}
amendPropTypes(documentation, propTypesPath);
}

export const propTypeHandler = getPropTypeHandler('propTypes')
export const contextTypeHandler = getPropTypeHandler('contextTypes')
export const childContextTypeHandler = getPropTypeHandler('childContextTypes')
2 changes: 2 additions & 0 deletions src/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import * as utils from './utils';
var defaultResolver = resolver.findExportedComponentDefinition;
var defaultHandlers = [
handlers.propTypeHandler,
handlers.contextTypeHandler,
handlers.childContextTypeHandler,
handlers.propTypeCompositionHandler,
handlers.propDocBlockHandler,
handlers.flowTypeHandler,
Expand Down