@charlietango/react-docs-net
Advanced tools
{ | ||
"name": "@charlietango/react-docs-net", | ||
"description": "Package and publish a NuGet package to a custom feed.", | ||
"version": "2.5.0", | ||
"version": "3.0.0", | ||
"main": "lib/index.js", | ||
@@ -40,10 +40,10 @@ "bin": { | ||
"babel-preset-react": "^6.24.1", | ||
"chokidar": "^2.0.3", | ||
"flow-bin": "^0.73.0", | ||
"jest": "^23.1.0", | ||
"chokidar": "^2.0.4", | ||
"flow-bin": "^0.76.0", | ||
"jest": "^23.4.1", | ||
"jest-plugin-fs": "^2.7.0", | ||
"minimist": "^1.2.0", | ||
"prettier": "^1.13.3", | ||
"prettier": "^1.13.7", | ||
"strip-ansi": "^4.0.0" | ||
} | ||
} |
@@ -6,14 +6,16 @@ # React Docs Net | ||
## Warning | ||
> ⚠️ **Warning** | ||
> | ||
> This is a basic rewrite of the React props to C#/.NET. No validation is done on the actual files. | ||
> Not all Flow features are supported, since there's not a simple way to convert them to C#. | ||
This is a basic rewrite of the React props to C#/.NET. No validation is done on the actual files. | ||
Not all Flow features are supported, since there's not a simple way to convert them to C#. | ||
- All models are converted to upper camelcase, with `ViewModel` appendend. | ||
- Enum models are converted to upper camelcase, with `Types` appended | ||
- Flow `number` is converted to `int`. Use `@type {TYPE}` in comment tag for the prop, to change the number type. | ||
* Flow `number` is converted to `int`. Use `@type {TYPE}` in comment tag for the prop, to change the number type. | ||
## Requirements | ||
* **Node 8.x+** | ||
* **Flow** Currently only supports extracting models from Flow Types. | ||
* **react-docgen** JSON files | ||
- **Node 8.x+** | ||
- **Flow** Currently only supports extracting models from Flow Types. | ||
- **react-docgen** JSON files | ||
@@ -28,15 +30,2 @@ ## Usage | ||
Generate JSON files with react-docgen, and process them: | ||
```js | ||
const docNet = require('@charlietango/react-docs-net'); | ||
docNet.fromJson('src/models/**/*.json', { | ||
namespace: 'Dk.CharlieTango', | ||
dest: 'dist/models', // Add dest to write to files | ||
}); | ||
``` | ||
or create the models with the models directly | ||
Generate JSON files with `react-docgen`, and process them: | ||
@@ -74,3 +63,3 @@ | ||
* `@internal` - Ignore this prop - It's only used internally in the React App. | ||
* `@type` - Set a specific C# type for this prop - Like `decimal` | ||
- `@internal` - Ignore this prop - It's only used internally in the React App. | ||
- `@type` - Set a specific C# type for this prop - Like `decimal` |
44269
-0.32%63
-14.86%