Merge pull request #3 from faebeee/feature/settings

Add persistent settings for redux

Author: faebeee

CHANGE-NOTES.md

@@ -1,3 +1,5 @@
+- v0.4.0 Add Customisable templates. Improve a lot of code. Update doc
+- v0.2.1 Export enum for action types
 - v0.2.1 Export enum for action types
 - v0.2.0 Add `Add Redux Reducer` Action
 - v0.1.0 Add `Add React Component` Action

README.md

@@ -1,15 +1,44 @@
 # react-component-creator
 - An Brainstorm Plugin to create a new react functional component with all additional files like
 SCSS, Spec, Storybook.
-- Add Redux reducer module with actions, mutations, state and types
+- Add Redux reducer module with actions, mutations, state and types.
+- Add custom templates to match your coding style and your needs.
 
 
+![Create Reducer](./doc/settings.png "")
 ![Create component](./doc/create_component.gif "")
 ![Create Reducer](./doc/create_reducer.gif "")
 
 # Install
 Search for `React Component Creator` in the plugins settings. Or download the plugin from the [release site](https://github.com/faebeee/react-component-creator-plugin/releases)
 
+# Custom Templates
+If you are not happy with the predefined templates, you can choose your
+own templates. The templates will be processed with mustache as templating.
+All variables can also be used for the filenames.
+
+Following variables are available
+
+
+**Component**
+
+| variable | Description |
+|---|---|
+| {{componentName}} | the inputted component name. Without any alterations |
+| {{componentCamelcaseName}} | Camelcased input `my-component` becomes `MyComponent` |
+
+**Reducer**
+
+| variable | Description |
+|---|---|
+| {{actionFunctionName}} | Name of the function inside the `actions.ts` file |
+| {{moduleName}} | Name of the folder |
+| {{mutationType}} | String which will be used as type of the dispatch/mutation |
+| {{moduleNamePascalCase}} | Pascalcased moduleName |
+| {{stateName}} | Name for the state. `my-component` becomes `MyComponentState` |
+| {{actionTypeName}} | Takes the input of `actionFunctionName` and capitalizes the first letter and appends `Action`. From `setData` becomes `SetDataAction` |
+| {{actionTypesEnumName}} | Name used for the action types enum. actionTypesEnumName is the namespace where all `mutationType` actions are kept |
+
 
 # Development
 Follow the [Setup Instructions](./doc/DEVELOPMENT.md)

doc/settings.png

@@ -1,7 +1,7 @@
 <idea-plugin>
     <id>com.faebeee.reactcomponentcreator</id>
     <name>React Component Creator</name>
-    <version>0.3.1</version>
+    <version>0.4.0</version>
     <vendor email="[email protected]" url="http://fabs.io">Fabio Gianini</vendor>
 
     <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html for description -->
@@ -17,39 +17,95 @@
             <ul>
               <li>An Brainstorm Plugin to create a new react functional component with all additional files like
                 SCSS, Spec, Storybook.</li>
-              <li>Add Redux reducer module with actions, mutations, state and types</li>
+              <li>Add Redux reducer module with actions, mutations, state and types.</li>
+              <li>Add custom templates to match your coding style and your needs.</li>
             </ul>
+            <h1><a href="#custom-templates" id="custom-templates">Custom Templates</a></h1>
+            <p>If you are not happy with the predefined templates, you can choose your
+            own templates. The templates will be processed with mustache as templating.
+            All variables can also be used for the filenames.</p>
+            <p>Following variables are available</p>
+            <p><strong>Component</strong></p>
+            <table>
+              <thead>
+                <tr><th> variable </th><th> Description </th></tr>
+              </thead>
+              <tbody>
+                <tr><td> {{componentName}} </td><td> the inputted component name. Without any alterations </td></tr>
+                <tr><td> {{componentCamelcaseName}} </td><td> Camelcased input <code>my-component</code> becomes <code>MyComponent</code> </td></tr>
+              </tbody>
+            </table>
+            <p><strong>Reducer</strong></p>
+            <table>
+              <thead>
+                <tr><th> variable </th><th> Description </th></tr>
+              </thead>
+              <tbody>
+                <tr><td> {{actionFunctionName}} </td><td> Name of the function inside the <code>actions.ts</code> file </td></tr>
+                <tr><td> {{moduleName}} </td><td> Name of the folder </td></tr>
+                <tr><td> {{mutationType}} </td><td> String which will be used as type of the dispatch/mutation </td></tr>
+                <tr><td> {{moduleNamePascalCase}} </td><td> Pascalcased moduleName </td></tr>
+                <tr><td> {{stateName}} </td><td> Name for the state. <code>my-component</code> becomes <code>MyComponentState</code> </td></tr>
+                <tr><td> {{actionTypeName}} </td><td> Takes the input of <code>actionFunctionName</code> and capitalizes the first letter and appends <code>Action</code>. From <code>setData</code> becomes <code>SetDataAction</code> </td></tr>
+                <tr><td> {{actionTypesEnumName}} </td><td> Name used for the action types enum. actionTypesEnumName is the namespace where all <code>mutationType</code> actions are kept </td></tr>
+              </tbody>
+            </table>
         ]]>
     </description>
 
     <change-notes>
         <![CDATA[
            <ul>
-              <li>v0.3.1 Export enum for action types</li>
-              <li>v0.3.0 Add <code>Add Redux Reducer</code> Action</li>
-              <li>v0.2.0 Update UI & improve code</li>
+              <li>v0.4.0 Add Customisable templates. Improve a lot of code. Update doc</li>
+              <li>v0.2.1 Export enum for action types</li>
+              <li>v0.2.1 Export enum for action types</li>
+              <li>v0.2.0 Add <code>Add Redux Reducer</code> Action</li>
               <li>v0.1.0 Add <code>Add React Component</code> Action</li>
             </ul>
         ]]>
     </change-notes>
 
 
     <extensions defaultExtensionNs="com.intellij">
