From 58f4705aabbb82f25a757ec9fc4176bc95327216 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C5=A1a=20=C4=90uri=C4=87?= Date: Sat, 8 Jan 2022 17:45:17 +0100 Subject: [PATCH] Updated readme --- README.md | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1db526a..3c6686a 100644 --- a/README.md +++ b/README.md @@ -138,6 +138,7 @@ The configuration file contains the next scopes (fields): | format | boolean | Uses prettier if it's used to format created files | | verbose | boolean | Outputs operation and file path on stdout | | fileNaming | [FileNaming](#filenaming) | Define file naming | +| export | [Export](#export) | Define export preferences | ### ComponentConfig @@ -156,6 +157,7 @@ The configuration file contains the next scopes (fields): | typescript | boolean | Use typescript | | inFolder | boolean | Save the file in its own folder | | fileNaming | [FileNaming](#filenaming) | Define file naming | +| export | [Export](#export) | Define export preferences | | override | [ComponentOverrideConfig](#componentconfigoverride) | Override configuration of style, storybook, or test | #### ComponentOverrideConfig @@ -176,6 +178,7 @@ The configuration file contains the next scopes (fields): | typescript | boolean | Use typescript (for css in js solutions) | | inFolder | boolean | Save the file in its own folder | | fileNaming | [FileNaming](#filenaming) | Define file naming | +| export | [Export](#export) | Define export preferences for CSS in JS styling solutions | ### StorybookConfig @@ -204,18 +207,20 @@ The configuration file contains the next scopes (fields): | typescript | boolean | Use typescript | | inFolder | boolean | Save the file in its own folder | | fileNaming | [FileNaming](#filenaming) | Define file naming | +| export | [Export](#export) | Define export preferences | ### ContextConfig -| Option | Type | Description | -| -------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| open | boolean | Open file in default editor after creating | -| path | string | Specify the path for the file relative to the project source path defined in the project configuration entry | -| typescript | boolean | Use typescript | -| inFolder | boolean | Save the file in its own folder | -| customProvider | boolean | Create custom wrapper component around context provider | -| hook | boolean | Create hook inside context file for context usage | -| fileNaming | [FileNaming](#filenaming) | Define file naming | +| Option | Type | Description | +| -------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| open | boolean | Open file in default editor after creating | +| path | string | Specify the path for the file relative to the project source path defined in the project configuration entry | +| typescript | boolean | Use typescript | +| inFolder | boolean | Save the file in its own folder | +| customProvider | boolean | Create custom wrapper component around context provider | +| hook | boolean | Create hook inside context file for context usage | +| fileNaming | [FileNaming](#filenaming) | Define file naming | +| export | [Export](#export) & destructure: boolean | Define export preferences |
@@ -228,6 +233,13 @@ The configuration file contains the next scopes (fields): | postfixDevider | string | Define postfix devider | | casing | camel \| pascal \| kebab \| snake | Specify casing type | +#### Export + +| Option | Type | Description | +| ------- | -------------------- | ---------------------------------------- | +| default | boolean | Specify export type (default or named) | +| inline | boolean | Specify should export be declared inline | + #### Name types #### Component @@ -284,6 +296,10 @@ The configuration file contains the next scopes (fields): "casing": "kebab", "postfix": "", "postfixDevider": "." + }, + "export": { + "default": false, + "inline": true } }, "component": { @@ -293,7 +309,6 @@ The configuration file contains the next scopes (fields): "test": true, "proptypes": true, "index": true, - "defaultExport": true, "inFolder": true, "open": true, "fileNaming": {