Update main with v2.7.0

.github/workflows/main.yml

@@ -140,6 +140,8 @@ jobs:
             client/package-lock.json
       - run: npm install
       - run: npm run fetch:docs
+      - run: npm run fetch:wasm
+      - run: npm run fetch:spdx-licenses
       - run: cd server && npm pack
       - name: Archive server package
         uses: actions/upload-artifact@v4
@@ -156,6 +158,9 @@ jobs:
     steps:
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
       - uses: actions/download-artifact@v4
       - name: Publish to npm
         run: npm publish $(find . -iname language-server-bitbake-*.tgz)

.github/workflows/update-ref.yml

@@ -1,7 +1,7 @@
 name: Update references for commits, tags, etc
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: 
   schedule:
     - cron: '0 0 1 * *' # Run on the first day of every month
 
@@ -20,29 +20,31 @@ jobs:
       BASE_BRANCH: staging
       FILE_PATHS: |
         integration-tests/src/utils/version.ts
+        scripts/fetch-poky.sh
         scripts/fetch-docs.sh
+        integration-tests/src/runTest.ts
+        scripts/fetch-spdx-licenses.sh
       node-version: 20
 
     steps:
     - name: Checkout Repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ env.BASE_BRANCH }}
 
     - name: Update required extension version
       run: bash scripts/update-ref.sh
 
     - name: Verify file changes
-      uses: tj-actions/verify-changed-files@v17
+      uses: tj-actions/verify-changed-files@v20
       id: verify-changed-files
       with:
         files: ${{ env.FILE_PATHS }}
 
     - name: Create pull request
       if: steps.verify-changed-files.outputs.files_changed == 'true'
-      uses: peter-evans/create-pull-request@v5
+      uses: peter-evans/create-pull-request@v6
       with:
-        add-paths: ${{ env.FILE_PATHS }}
         title: Auto update references for commits, tags, etc
         commit-message: Auto update references for commits, tags, etc
         branch: update-ref

.github/workflows/update-tree-sitter-wasm-file.yml → .github/workflows/update-tree-sitter-parser-info-file.yml

@@ -1,15 +1,15 @@
 # Inspired by bash-language-server under MIT license
 # Reference: https://github.com/bash-lsp/bash-language-server/blob/8c42218c77a9451b308839f9a754abde901323d5/.github/workflows/upgrade-tree-sitter.yml
 
-name: Update Tree Sitter WASM File
+name: Update Tree Sitter Parser Info File
 
 on:
   workflow_dispatch:
   schedule:
     - cron: '0 12 * * 2'
 
 jobs:
-  update-tree-sitter-wasm:
+  update-tree-sitter-parser-info-file:
 
     runs-on: ubuntu-latest
 
@@ -45,15 +45,13 @@ jobs:
     - name: Install Dependencies
       run: npm install
 
-    - name: Update tree-sitter wasm
-      run: bash scripts/update-${{ matrix.tree-sitter-name }}-wasm.sh
+    - name: Update tree-sitter parser info file
+      run: bash scripts/update-${{ matrix.tree-sitter-name }}.sh
 
     - name: Verify file changes
       uses: tj-actions/verify-changed-files@v20
       id: verify-changed-files
       with:
-        # The script generates a new wasm file and replaces the existing one. Git will treat it as a different file even it is generated with the same commit and CLI
-        # Hence, we only compare the .info file. It should be enough to tell the difference
         files: |
             server/${{ matrix.tree-sitter-name }}.info
 
@@ -63,9 +61,8 @@ jobs:
       with:
         add-paths: |
           server/${{ matrix.tree-sitter-name }}.info
-          server/${{ matrix.tree-sitter-name }}.wasm
-        title: Auto update ${{ matrix.tree-sitter-name }} wasm file
-        commit-message: Auto update ${{ matrix.tree-sitter-name }} wasm file and parser info
-        branch: update-${{ matrix.tree-sitter-name }}-wasm-file
+        title: Auto update ${{ matrix.tree-sitter-name }} parser info file
+        commit-message: Auto update ${{ matrix.tree-sitter-name }} parser info
+        branch: update-${{ matrix.tree-sitter-name }}-parser-info-file
         base: ${{ env.BASE_BRANCH }}
         token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -3,7 +3,6 @@ debug.log
 # node
 node_modules/
 # Compiled files
-client/server/
 client/out/
 out/
 *.js.map

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.7.0 - 2024.09.13
+
+ - Add bitbake environment scan for global variables
+ - Add skipped recipes to the tree view with skip reason
+ - Add support for latest Yocto devtool status output
+ - Add sanity check for the working directory
+ - Fix a bug where buildConfigurations specific settings were not applied
+ - Update task_deps parser for latest Yocto output
+ - Bump dependencies
+ - Fix NPM publishing
+ - Auto-update SPDX references
+
 # 2.6.0 - 2024.06.19
 
  - Support renaming of BitBake variables in Python and Shell functions

README-DEVELOPER.md