-        <!-- Add your extensions here -->
+        <projectConfigurable
+                instance="fabs.component.settings.ComponentSettings"
+                id="rcc.settings"
+                displayName="React Component Creator"
+                nonDefaultProject="true"/>
+
+        <projectConfigurable
+                instance="fabs.reducer.settings.ReducerSettings"
+                id="rcc.settings.redux"
+                displayName="Redux"
+                parentId="rcc.settings"
+                nonDefaultProject="true"/>
+
+        <projectConfigurable
+                instance="fabs.component.settings.ComponentSettings"
+                id="rcc.settings.component"
+                displayName="Component"
+                parentId="rcc.settings"
+                nonDefaultProject="true"/>
+
+        <projectService serviceInterface="fabs.reducer.data.ReducerSettingsState"
+                        serviceImplementation="fabs.reducer.data.ReducerSettingsState"/>
+
+        <projectService serviceInterface="fabs.component.data.ComponentSettingsState"
+                        serviceImplementation="fabs.component.data.ComponentSettingsState"/>
     </extensions>
 
     <actions>
         <group description="React" id="React">
             <separator/>
             <action id="ReactComponent.ComponentCreatorAction"
-                    class="fabs.component.ComponentCreatorAction"
+                    class="fabs.component.action.ComponentCreatorAction"
                     icon="/icons/component.png"
                     text="React component"
                     description="create new react component">
             </action>
 
             <action id="ReactComponent.ReducerCreatorAction"
-                    class="fabs.reducer.ReducerCreatorAction"
+                    class="fabs.reducer.action.ReducerCreatorAction"
                     icon="/icons/store.png"
                     text="Redux reducer"
                     description="create new redux reducer">

resources/META-INF/plugin.xml

@@ -2,6 +2,6 @@ import { Dispatch } from 'redux';
 import { {{ actionTypesEnumName }} } from './action-types';
 import { {{ actionTypeName }} } from './types';
 
-export const {{ actionFunctionName }} = () => async (dispatch: Dispatch<{{ actionTypesEnumName }}.{{ actionTypeName }}>) => {
-    dispatch({ type: {{ mutationType }} , data });
+export const {{ actionFunctionName }} = (data: any) => (dispatch: Dispatch<{{ actionTypeName }}>) => {
+    dispatch({ type: {{ actionTypesEnumName }}.{{ mutationType }}, data });
 };