fix: Gitpod & Pre-Commit Hooks (#37)

* feat: Commitizen and pre-commit

* feat: Added CZ and Pre Commit config files

* test(gp): Added new Dockerfile and added the noVNC tools

Test needed.

* refactor(gp): Change Dockerfile path

I'm testing this.

BREAKING CHANGE:

* chore: Update Gitpod Config

So that I can start a proper env

* perf(gp): Use nvm-14 for docs

added nvm code.

This does work

* refactor(gp): Change pip from init to command

That's a problem since I discovered, init changes for pip persist ONLY in $HOME, not /workspace.

* refactor(gp): Removing the .gitpod folder

That's where we'll be hosting our scripts soon.

* feat(precommits): isort to sort pur imports

styling

* feat: @axonasif's customised image for us!

Thanks @axonasif!

* style: Clean up

Also removed some private PATHs, changed some `init:`s in the Gitpod Config.

Ready for merge _completely_!

* style: Final Commit

* refactor: Final

PLEASEEEEE!

Author: im-coder-lg

.gitpod.yml

@@ -1,5 +1,6 @@
-image: 
-  file: .gitpod.Dockerfile
+# image: 
+#   file: .gitpod.Dockerfile
+image: axonasif/gitpod-workspace-images:tkinter_vnc_full
 
 tasks:
   - name: TimerX
@@ -8,9 +9,13 @@ tasks:
 # PS: App doesn't work here since "_tkinter" is unavailable
 
   - name: Website
-    before: cd docs
+    before: cd docs && nvm install 14
     init: yarn install
     command: yarn start
+  
+  - name: Initialize `cz` and `pre-commit`
+    init: cd /workspace/TimerX
+    command: pip install -r requirements-dev.txt && pre-commit install && pre-commit run
 
 ports:
   - port: 3000

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+known_third_party = cx_Freeze,darkdetect,playsound

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+- hooks:
+  - id: commitizen
+    stages:
+    - commit-msg
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v2.20.3
+ 
+- repo: https://github.com/ambv/black
+  rev: 21.12b0
+  hooks:
+  - id: black
+    language_version: python3.8
+- repo: https://github.com/asottile/seed-isort-config
+  rev: v2.2.0
+  hooks:
+  -   id: seed-isort-config
+- repo: https://github.com/pre-commit/mirrors-isort
+  rev: v5.4.2
+  hooks:
+  -   id: isort
+  

pyproject.toml

@@ -0,0 +1,5 @@
+[tool]
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "0.9"
+tag_format = "v$version"

pyvenv.cfg

@@ -1,3 +1,4 @@
-home = C:\Users\suchi\AppData\Local\Programs\Python\Python310
+# We recommend users to create a custom environment variable for Python's path and version
+home = %PYTHON_PATH%
 include-system-site-packages = false
-version = 3.10.0
+version = %PYTHON_VERSION%

requirements-dev.txt

@@ -0,0 +1,2 @@
+commitizen
+pre-commit