feat: simplify pre-commit hook (#559)

* update: adds .vscode/settings.json to gitignore

* update: simplifies black config

- uses extend-exclude to use pre-configured black exclusions

* feat: sets up pre-commit

- Does not run pylint/pyright since they can't be used in pre-commit directly
- TODO: migrate branch restrictions if required

* feat: move branch checks to pre-commit

* update: adds hook to prevent commits to master

* update: use pre-commit to set up hooks

* refactor: moves configs to pyproject.toml

- Removes random `lib64` symlink
- Updates makefile with new commands

* lint: ruff + import sorting

* feat: update ruff configs

* lint: more ruff

* lint: pyright

* refactor: consolidates workflows

* refactor: use matrix for running lint workflow

* update: split check into a different step for clarity

* fix: adds venv activation to steps

* update: reduce workflow runs for lint jobs

- Remove trigger for PR edits

* update: ignore .ruff_cache

* fix: broken test due to line change

* update: move pyright to run on explicit request

- Avoids issues with IDE integration
  - Already checked in workflows
- Keeps hooks fast

* update: handle PR branch checks

* fix: target branch checks

* lint: formatting

Author: namsnath

Diff for: .circleci/authReactDjango.sh

@@ -105,4 +105,4 @@ else
         echo "test failed for auth-react tests... exiting!"
         exit 1
     fi
-fi
+fi

Diff for: .circleci/authReactFastApi.sh

@@ -100,4 +100,4 @@ else
         echo "test failed for auth-react tests... exiting!"
         exit 1
     fi
-fi
+fi

Diff for: .circleci/authReactFlask.sh

@@ -102,4 +102,4 @@ else
         echo "test failed for auth-react tests... exiting!"
         exit 1
     fi
-fi
+fi

Diff for: .circleci/config.yml

@@ -61,4 +61,4 @@ workflows:
                 filters:
                     branches:
                         only:
-                            - master
+                            - master

Diff for: .circleci/installJava.sh

@@ -2,7 +2,7 @@
 
 wget https://download.java.net/java/GA/jdk15.0.1/51f4f36ad4ef43e39d0dfdbaf6549e32/9/GPL/openjdk-15.0.1_linux-x64_bin.tar.gz
 mkdir /usr/java
-mv openjdk-15.0.1_linux-x64_bin.tar.gz /usr/java  
+mv openjdk-15.0.1_linux-x64_bin.tar.gz /usr/java
 cd /usr/java
 tar -xzvf openjdk-15.0.1_linux-x64_bin.tar.gz
 rm openjdk-15.0.1_linux-x64_bin.tar.gz

Diff for: .circleci/markAsSuccess.sh

@@ -36,4 +36,4 @@ if [ $responseStatus -ne "200" ]
 then
     echo "patch api failed"
     exit 1
-fi
+fi

Diff for: .circleci/markDevTagAsTestNotPassed.sh

@@ -37,4 +37,4 @@ then
     echo "failed core PUT API status code: $responseStatus. Exiting!"
     cat out.bin
 	exit 1
-fi
+fi

Diff for: .circleci/setupAndTestBackendSDKWithFreeCore.sh

@@ -83,4 +83,3 @@ fi
 
 # kill test-server
 kill $(lsof -t -i:$API_PORT)
-

Diff for: .circleci/setupAndTestWithAuthReact.sh

@@ -58,16 +58,16 @@ git checkout $2
 npm run init > /dev/null
 (cd ./examples/for-tests && npm run link) # this is there because in linux machine, postinstall in npm doesn't work..
 cd ./test/server/
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
-npm i  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
+npm i
 cd ../../../project/tests/auth-react/fastapi-server
 export PYTHONPATH="${PYTHONPATH}:/root/project"
 uvicorn app:app --host 0.0.0.0 --port 8083 &
 pid=$!
 cd ../../../../supertokens-auth-react/
 
-# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH 
-# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably. 
+# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH
+# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably.
 # In versions lower than 0.18 Github is used as the provider.
 
 # SKIP_OAUTH=true npm run test-with-non-node
@@ -143,4 +143,4 @@ fi
 echo "all tests passed, killing processes: $pid"
 kill -9 $pid
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithAuthReactWithDjango.sh

@@ -60,16 +60,16 @@ git checkout $2
 npm run init > /dev/null
 (cd ./examples/for-tests && npm run link) # this is there because in linux machine, postinstall in npm doesn't work..
 cd ./test/server/
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../../project/tests/auth-react/django3x
 export PYTHONPATH="${PYTHONPATH}:/root/project"
 uvicorn mysite.asgi:application --port 8083 &
 pid=$!
 cd ../../../../supertokens-auth-react/
 
-# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH 
-# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably. 
+# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH
+# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably.
 # In versions lower than 0.18 Github is used as the provider.
 
 # SKIP_OAUTH=true npm run test-with-non-node

Diff for: .circleci/setupAndTestWithAuthReactWithFlask.sh

@@ -60,16 +60,16 @@ git checkout $2
 npm run init > /dev/null
 (cd ./examples/for-tests && npm run link) # this is there because in linux machine, postinstall in npm doesn't work..
 cd ./test/server/
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../../project/tests/auth-react/flask-server
 export PYTHONPATH="${PYTHONPATH}:/root/project"
 python3 app.py --port 8083 &
 pid=$!
 cd ../../../../supertokens-auth-react/
 
-# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH 
-# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably. 
+# When testing with supertokens-auth-react for version >= 0.18 the SKIP_OAUTH
+# flag will not be checked because Auth0 is used as a provider so that the Thirdparty tests can run reliably.
 # In versions lower than 0.18 Github is used as the provider.
 
 # SKIP_OAUTH=true npm run test-with-non-node
@@ -145,4 +145,4 @@ fi
 echo "all tests passed, killing processes: $pid"
 kill -9 $pid
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithFrontend.sh

@@ -62,10 +62,10 @@ pid=$!
 uvicorn app:app --host 0.0.0.0 --port 8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
-npm i 
+npm i
 
 if ! [[ -z "${CIRCLE_NODE_TOTAL}" ]]; then
     TEST_MODE=testing SUPERTOKENS_CORE_TAG=$coreTag NODE_PORT=8081 INSTALL_PATH=../supertokens-root npx mocha --exit --no-config --require isomorphic-fetch --timeout 500000 $(npx mocha-split-tests -r ./runtime.log -t $CIRCLE_NODE_TOTAL -g $CIRCLE_NODE_INDEX -f 'test/*.test.js')
@@ -86,4 +86,4 @@ echo "all tests passed, killing processes: $pid and $pid2"
 kill -9 $pid
 kill -9 $pid2
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithFrontendWithDjango.sh

@@ -62,7 +62,7 @@ pid=$!
 uvicorn mysite.asgi:application --port 8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
 npm i
@@ -86,4 +86,4 @@ echo "all tests passed, killing processes: $pid and $pid2"
 kill -9 $pid
 kill -9 $pid2
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithFrontendWithDjango2x.sh

@@ -62,7 +62,7 @@ pid=$!
 gunicorn mysite.wsgi --bind 0.0.0.0:8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
 npm i

Diff for: .circleci/setupAndTestWithFrontendWithDrfAsync.sh

@@ -62,7 +62,7 @@ pid=$!
 uvicorn mysite.asgi:application --port 8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
 npm i
@@ -86,4 +86,4 @@ echo "all tests passed, killing processes: $pid and $pid2"
 kill -9 $pid
 kill -9 $pid2
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithFrontendWithDrfSync.sh

@@ -62,7 +62,7 @@ pid=$!
 gunicorn mysite.wsgi --bind 0.0.0.0:8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
 npm i
@@ -86,4 +86,4 @@ echo "all tests passed, killing processes: $pid and $pid2"
 kill -9 $pid
 kill -9 $pid2
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/setupAndTestWithFrontendWithFlask.sh

@@ -62,7 +62,7 @@ pid=$!
 python3 app.py --port 8082 &
 pid2=$!
 cd ../../../../supertokens-website/test/server
-npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3
 npm i
 cd ../../
 npm i
@@ -86,4 +86,4 @@ echo "all tests passed, killing processes: $pid and $pid2"
 kill -9 $pid
 kill -9 $pid2
 rm -rf ./test/server/node_modules/supertokens-node
-git checkout HEAD -- ./test/server/package.json
+git checkout HEAD -- ./test/server/package.json

Diff for: .circleci/updateDocsInWebsite.sh

@@ -25,4 +25,4 @@ cp -r ../html/supertokens_python/* ../../supertokens-backend-website/app/docs/sd
 # push to git
 git config --global user.email "$EMAIL"
 git config --global user.name "$NAME"
-(cd ../../supertokens-backend-website && git add --all && git commit -m"updates python docs" && git pull && git push && ./releaseDev.sh)
+(cd ../../supertokens-backend-website && git add --all && git commit -m"updates python docs" && git pull && git push && ./releaseDev.sh)

Diff for: .cursorrules

@@ -1,10 +1,10 @@
 You are an expert Python and Typescript developer. Your job is to convert node code (in typescript) into Python code. The python code then goes into this SDK. The python code style should keep in mind:
 - Avoid using TypeDict
-- Avoid using generic Dict as much as possible, except when defining the types for `user_context`. 
+- Avoid using generic Dict as much as possible, except when defining the types for `user_context`.
 - If a function has multiple `status` strings as outputs, then define one unique class per unique `status` string. The class name should be such that it indicates the status it is associated with.
 - Variable and function names should be in snake_case. Class names in PascalCase.
 - Whenever importing `Literal`, import it from `typing_extensions`, and not `types`.
 - Do not use `|` for OR type, instead use `Union`
 - When defining API interface functions, make sure the output classes inherit from `APIResponse` class, and that they have a `to_json` function defined whose output matches the structure of the provided Typescript code output objects.
 
-The semantic of the python code should be the same as what's of the provided Typescript code.
+The semantic of the python code should be the same as what's of the provided Typescript code.

Diff for: .github/helpers/.gitignore

@@ -1,2 +1,2 @@
 node_modules
-package-lock.json
+package-lock.json

Diff for: .github/helpers/package.json

@@ -13,4 +13,4 @@
         "axios": "^0.26.1",
         "github-workflow-helpers": "github:supertokens/github-workflow-helpers"
     }
-}
+}

Diff for: .github/workflows/github-actions-changelog.yml

@@ -0,0 +1,31 @@
+name: "Lint PR"
+
+on:
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - edited
+            - synchronize
+
+jobs:
+    lint-pr-title:
+        name: Lint PR Title
+        runs-on: ubuntu-latest
+        steps:
+            - uses: amannn/action-semantic-pull-request@v3
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  validateSingleCommit: true
+
+    # Enforces the update of a changelog file on every pull request
+    lint-changelog:
+        name: Enforce Changelogs
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: dangoslen/changelog-enforcer@v2
+              with:
+                  changeLogPath: "CHANGELOG.md"
+                  skipLabels: "Skip-Changelog"