document Options

update example,
fix package.json main

Author: Fabio Benedetti

example/src/app/App.tsx

@@ -1,40 +1,23 @@
 import * as React from 'react';
 import styled from 'styled-components';
-import { Component1 } from './Comp';
+import { Component1 } from './Component1';
 
 const BodyStyle = styled.div`
-  height: 60px;
   background: blue;
-  width: 100%;
-  display: flex;
-  position: absolute;
-  padding: 0 1rem;
-
-  @media (max-width: 1140px) {
-      padding-right: 0px;
-  }
+  padding: 20px;
 `;
 
 const Header = styled.h2`
   color: yellow;
 `;
 
-class App extends React.Component<{}, {isMounted: boolean}> {
-  state = {
-    isMounted: false
-  }
-  componentDidMount(){
-    this.setState({isMounted: true})
-  }
+class App extends React.Component<{}> {
+
   render(){
     return (
       <div>
         <BodyStyle>
           <Header>Welcome to Typescript Styled Components SSR</Header>
-          {
-            this.state.isMounted && 
-            <div>Test Mounted</div>
-          }
           <Component1 />
         </BodyStyle>
       </div>

example/src/app/Comp.tsx renamed to example/src/app/Component1.tsx

@@ -2,14 +2,16 @@ import * as React from 'react';
 import styled from 'styled-components';
 
 const Component1Style = styled.div`
-    height: 40px;
-    background: green;
-    width: 200;
-    display: flex;
+    background: #fff;
+    text-align: center;
 `;
 
+const TextStyle = styled.h3`
+    color:  #000;
+    font-weight: bold;
+`;
 export const Component1 : React.SFC = () =>  (
     <Component1Style>
-        Test
+        <TextStyle>SubComponent</TextStyle>
     </Component1Style>
 )

package.json

@@ -2,7 +2,7 @@
     "name": "typescript-plugin-styled-components",
     "version": "0.0.6",
     "description": "TypeScript transformer for improving the debugging experience of styled-components",
-    "main": "distor/index.js",
+    "main": "dist/index.js",
     "homepage": "https://github.com/Igorbek/typescript-plugin-styled-components",
     "repository": {
         "url": "https://github.com/Igorbek/typescript-plugin-styled-components.git",

src/models/Options.ts

@@ -5,10 +5,28 @@ export interface Options {
      * Default strategy is to use bindingName if it's defined and use inference algorithm from filename otherwise.
      */
     getDisplayName(filename: string, bindingName: string | undefined): string | undefined;
-        
+    
+    /**
+     * This array allow to identify the node name in case of style-components wrapper functions
+     */
     styledIdentifiers: string[];
-
+    
+    /**
+     * If set to true generates a unique componentId composed by the file path and the component name (default bindingName)
+     * default value: false
+     */
     ssr: boolean;
+
+    /**
+     * If set to true sets the component dispaly name
+     * default value: true
+     */
     displayName: boolean;
+
+    
+    /**
+     * String to determine what is the project root
+     * default value: package.json
+     */
     rootCheck: string;
 }