feat: strip \n

Author: afeiship

__tests__/basic.test.js

@@ -2,9 +2,7 @@ const reactMarkdownProps = require('../src');
 
 describe('Basic test', () => {
  test('test development', () => {
-
  console.log(reactMarkdownProps('__tests__/components/index.js'));
-
  // expect(true).toBe(true);
  });
 });

__tests__/components/index2.js

@@ -0,0 +1,122 @@
+import React, { Component } from 'react';
+import ReactDOM from 'react-dom';
+import PropTypes from 'prop-types';
+import classNames from 'classnames';
+import noop from '@feizheng/noop';
+import objectAssign from 'object-assign';
+import { Form, Button } from 'antd';
+
+const CLASS_NAME = 'react-ant-form';
+export default Form.create()(
+ class ReactAntForm extends Component {
+ static displayName = CLASS_NAME;
+ static version = '__VERSION__';
+ static propTypes = {
+ /**
+ * The extended className for component.
+ */
+ className: PropTypes.string,
+ /**
+ * Default fileds value object.
+ */
+ fieldsValue: PropTypes.object,
+ /**
+ * Form schema.
+ */
+ items: PropTypes.array,
+ /**
+ * The onSubmit event.
+ */
+ onSubmit: PropTypes.func,
+ /**
+ * When component did mount.
+ */
+ onLoad: PropTypes.func,
+ /**
+ * The formLayout for antd.Form.
+ */
+ formLayout: PropTypes.object,
+ /**
+ * The submit label.
+ */
+ submitLabel: PropTypes.string,
+ /**
+ * The submit props.
+ */
+ submitProps: PropTypes.object
+ };
+
+ static defaultProps = {
+ fieldsValue: {},
+ items: [],
+ onSubmit: noop,
+ onLoad: noop,
+ formLayout: {
+ labelCol: { span: 6 },
+ wrapperCol: { span: 16 }
+ },
+ submitLabel: ' ',
+ submitProps: {
+ type: 'primary',
+ htmlType: 'submit',
+ children: 'Save'
+ }
+ };
+
+ componentDidMount() {
+ const { onLoad, fieldsValue, form } = this.props;
+ const { getFieldDecorator, setFields } = form;
+ objectAssign(this, { $form: form });
+ setFields(fieldsValue);
+ onLoad({
+ target: {
+ sender: this,
+ value: this.props
+ }
+ });
+ }
+
+ handleSubmit = (inEvent) => {
+ inEvent.preventDefault();
+ const { onSubmit, form } = this.props;
+ form.validateFields((err, values) => {
+ if (!err) {
+ onSubmit(values);
+ }
+ });
+ };
+
+ render() {
+ const { className, items, formLayout, submitLabel, submitProps } = this.props;
+ const { getFieldDecorator } = this.props.form;
+
+ return (
+ <Form
+ data-component={CLASS_NAME}
+ className={classNames(CLASS_NAME, className)}
+ onSubmit={this.handleSubmit}>
+ {items.map((item, index) => {
+ return (
+ <Form.Item
+ className="react-ant-form-field"
+ {...formLayout}
+ key={index}
+ label={item.label}>
+ {getFieldDecorator(item.field, {
+ rules: item.rules
+ })(<item.component {...item.props} />)}
+ </Form.Item>
+ );
+ })}
+ <Form.Item
+ {...formLayout}
+ className="react-ant-form-submit"
+ label={submitLabel}
+ colon={false}>
+ <Button {...submitProps} />
+ </Form.Item>
+ </Form>
+ );
+ }
+ }
+);

dist/index.js

@@ -1,8 +1,8 @@
 /*!
  * name: @feizheng/react-markdown-props
  * url: https://github.com/afeiship/react-markdown-props
- * version: 1.1.0
+ * version: 1.2.0
  * license: MIT
  */
 
-var reactDocs=require("react-docgen"),fs=require("fs"),json2md=require("json2md"),prettier=require("prettier");require("@feizheng/next-js-core2"),module.exports=function(e,r){var t=fs.readFileSync(e),a=reactDocs.parse(t),n=[];nx.forIn(a.props,function(e,r){n.push([e,r.type.name,nx.get(r,"defaultValue.value")||"-",r.description])});var o=json2md({table:{headers:["Name","Type","Default","Description"],rows:n}});return prettier.format(o,{parser:"markdown"})};
+var reactDocs=require("react-docgen"),fs=require("fs"),json2md=require("json2md"),prettier=require("prettier");require("@feizheng/next-js-core2"),module.exports=function(e,r){var t=fs.readFileSync(e),n=reactDocs.parse(t),a=[];nx.forIn(n.props,function(e,r){var t=nx.get(r,"defaultValue.value","-");t.includes("\n")&&(t="-"),a.push([e,r.type.name,t,r.description])});var s=json2md({table:{headers:["Name","Type","Default","Description"],rows:a}});return prettier.format(s,{parser:"markdown"})};

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@feizheng/react-markdown-props",
- "version": "1.1.0",
+ "version": "1.2.0",
  "description": "Generate markdown properties string.",
  "homepage": "https://github.com/afeiship/react-markdown-props",
  "author": {
@@ -14,23 +14,23 @@
  "main": "dist/index.js",
  "license": "MIT",
  "devDependencies": {
- "@feizheng/next-nice-comments": "^1.0.0",
+ "@feizheng/next-nice-comments": "^1.0.1",
  "del": "^5.1.0",
  "gulp": "^4.0.2",
- "gulp-header": "^2.0.7",
- "gulp-load-plugins": "^2.0.1",
+ "gulp-header": "^2.0.9",
+ "gulp-load-plugins": "^2.0.2",
  "gulp-size": "^3.0.0",
  "gulp-uglify": "^3.0.2",
- "jest": "^24.8.0",
+ "jest": "^25.1.0",
  "react": "^16.12.0"
  },
  "publishConfig": {
  "registry": "https://registry.npmjs.org/"
  },
  "dependencies": {
- "@feizheng/next-js-core2": "^2.4.0",
+ "@feizheng/next-js-core2": "^2.4.1",
  "json2md": "^1.6.5",
  "prettier": "^1.19.1",
- "react-docgen": "^5.1.0"
+ "react-docgen": "^5.2.1"
  }
 }

src/index.js

@@ -11,12 +11,9 @@ module.exports = function(inFilePath, inOptions) {
  var rows = [];
 
  nx.forIn(info.props, function(key, value) {
- rows.push([
- key,
- value.type.name,
- nx.get(value, 'defaultValue.value') || '-',
- value.description
- ]);
+ var _value = nx.get(value, 'defaultValue.value', '-');
+ _value.includes('\n') && (_value = '-');
+ rows.push([key, value.type.name, _value, value.description]);
  });
 
  var mdstring = json2md({