Skip to content

Commit 7050e0b

Browse files
committed
📝 Update documentation
1 parent 2ab9bfa commit 7050e0b

1 file changed

Lines changed: 22 additions & 6 deletions

File tree

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,27 @@ A set of usefull snippets and commands we use at Ackee for web apps development.
66

77
## Features
88

9-
* Commands for project scaffolding
9+
* Commands for project scaffolding (typescript supported)
1010
* React/Fela snippets
1111

12+
## Contents
13+
14+
- [Commands](#commands)
15+
- [Settings](#settings)
16+
- [Snippets](#snippets)
17+
1218
## Commands
1319

1420
### Create component
15-
* `Component.jsx` - React stateless component
16-
* `index.js` - index file to export the React component
21+
* `Component.(j|t)sx` - React stateless component
22+
* `index.(j|t)s` - index file to export the React component
1723

1824
### Create Fela component
1925

2026
Creates a folder with following structure:
21-
* `Component.jsx` - React stateless component with `styles` prop
22-
* `Component.styles.js` - fela rules
23-
* `index.js` - index file to export the React component and wrap it with `connectFela`
27+
* `Component.(j|t)sx` - React stateless component with `styles` prop
28+
* `Component.styles.(j|t)s` - fela rules
29+
* `index.(j|t)s` - index file to export the React component and wrap it with `connectFela`
2430

2531
#### Usage
2632
1. Right click to a folder where you want to create a component
@@ -31,6 +37,16 @@ Creates a folder with following structure:
3137

3238
> **Note**: The command can also be triggered by a shortcut `cmd+a cmd+c` or by VS Code command line. But in that case the component is created in root directory of a project, because VS Code API does not provide selected folder in the explorer window. See [this issue](https://github.com/Microsoft/vscode/issues/3553) for more info.
3339
40+
## Settings
41+
42+
These settings can be changed in VS Code settings under `ackeeFrontend` namespace.
43+
44+
| Name | Default value | Description |
45+
|---|---|---|
46+
| `moduleDependencies` | `true` | If enabled it uses named imports from dependencies.js file of the module. |
47+
| `felaHooks` | `false` | If enabled, scaffolded components will use enhanced fela hooks instead of connect HOC. |
48+
| `typescript` | `false` | If enabled, scaffolded components will be in TypeScript. |
49+
3450
## Snippets
3551

3652
Supported languages:

0 commit comments

Comments
 (0)