Merge pull request #40 from SpontanCombust:dev

v0.3.0

.gitattributes

@@ -1 +1 @@
-test_assets/** linguist-generated
+**/assets/tests/** linguist-generated

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] {title}"
+labels: bug
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+ - OS: [Windows, Linux]
+ - Editor [e.g. Visual Studio Code 1.89]
+ - Version [e.g. v0.3.0]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] {title}"
+labels: feature
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/draft-release.yml

@@ -6,6 +6,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
+  IS_PRE_RELEASE: contains(${{ github.ref_name }}, 'dev')
 
 jobs:
   build:
@@ -35,11 +36,17 @@ jobs:
 
     - name: Build xtask
       run: cargo build --package xtask --release
-    - name: Prepare and pack the client
-      run: |
-        cargo xtask prep-server --target ${{ matrix.target }} --release
-        cargo xtask package -o "witcherscript-ide-${{ github.ref_name }}-${{ matrix.target }}.vsix" --target ${{ matrix.code_target }}
 
+    - name: Prepare the server executable
+      run: cargo xtask prep-server --target ${{ matrix.target }} --release
+
+    - name: Package the extension (pre-release)
+      if: ${{ env.IS_PRE_RELEASE }}
+      run: cargo xtask package --pre-release -o "witcherscript-ide-${{ github.ref_name }}-${{ matrix.target }}.vsix" --target ${{ matrix.code_target }}
+    - name: Package the extension (main release)
+      if: ${{ !env.IS_PRE_RELEASE }}
+      run: cargo xtask package -o "witcherscript-ide-${{ github.ref_name }}-${{ matrix.target }}.vsix" --target ${{ matrix.code_target }}
+
     - name: Upload artifacts
       uses: actions/upload-artifact@v2
       with:
@@ -51,7 +58,7 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     needs: build
-    if: success()
+    if: success()     
 
     steps:
     - name: Download artifacts
@@ -66,13 +73,28 @@ jobs:
         draft: true
         allowUpdates: true
         generateReleaseNotes: true
+        prerelease: ${{ env.IS_PRE_RELEASE }}
 
-    - name: Upload extension to VSCode Marketplace
+    # The VS Marketplace doesn't yet support pre-release semver versions, sigh....
+    # https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions
+    # - name: Upload extension to VSCode Marketplace (pre-release)
+    #   if: ${{ env.IS_PRE_RELEASE }}
+    #   run: npx vsce publish --pre-release --packagePath $(find . -iname *.vsix)
+    #   env:
+    #     VSCE_PAT: ${{ secrets.VSCE_PAT }}
+    - name: Upload extension to VSCode Marketplace (main release)
+      if: ${{ !env.IS_PRE_RELEASE }}
       run: npx vsce publish --packagePath $(find . -iname *.vsix)
       env:
         VSCE_PAT: ${{ secrets.VSCE_PAT }}
 
-    - name: Upload extension to Open VSX Registry
+    # - name: Upload extension to Open VSX Registry (pre-release)
+    #   if: ${{ env.IS_PRE_RELEASE }}
+    #   run: npx ovsx publish --pre-release --packagePath $(find . -iname *.vsix)
+    #   env:
+    #     OVSX_PAT: ${{ secrets.OVSX_PAT }}
+    - name: Upload extension to Open VSX Registry (main release)
+      if: ${{ !env.IS_PRE_RELEASE }}
       run: npx ovsx publish --packagePath $(find . -iname *.vsix)
       env:
         OVSX_PAT: ${{ secrets.OVSX_PAT }}

Cargo.toml

@@ -3,7 +3,7 @@ members = ["crates/*", "xtask"]
 resolver = "2"
 
 [workspace.package]
-version = "0.2.1"
+version = "0.3.0-dev.3"
 edition = "2021"
 authors = ["SpontanCombust"]
 
@@ -26,4 +26,5 @@ semver = { version = "1.0", features = ["serde"] }
 dyn-clone = "1.0"
 rayon = "1.9"
 bitmask-enum = "2.2.3"
-filetime = "0.2.23"
+filetime = "0.2.23"
+smallvec = "1.13"

README.md

@@ -1,16 +1,21 @@
-# WitcherScript IDE
+<p align="center">
+    <img src="media/wide-banner.png" alt="Banner" style="box-shadow: 4px 4px 3px gray;">
+</p>
 
 ![GitHub Release](https://img.shields.io/github/v/release/SpontanCombust/witcherscript-ide)
 ![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/SpontanCombust.witcherscript-ide)
 
-WitcherScript IDE is an unofficial Witcher 3 modding tool aimed at improving developer experience by supplying them with powerful code analysis tools in the form of an editor extension making use of a Language Server.  
+***WIDE*** (**W**itcherScript **I**ntegrated **D**evelopment **E**nvironment) is unofficial Witcher 3 modding tooling aimed at improving developer experience by supplying them with powerful code analysis tools in the form of an editor extension making use of a Language Server.
+
+The goal is to have a full set of features that will make [ScriptStudio](https://witcher-games.fandom.com/wiki/Script_Studio) obsolete and reduce the overhead of fixing compilation errors detected when launching the game.
+
 Currently the only supported client is Visual Studio Code.
 
-Website: <https://spontancombust.github.io/witcherscript-ide>
+<https://spontancombust.github.io/witcherscript-ide>
 
 
 ## For users
-The IDE is distributed in form of code editor extension. Currently only the VSCode extension is available.
+WIDE is distributed in form of code editor extension. Currently only the VSCode extension is available.
 Releases can be found in [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SpontanCombust.witcherscript-ide), [Open VSX Registry](https://open-vsx.org/extension/SpontanCombust/witcherscript-ide) or can be directly downloaded from the [releases](https://github.com/SpontanCombust/witcherscript-ide/releases) page.
 
 Check out the [user manual](https://spontancombust.github.io/witcherscript-ide/user-manual) for more information.

RELEASE_TODO.md

@@ -1,23 +1,25 @@
 # Release TODOs
 
-Just a list of all the tasks that are to be done before the release, so I don't forget about any of them :sweat_smile:
+List of all the tasks that are to be done during a release.
 
-1. Check TODOs
+1. Check TODOs in the code
 2. Update extension README
-3. Update documentation
+3. Update site documentation
 4. Update changelog
+5. (If main release) Replace pre-release changelogs with a single main release changelog 
 
-5. Verify Linux version
-6. Verify README in extensions tab
+6. Verify Linux version
+7. Verify README in extensions tab
 
-7. Merge to master
+8. (If main release) Merge to master
 
-8. Verify the website
-9. Verify documentation/site links
+9. Verify deployed documentation website
+10. Verify documentation/site links
 
-10. Bump version in `Cargo.toml`
-11. Bump version in client `package.json`
-12. Create a version tag and the release 
+11. Bump version in `Cargo.toml`
+12. Bump version in client `package.json`
+13. Create a version tag and the release 
 
-13. Verify Marketplace
-14. Move tasks on the board to `Shipped`
+14. (If main release) Verify VS Marketplace and Open VSX Registry
+15. (If main release) Move tasks on the board to `Shipped`
+16. (If main release) Close tasks and milestone

crates/analysis/Cargo.toml

@@ -8,7 +8,12 @@ authors.workspace = true
 [dependencies]
 abs-path = { path = "../abs-path" }
 witcherscript = { path = "../core" }
-uuid.workspace = true
+witcherscript-project = { path = "../project" }
+witcherscript-diagnostics = { path = "../diagnostics" }
 thiserror.workspace = true
 lsp-types.workspace = true
-shrinkwraprs.workspace = true
+shrinkwraprs.workspace = true
+strum.workspace = true
+strum_macros.workspace = true
+smallvec.workspace = true
+rayon.workspace = true