diff --git a/.github/workflows/commit_norm_check.yml b/.github/workflows/commit_norm_check.yml index 7ef2834..cbbba3a 100644 --- a/.github/workflows/commit_norm_check.yml +++ b/.github/workflows/commit_norm_check.yml @@ -1,12 +1,12 @@ -name: Commit Name Checker +name: Commit Norm Checker on: - push: - branches: - - '*' - pull_request: - branches: - - '*' + push: + branches: + - '*' + pull_request: + branches: + - '*' jobs: verify-commit-name: @@ -14,19 +14,19 @@ jobs: steps: - name: Set up Git repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - - name: Commit Name Checker + - name: Commit Norm Checker run: | - commit_msg=$(git log --format=%B -n 1 ${{ github.sha }}) - keyword_regex="^\[[A-Z][@_A-Za-z, ]+\] : " + commit_msg=$(git log --format=%B -n 1 ${{ github.sha }}) + keyword_regex="^([a-z]+\([0-9A-Za-z_.-]+\)|^[a-z]+): " - if [[ ! $commit_msg =~ $keyword_regex ]]; then - if [[ $commit_msg =~ ^Merge\ .* ]]; then - echo "Skipping merge commit" - else - echo $commit_msg - echo "Commit message does not match expected format. Please use the following format:\"[Keyword] : comment\"" - exit 1 - fi + if [[ ! $commit_msg =~ $keyword_regex ]]; then + if [[ $commit_msg =~ ^Merge\ .* ]]; then + echo "Skipping merge commit" + else + echo $commit_msg + echo "Commit message does not match expected format. Please use the following format: \"keyword(scope): comment\"" + exit 1 fi + fi diff --git a/README.md b/README.md index 1a27c75..ba7162a 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,34 @@ Laplace Syntax Language extension for VSCode - [Contacts](#contacts) +## **Dependencies** + +- [npm](https://www.npmjs.com/) +- [Visual Studio Code](https://code.visualstudio.com/) + +```bash +sudo apt-get install npm -y nodejs +nvm install node +npm install -g @vscode/vsce +``` + +## **Installation** + +```bash +git clone https://github.com/MasterLaplace/LaplaceSyntax-Code.git +cd LaplaceSyntax-Code +vsce package +code --install-extension laplace-syntax-0.0.1.vsix +``` + +## **Update** + +```bash +git pull +vsce package +code --install-extension laplace-syntax-0.0.1.vsix +``` +
## :pencil: **Release Notes**