feature(add-template): map template files to actually generated files

[Delivers #30]
iAmao · Jun 13, 2017 · 21ece62 · 21ece62
1 parent e221996
commit 21ece62
Show file tree

Hide file tree

Showing 28 changed files with 288 additions and 6 deletions.
diff --git a/example/dist/css/style.css b/example/dist/css/style.css
@@ -0,0 +1,3 @@
+body {
+  margin: auto;
+}
diff --git a/example/dist/images/images.txt b/example/dist/images/images.txt
@@ -0,0 +1 @@
+All images will be stored in this folder
diff --git a/example/dist/index.html b/example/dist/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>(title)</title>
+</head>
+<body>
+  <div id="app"></div>
+  <script src="/bundle.js"></script>
+</body>
+</html>
diff --git a/example/dist/js/script.js b/example/dist/js/script.js
@@ -0,0 +1 @@
+// This is a custom javascript file
diff --git a/example/dist/vendor/vendor.txt b/example/dist/vendor/vendor.txt
@@ -0,0 +1 @@
+All vendors will be placed in this directory
diff --git a/example/package.json b/example/package.json
@@ -1,13 +1,13 @@
 {
   "version": "1.0.0",
-  "description": "React app",
-  "main": "index.js",
+  "description": "m",
+  "main": "m",
   "scripts": {
     "test": ""
   },
   "keywords": [],
-  "author": "emma",
-  "license": "MIT",
+  "author": "a",
+  "license": "I",
   "dependencies": {
     "axios": "^0.16.2",
     "babel-cli": "^6.24.1",

diff --git a/example/src/actions/actionTypes.js b/example/src/actions/actionTypes.js
@@ -0,0 +1,3 @@
+export default {
+
+}
diff --git a/example/src/components/Home.component.jsx b/example/src/components/Home.component.jsx
@@ -0,0 +1,22 @@
+import React from 'react';
+
+/**
+ * Home page view
+ * @class Home
+ * @extends {React.Component}
+ */
+class Home extends React.Component {
+
+  /**
+   * Renders the view of the component
+   * @returns {Object} react component to render
+   * @memberOf Home
+   */
+  render() {
+    return (
+      <h2>Home page</h2>
+    );
+  }
+}
+
+export default Home;
diff --git a/example/src/components/Routes.component.jsx b/example/src/components/Routes.component.jsx
@@ -0,0 +1,34 @@
+import React from 'react';
+import { Router, Route, IndexRoute, browserHistory } from 'react-router';
+import Common from './common/Common.component';
+import Home from './Home.component';
+import About from './static/About.component';
+
+const routes = (
+  <Route path="/" component={Common}>
+    <IndexRoute component={Home} />
+    <Route path="/about" component={About} />
+  </Route>
+);
+
+
+/**
+ * Declare and define all routes in the application
+ * @class Routes
+ * @extends {React.Component}
+ */
+class Routes extends React.Component {
+
+  /**
+   * Renders the view of the component
+   * @returns {Object} react component to render
+   * @memberOf Routes
+   */
+  render() {
+    return (
+      <Router history={browserHistory} routes={routes} />
+    );
+  }
+}
+
+export default Routes;
diff --git a/example/src/components/common/Common.component.jsx b/example/src/components/common/Common.component.jsx
@@ -0,0 +1,27 @@
+import React from 'react';
+
+/**
+ * Component to persist across all routes
+ * @class Common
+ * @extends {React.Component}
+ */
+class Common extends React.Component {
+
+  /**
+   * Renders the view of the component
+   * @returns {Object} react component to render
+   * @memberOf Common
+   */
+  render() {
+    return (
+      <div>
+        <nav>
+          <h2>Navbar</h2>
+        </nav>
+        {this.props.children}
+      </div>
+    );
+  }
+}
+
+export default Common;
diff --git a/example/src/components/static/About.component.jsx b/example/src/components/static/About.component.jsx
@@ -0,0 +1,22 @@
+import React from 'react';
+
+/**
+ * About page view
+ * @class About
+ * @extends {React.Component}
+ */
+class About extends React.Component {
+
+  /**
+   * Renders the view of the component
+   * @returns {Object} react component to render
+   * @memberOf About
+   */
+  render() {
+    return (
+      <h2>About page</h2>
+    );
+  }
+}
+
+export default About;
diff --git a/example/src/index.jsx b/example/src/index.jsx
@@ -0,0 +1,16 @@
+import React from 'react';
+import ReactDom from 'react-dom';
+import { Provider } from 'react-redux';
+import store from './store';
+import Routes from './components/Routes.component';
+
+require('./sass/style.scss');
+require('./sass/style.less');
+
+
+ReactDom.render(
+  <Provider store={store}>
+    <Routes />
+  </Provider>,
+  document.getElementById('app')
+);
diff --git a/example/src/reducers/root.reducer.js b/example/src/reducers/root.reducer.js
@@ -0,0 +1,8 @@
+import { combineReducers } from 'redux';
+import reduceReducers from 'reduce-reducers';
+
+const combinedReducers = combineReducers({
+
+});
+
+export default reduceReducers(combinedReducers);
diff --git a/example/src/store.js b/example/src/store.js
@@ -0,0 +1,11 @@
+import { applyMiddleware, createStore, compose } from 'redux';
+import thunk from 'redux-thunk';
+import reducers from './reducers/root.reducer';
+
+const middleware = [thunk];
+
+const finalCreateStore = compose(
+    applyMiddleware(...middleware)
+  )(createStore);
+
+export default finalCreateStore(reducers);
diff --git a/example/src/utils/helper.js b/example/src/utils/helper.js
@@ -0,0 +1,45 @@
+import axios from 'axios';
+
+/**
+ * Set the a value inside localStorage
+ * @export
+ * @param {String} key - key to store value with in localStorage
+ * @param {String} value - item to store inside localStorage
+ * @returns {Promise} returns a promise and resolves it with the stored value
+ */
+export function setLocalstorage(key, value) {
+  let storedValue;
+  return new Promise((resolve) => {
+    window.localStorage.setItem(key, value);
+    storedValue = window.localStorage.getItem(key);
+    if (storedValue) {
+      resolve(storedValue);
+    }
+  });
+}
+
+/**
+ * set a default header in axios
+ * @export
+ * @param {String} header - header name to set
+ * @param {String} value - value to set header as
+ * @returns {Void} does not have a return value
+ */
+export function setDefaultHeader(header, value) {
+  axios.defaults.headers.common.Authorization = value;
+}
+
+
+/**
+ * clear or remove one or all items from localStorage
+ * @export
+ * @param {String} key - item to remove in localStorage
+ * @returns {Void} does not have a return value
+ */
+export function clearStorage(key) {
+  if (!key) {
+    window.localStorage.clear();
+  } else {
+    window.localStorage.removeItem(key);
+  }
+}
diff --git a/example/test/actions/actionTypes.spec.js b/example/test/actions/actionTypes.spec.js
@@ -0,0 +1,7 @@
+import actionTypes from '../../src/actions/actionTypes';
+
+describe('actionTypes', () => {
+  it('should return an object of actions', () => {
+    expect(actionTypes).to.be.an.object;
+  });
+});
diff --git a/example/test/components/Home.component.spec.js b/example/test/components/Home.component.spec.js
@@ -0,0 +1,16 @@
+/* global expect:true */
+/* global shallow:true */
+/* global mount:true */
+
+import React from 'react';//eslint-disable-line
+
+import Home from '../../src/components/Home.component';
+
+describe('<Home />', () => {
+  it('should have a heading text', () => {
+    const wrapper = shallow(
+      <Home />
+    );
+    expect(wrapper.find('.heading')).to.have.length(1);
+  });
+});
diff --git a/example/test/e2e/e2e.txt b/example/test/e2e/e2e.txt
@@ -0,0 +1 @@
+// write e2e tests here
diff --git a/example/test/helper.js b/example/test/helper.js
@@ -0,0 +1,45 @@
+import axios from 'axios';
+
+/**
+ * Set the a value inside localStorage
+ * @export
+ * @param {String} key - key to store value with in localStorage
+ * @param {String} value - item to store inside localStorage
+ * @returns {Promise} returns a promise and resolves it with the stored value
+ */
+export function setLocalstorage(key, value) {
+  let storedValue;
+  return new Promise((resolve) => {
+    window.localStorage.setItem(key, value);
+    storedValue = window.localStorage.getItem(key);
+    if (storedValue) {
+      resolve(storedValue);
+    }
+  });
+}
+
+/**
+ * set a default header in axios
+ * @export
+ * @param {String} header - header name to set
+ * @param {String} value - value to set header as
+ * @returns {Void} does not have a return value
+ */
+export function setDefaultHeader(header, value) {
+  axios.defaults.headers.common.Authorization = value;
+}
+
+
+/**
+ * clear or remove one or all items from localStorage
+ * @export
+ * @param {String} key - item to remove in localStorage
+ * @returns {Void} does not have a return value
+ */
+export function clearStorage(key) {
+  if (!key) {
+    window.localStorage.clear();
+  } else {
+    window.localStorage.removeItem(key);
+  }
+}
diff --git a/example/test/mocha-helper.js b/example/test/mocha-helper.js
diff --git a/example/test/reducers/root.reducer.spec.js b/example/test/reducers/root.reducer.spec.js
@@ -0,0 +1,3 @@
+describe('Root Reducer', () => {
+
+});
diff --git a/lib/Structure.js b/lib/Structure.js
@@ -19,6 +19,7 @@ class Structure {
   constructor(extend = '', schema) {
     this.schema = schema || structureSchema;
     this.filepath = `${baseDir.getCurrentWorkingDir()}/${extend}`;
+    this.mainpath = path.join(__dirname, '../');
   }
 
   /**
@@ -40,11 +41,14 @@ class Structure {
           path.join(this.filepath, `/example/${pathname.join('/')}`));
         this.traverse(root[Object.keys(root)[0]], pathname);
       } else {
+        const template = fs.readFileSync(
+          path.join(this.mainpath, `/sample/${root}.sample`))
+          .toString();
         fs.writeFile(
           path.join(
             this.filepath,
             `/example/${pathname.join('/')}/${root}`),
-          '');
+          template);
         if (index === parent.length - 1) {
           pathname.pop();
         }

diff --git a/sample/e2e.txt → sample/e2e.txt.sample b/sample/e2e.txt → sample/e2e.txt.sample
diff --git a/sample/folder-schema.js b/sample/folder-schema.js
@@ -3,7 +3,7 @@ module.exports = [
     src: [
       {
         components: [
-          { common: ['Button.component.jsx'] },
+          { common: ['Common.component.jsx'] },
           { static: ['About.component.jsx'] },
           'Routes.component.jsx',
           'Home.component.jsx'

diff --git a/sample/image.txt → sample/images.txt.sample b/sample/image.txt → sample/images.txt.sample
diff --git a/sample/red.txt.sample b/sample/red.txt.sample
@@ -0,0 +1 @@
+test file
diff --git a/sample/text.txt.sample b/sample/text.txt.sample
@@ -0,0 +1 @@
+test file
diff --git a/sample/vendor.txt → sample/vendor.txt.sample b/sample/vendor.txt → sample/vendor.txt.sample