@@ -93,7 +93,7 @@ See [the individual integration tests README](integration-tests/README.md).
 ## Tree-sitter
 This extension uses [tree-sitter-bitbake](https://github.com/tree-sitter-grammars/tree-sitter-bitbake) and [tree-sitter-bash](https://github.com/tree-sitter/tree-sitter-bash) to parse the BitBake documents. They are installed with `npm run fetch:wasm`. The versions of tree-sitter-bitbake and tree-sitter-bash are documented in [server/tree-sitter-bitbake.info](server/tree-sitter-bitbake.info) and [server/tree-sitter-bash.info](server/tree-sitter-bash.info) respectively, along with the versions of the tree-sitter-cli that have to be used.
 
-To update the .info files with the latest versions of tree-sitter-bitbake and tree-sitter-bash, it is recommended to use the scripts [scripts/update-tree-sitter-bitbake-wasm.sh](scripts/update-tree-sitter-bitbake-wasm.sh) and [scripts/update-tree-sitter-bash-wasm.sh](scripts/update-tree-sitter-bash-wasm.sh). The GitHub workflow [update-tree-sitter-wasm-file.yml](.github/workflows/update-tree-sitter-wasm-file.yml) is already responsible for doing it automatically.
+To update the .info files with the latest versions of tree-sitter-bitbake and tree-sitter-bash, it is recommended to use the scripts [scripts/update-tree-sitter-bitbake.sh](scripts/update-tree-sitter-bitbake.sh) and [scripts/update-tree-sitter-bash.sh](scripts/update-tree-sitter-bash.sh). The GitHub workflow [update-tree-sitter-parser-info-file.yml](.github/workflows/update-tree-sitter-parser-info-file.yml) is already responsible for doing it automatically.
 
 After updating the .info files, it is required to call `npm run fetch:wasm` in order to rebuild the Wasm files.
 

client/package.json

@@ -31,7 +31,7 @@
   },
   "devDependencies": {
     "@types/find": "^0.2.2",
-    "@types/vscode": "^1.90.0"
+    "@types/vscode": "^1.92.0"
   },
   "workspaces": [
     "src/lib"

client/src/__tests__/unit-tests/driver/eSDKMode.test.ts

@@ -40,12 +40,12 @@ describe('Devtool eSDK Mode Test Suite', () => {
     const bitbakeDriver = new BitbakeDriver()
     const bitbakeSettings: BitbakeSettings = {
       pathToBitbakeFolder: __dirname,
-      workingDirectory: '/path/to/workspace',
+      workingDirectory: __dirname,
       commandWrapper: '',
       pathToEnvScript: 'fakeEnvScript',
       pathToBuildFolder: 'nonexistent'
     }
-    bitbakeDriver.loadSettings(bitbakeSettings, '/path/to/workspace')
+    bitbakeDriver.loadSettings(bitbakeSettings, __dirname)
     const bitbakeTerminalSpy = jest.spyOn(BitbakeTerminal, 'runBitbakeTerminalCustomCommand').mockImplementation(async () => undefined as any)
     const bitbakeExecutionSpy = jest.spyOn(ProcessUtils, 'finishProcessExecution')
     clientNotificationManager.showBitbakeSettingsError = jest.fn()

client/src/__tests__/unit-tests/driver/scanner.test.ts

@@ -103,6 +103,19 @@ describe('BitBakeProjectScanner', () => {
     )
   })
 
+  it('can detected skipped recipes', async () => {
+    const recipes = bitBakeProjectScanner.scanResult._recipes
+    // systemd is skipped in the poky distribution, because systemV is used instead
+    const systemdRecipe = recipes.find((recipe) => recipe.name === 'systemd')
+    expect(systemdRecipe).toEqual(
+      expect.objectContaining(
+        {
+          skipped: expect.stringContaining('skipped:')
+        }
+      )
+    )
+  })
+
   it('can get recipes appends', async () => {
     const recipes = bitBakeProjectScanner.scanResult._recipes
     const busyboxRecipe = recipes.find((recipe) => recipe.name === 'busybox')

client/src/__tests__/unit-tests/ui/bitbake-recipes-view.test.ts

@@ -48,7 +48,8 @@ describe('BitbakeDriver Recipes View', () => {
               ext: '.bbappend',
               name: 'base-files'
             }
-          ]
+          ],
+          skipped: 'skipped: because reasons'
         }
       ],
       _includes: [],
@@ -66,6 +67,7 @@ describe('BitbakeDriver Recipes View', () => {
         expect(rootTreeItem?.length).toStrictEqual(2)
         const recipeItem = (rootTreeItem as BitbakeRecipeTreeItem[])[0]
         expect(recipeItem.label).toStrictEqual('base-files')
+        expect(recipeItem.description).toEqual('skipped: because reasons')
 
         const filesItems = await treeDataProvider.getChildren(recipeItem)
         expect(filesItems).toBeDefined()
@@ -75,7 +77,7 @@ describe('BitbakeDriver Recipes View', () => {
     mockVscodeEvents()
 
     const bitbakeRecipesView = new BitbakeRecipesView(bitbakeWorkspace, bitBakeProjectScanner)
-    bitbakeRecipesView.registerView(contextMock)
     bitBakeProjectScanner.onChange.emit(BitBakeProjectScanner.EventType.SCAN_COMPLETE, scanResult)
+    bitbakeRecipesView.registerView(contextMock)
   })
 })