Merge pull request #44 from SDOS2020/avi

move extra functions to helpers.py

Author: Aniket-Pradhan

.github/workflows/python-package.yml .github/workflows/python-linter.yml

@@ -1,7 +1,7 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will installs Python dependencies, and lints the codebase
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python package
+name: Python Linter
 
 on:
   push:
@@ -15,24 +15,20 @@ jobs:
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8, 3.9]
-
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python ${{ matrix.python-version }} 🛎️
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Install dependencies ✔️
         run: |
           python -m pip install --upgrade pip
           pip install flake8 pytest
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Lint with flake8
+      - name: Lint with flake8 ✨
         run: |
           # stop the build if there are Python syntax errors or undefined names
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
           # exit-zero treats all errors as warnings.
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics
-    # - name: Test with pytest
-    #   run: |
-    #     pytest

reactonite/helpers.py

@@ -0,0 +1,68 @@
+import json
+import os
+
+
+def create_dir(path):
+    """Creates directory at the given path if it doesn't exist.
+
+    Parameters
+    ----------
+    path : str
+        Path to directory which needs to be created.
+
+    Raises
+    ------
+    RuntimeError
+        Raised if directory can't be created.
+    """
+
+    if os.path.isdir(path):
+        print("{} already exists. Skipping.".format(path))
+        return
+
+    os.makedirs(path)
+    if not os.path.isdir(path):
+        raise RuntimeError('Folder can not be created at ' + str(path))
+
+
+def create_file(path):
+    """Creates the file at the given path if it doesn't exist.
+
+    Parameters
+    ----------
+    path : str
+        Path to file which needs to be created.
+
+    Raises
+    ------
+    RuntimeError
+        Raised if file can't be created.
+    """
+
+    open(path, 'w').close()
+    if not os.path.isfile(path):
+        raise RuntimeError('File can not be created at ' + str(path))
+
+
+def write_to_json_file(path, content):
+    """Writes content to a json file at the given path. Raises
+    exception if file not exists.
+
+    Parameters
+    ----------
+    path : str
+        Path to file where content will be dumped.
+    content : dict
+        Dictonary to be dumped into the file.
+
+    Raises
+    ------
+    FileNotFoundError
+        Raised if file doesn't exist.
+    """
+
+    if not os.path.isfile(path):
+        raise FileNotFoundError('File can not be reached at ' + str(path))
+
+    with open(path, 'w') as outfile:
+        json.dump(content, outfile, indent=4, sort_keys=True)

reactonite/main.py

@@ -5,53 +5,12 @@
 import click
 
 from reactonite.config import DEFAULTS
+from reactonite.helpers import create_dir, create_file, write_to_json_file
 from reactonite.node_wrapper import NodeWrapper
 from reactonite.transpiler import Transpiler
 from reactonite.watcher import ReactoniteWatcher
 
 
-def create_dir(path):
-    """Creates directory at the given path if it doesn't exist.
-
-    Parameters
-    ----------
-    path : str
-        Path to directory which needs to be created.
-
-    Raises
-    ------
-    RuntimeError
-        Raised if directory can't be created.
-    """
-
-    if os.path.isdir(path):
-        print("{} already exists. Skipping.".format(path))
-        return
-
-    os.makedirs(path)
-    if not os.path.isdir(path):
-        raise RuntimeError('Folder can not be created at ' + str(path))
-
-
-def create_file(path):
-    """Creates the file at the given path if it doesn't exist.
-
-    Parameters
-    ----------
-    path : str
-        Path to file which needs to be created.
-
-    Raises
-    ------
-    RuntimeError
-        Raised if file can't be created.
-    """
-
-    open(path, 'w').close()
-    if not os.path.isfile(path):
-        raise RuntimeError('File can not be created at ' + str(path))
-
-
 @click.group()
 def cli():
     """Entry point for reactonite cli."""
@@ -112,6 +71,10 @@ def create_project(project_name):
     html_file_path = os.path.join(src_dir, DEFAULTS.HTML_FILE_PATH)
 
     config_file_path = os.path.join(project_dir, DEFAULTS.CONFIG_FILE_PATH)
+    config_settings = {
+        "src_dir": DEFAULTS.SRC_DIR,
+        "dest_dir": DEFAULTS.DEST_DIR
+    }
 
     # Create project directory
     create_dir(project_dir)
@@ -123,6 +86,10 @@ def create_project(project_name):
 
     # Create template config.json in project dir
     create_file(config_file_path)
+    write_to_json_file(
+        config_file_path,
+        content=config_settings
+    )
 
     # Create react app
     npm = NodeWrapper(project_name, working_dir=project_dir)