diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 7f89891..ffd15fd 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,9 +1,9 @@ name: build-artifact on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: jobs: diff --git a/README.md b/README.md index b517410..14f380b 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@ +[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/ahmadalli.vscode-nginx-conf)](https://marketplace.visualstudio.com/items?itemName=ahmadalli.vscode-nginx-conf) + # Nginx config file hint(auto-completion) for VS Code -[![.github/workflows/ci.yaml](https://github.com/hangxingliu/vscode-nginx-conf-hint/actions/workflows/ci.yaml/badge.svg)](https://github.com/hangxingliu/vscode-nginx-conf-hint/actions/workflows/ci.yaml) +[![.github/workflows/ci.yaml](https://github.com/ahmadalli/vscode-nginx-conf-hint/actions/workflows/ci.yaml/badge.svg)](https://github.com/ahmadalli/vscode-nginx-conf-hint/actions/workflows/ci.yaml) A Visual Studio Code extension that helps you write Nginx configuration files. Many features in it include syntax highlight, auto-complete, in-editor documents, embedded Lua block, and more. +# Why Fork? + +The [upstream repo][upstream-repo] seems to be left unmaintained and there was compatibility issue with `raynigon.nginx-formatter` extension because the upstream projects used `NGINX` as language id while the formatter extension uses `nginx` and therefore it's not possible to use both extensions on the same file + ## Installation 1. Click `Extension` button in left side of VSCode. (Shortcut: Ctrl+Shift+X or Command+Shift+X) -2. Search for `hangxingliu.vscode-nginx-conf-hint` and click the `Install` button. +1. Search for `ahmadalli.vscode-nginx-conf` and click the `Install` button. +1. Reload VSCode. ## Screenshots -![screenshots](https://raw.githubusercontent.com/hangxingliu/vscode-nginx-conf-hint/master/images/screenshots.gif) +![screenshots](https://raw.githubusercontent.com/ahmadalli/vscode-nginx-conf/main/images/screenshots.gif) ## Features @@ -66,18 +73,20 @@ Many features in it include syntax highlight, auto-complete, in-editor documents ## Author -[LiuYue(hangxingliu)](https://github.com/hangxingliu) +[LiuYue(hangxingliu)](https://github.com/hangxingliu): Author of the [Original Project][upstream-repo] + +[ahmadali shafiee](https://github.com/ahmadalli) ## Contributor -- [@tiansin](https://github.com/tiansin) -- [@latipun7](https://github.com/latipun7) +- [@tiansin](https://github.com/tiansin): Contributor of the [Original Project][upstream-repo] +- [@latipun7](https://github.com/latipun7): Contributor of the [Original Project][upstream-repo] [nginx-doc]: https://nginx.org/en/docs/ -[doc-script]: https://github.com/hangxingliu/vscode-nginx-conf-hint/blob/master/utils/download_hint_data.js -[icon-nginx]: https://github.com/shanoor/vscode-nginx/blob/master/nginx_logo.png -[issues]: https://github.com/hangxingliu/vscode-nginx-conf-hint/issues -[pr]: https://github.com/hangxingliu/vscode-nginx-conf-hint/pulls -[changelog]: https://github.com/hangxingliu/vscode-nginx-conf-hint/blob/master/docs/CHANGELOG.md -[paypal]: https://www.paypal.me/hangxingliu +[doc-script]: https://github.com/ahmadalli/vscode-nginx-conf-hint/blob/main/utils/download_hint_data.js +[icon-nginx]: https://github.com/shanoor/vscode-nginx/blob/main/nginx_logo.png +[issues]: https://github.com/ahmadalli/vscode-nginx-conf/issues +[pr]: https://github.com/ahmadalli/vscode-nginx-conf/pulls +[changelog]: https://github.com/ahmadalli/vscode-nginx-conf/blob/main/docs/CHANGELOG.md +[upstream-repo]: https://github.com/hangxingliu/vscode-nginx-conf-hint diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e79103d..7543390 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,5 +11,5 @@ Remember `npm install` if you want to rebuilding hint data or developing extensi @todo -[issues]: https://github.com/hangxingliu/vscode-nginx-conf-hint/issues -[pr]: https://github.com/hangxingliu/vscode-nginx-conf-hint/pulls +[issues]: https://github.com/ahmadalli/vscode-nginx-conf-hint/issues +[pr]: https://github.com/ahmadalli/vscode-nginx-conf-hint/pulls diff --git a/images/icon.png b/images/icon.png index ccf7f53..a679988 100644 Binary files a/images/icon.png and b/images/icon.png differ diff --git a/package.json b/package.json index 4225db8..5bbdd6f 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "vscode-nginx-conf-hint", - "displayName": "nginx.conf hint", + "name": "vscode-nginx-conf", + "displayName": "NGINX Configuration Language Support", "description": "Nginx configuration helper for Visual Studio Code with many features including syntax highlight, auto-complete, in-editor documents, embedded Lua block, and more", - "version": "0.3.0", + "version": "0.3.1", "license": "GPL-3.0", "icon": "images/icon.png", "galleryBanner": { @@ -20,8 +20,8 @@ "Configuration", "Auto-completion" ], - "publisher": "hangxingliu", - "author": "hangxingliu", + "publisher": "ahmadalli", + "author": "ahmadalli", "main": "./src/extension/main.desktop.js", "browser": "./artifacts/web-ext/extension.js", "scripts": { @@ -65,29 +65,35 @@ "vscode": "^1.1.0" }, "activationEvents": [ - "onLanguage:NGINX", + "onLanguage:nginx", "onLanguage:lua" ], "contributes": { "languages": [ { - "id": "NGINX", + "id": "nginx", "aliases": [ - "NGINX" + "NGINX Conf", + "NGINX", + "nginx" ], "extensions": [ ".conf", + ".conf.default", + ".conf.template", "mime.types", "fastcgi_params", "scgi_params", - "uwsgi_params" + "uwsgi_params", + "nginx.conf", + ".nginx" ], "configuration": "./nginx.configuration.json" } ], "snippets": [ { - "language": "NGINX", + "language": "nginx", "path": "./assets/snippets/nginx.json" }, { @@ -97,7 +103,7 @@ ], "grammars": [ { - "language": "NGINX", + "language": "nginx", "scopeName": "source.nginx", "path": "./src/syntax/nginx.tmLanguage", "embeddedLanguages": { @@ -147,7 +153,7 @@ "menus": { "editor/context": [ { - "when": "!inOutput && resourceLangId == 'NGINX'", + "when": "!inOutput && resourceLangId == 'nginx'", "command": "nginx-conf-hint.showDocument", "group": "navigation" } @@ -156,10 +162,10 @@ }, "repository": { "type": "git", - "url": "https://github.com/hangxingliu/vscode-nginx-conf-hint" + "url": "https://github.com/ahmadalli/vscode-nginx-conf" }, "bugs": { - "url": "https://github.com/hangxingliu/vscode-nginx-conf-hint/issues" + "url": "https://github.com/ahmadalli/vscode-nginx-conf/issues" }, - "homepage": "https://github.com/hangxingliu/vscode-nginx-conf-hint" + "homepage": "https://github.com/ahmadalli/vscode-nginx-conf" } diff --git a/src/extension/providers/utils.ts b/src/extension/providers/utils.ts index aebf776..a24b2a6 100644 --- a/src/extension/providers/utils.ts +++ b/src/extension/providers/utils.ts @@ -1,2 +1,2 @@ -export const NGINX_LANGUAGE_ID = 'NGINX'; +export const NGINX_LANGUAGE_ID = 'nginx'; export const DOCUMENT_SELECTOR = [NGINX_LANGUAGE_ID]; diff --git a/yarn.lock b/yarn.lock index 1ad1a2d..bbbf0ea 100644 --- a/yarn.lock +++ b/yarn.lock @@ -926,9 +926,9 @@ flatted@^3.1.0: integrity sha512-JaTY/wtrcSyvXJl4IMFHPKyFur1sE9AUqc0QnhOaJ0CxHtAoIV8pYDzeEfAaNEtGkOfq4gr3LBFmdXW5mOQFnA== follow-redirects@^1.14.4: - version "1.14.7" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.7.tgz#2004c02eb9436eee9a21446a6477debf17e81685" - integrity sha512-+hbxoLbFMbRKDwohX8GkTataGqO6Jb7jGwpAlwgy2bIz25XtRm7KEzJM76R1WiNT5SwZkX4Y75SwBolkpmE7iQ== + version "1.15.2" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.2.tgz#b460864144ba63f2681096f274c4e57026da2c13" + integrity sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA== fs.realpath@^1.0.0: version "1.0.0"