install from cargo

Author: CppCXY

.github/workflows/build.yml

@@ -34,6 +34,11 @@ jobs:
           submodules: recursive
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
+      - name: edit version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          echo "current ref ${{ github.ref }}"
+          cargo run -p edit_version -- ${{ github.ref }}
       - name: Build - General
         if: ${{ matrix.cross == 'general' }}
         run: |

.github/workflows/upload_crates.yml

@@ -0,0 +1,31 @@
+name: Upload Crates
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Set version
+        run: |
+          echo "current ref ${{ github.ref }}""
+          cargo run -p edit_version -- ${{ github.ref }}
+      - name: Publish
+        run: |
+          cd crates/emmylua_code_analysis
+          cargo publish
+          cd ../emmylua_ls
+          cargo publish
+          cd ../emmylua_doc_cli
+          cargo publish
+        env:
+          CARGO_TOKEN: ${{ secrets.CARGO_TOKEN }}

CHANGELOG.md

@@ -1,6 +1,14 @@
 # CHANGELOG
 
-# 0.4.1 (unreleased)
+# 0.4.2(unreleased)
+
+# 0.4.1 
+
+`NEW` all the crates release to crates.io. now you can get `emmylua_parser`, `emmylua_code_analysis`, `emmylua_ls`, `emmylua_doc_cli` from crates.io.
+```shell
+cargo install emmylua_ls
+cargo install emmylua_doc_cli
+```
 
 # 0.4.0 
 

README.md

@@ -21,6 +21,32 @@ We welcome your feedback and contributions. Please feel free to submit pull requ
 - [Emmyrc Config](./docs/config/emmyrc_json_EN.md)
 - [Formatting Config](https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/README_EN.md)
 
+## Install
+
+if you want to install emmylua_ls and emmylua_doc_cli, you can use the following command:
+```shell
+# install emmylua_ls 
+cargo install emmylua_ls
+# install emmylua_doc_cli
+cargo install emmylua_doc_cli
+```
+
+if you are using vscode, you can install the vscode extension [EmmyLua](https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua) to get a better experience.
+
+## Usage
+
+### emmylua_ls
+
+If you have installed emmylua_ls using cargo install, you can simply run emmylua_ls to start the language server without any additional parameters.
+
+### emmylua_doc_cli
+
+If you have installed emmylua_doc_cli using cargo install, you can simply run emmylua_doc_cli to generate documentation. You can use the --input parameter to specify the directory of Lua files and the --output parameter to specify the output directory for the generated documentation.
+
+```shell
+emmylua_doc_cli --input ./tests/lua --output ./tests/doc
+```
+
 ## Build
 
 ```shell
@@ -29,7 +55,7 @@ cargo build --release -p emmylua_ls
 
 ## Develop
 
-The language service supports both stdio and TCP communication, with stdio communication as the default. It has several startup parameters:
+The language server supports both stdio and TCP communication, with stdio communication as the default. It has several startup parameters:
 - `-c` specifies the communication method. Acceptable values are `stdio` and `tcp`, with the default being `stdio`.
 - `--port` When the `-c` parameter is set to `tcp`, the `--port` parameter can specify the port number, with the default value of `5007`.
 - `--log-level` specifies the log level. Acceptable values are `debug`, `info`, `warn`, `error`, with the default being `info`.