build: Convert project to monorepo using Lerna (#1224)

Signed-off-by: Dominik Jelinek <djelinek@redhat.com>
redhat-developer · Apr 2, 2024 · 4386235 · 4386235
1 parent a7537b0
commit 4386235
Show file tree

Hide file tree

Showing 275 changed files with 11,207 additions and 2,732 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -18,7 +18,30 @@ updates:
     reviewers:
       - redhat-developer/extester-maintainers
   - package-ecosystem: 'npm'
-    directory: '/test/test-project'
+    directory: '/tests/test-project'
+    schedule:
+      interval: 'daily'
+    labels:
+      - "skip-changelog"
+    versioning-strategy: increase
+    reviewers:
+      - redhat-developer/extester-maintainers
+  - package-ecosystem: 'npm'
+    directory: '/packages/extester'
+    schedule:
+      interval: 'daily'
+    versioning-strategy: increase
+    reviewers:
+      - redhat-developer/extester-maintainers
+  - package-ecosystem: 'npm'
+    directory: '/packages/locators'
+    schedule:
+      interval: 'daily'
+    versioning-strategy: increase
+    reviewers:
+      - redhat-developer/extester-maintainers
+  - package-ecosystem: 'npm'
+    directory: '/packages/page-objects'
     schedule:
       interval: 'daily'
     versioning-strategy: increase

diff --git a/.github/workflows/publish-wiki.yml b/.github/workflows/publish-wiki.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches: [ main ]
     paths:
-      - wiki/**
+      - docs/**
       - .github/workflows/publish-wiki.yml
 
 concurrency:

diff --git a/.github/workflows/template-main.yaml b/.github/workflows/template-main.yaml
@@ -30,10 +30,10 @@ jobs:
       TEST_RESOURCES: test-resources
 
     steps:
-      - name: 🔧 Checkout Repository
+      - name: 👷🏻 Checkout Repository
         uses: actions/checkout@v4
 
-      - name: 🔧 Setup NodeJS
+      - name: ⚙️ Setup NodeJS
         uses: actions/setup-node@v4
         with:
           node-version: ${{ inputs.nodejs }}
@@ -42,15 +42,19 @@ jobs:
       - name: 🔧 Install
         run: npm ci
 
+      - name: 🔧 Build
+        run: npm run build
+
+      - name: 🔧 Install - Test Project
+        run: npm install --workspace=extester-test
+
       - name: 🔍 Run Tests (macOS, windows)
         if: matrix.os != 'ubuntu-latest'
-        run: |
-          npm test
+        run: npm test
 
       - name: 🔍 Run Tests (linux)
         if: matrix.os == 'ubuntu-latest'
-        run: |
-          xvfb-run --auto-servernum --server-args='-screen 0 1920x1080x24' npm test
+        run: xvfb-run --auto-servernum --server-args='-screen 0 1920x1080x24' npm test
 
       - name: 💾 Upload Screenshots
         uses: actions/upload-artifact@v4

diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,3 @@
-out
-node_modules
-./.vscode
-docs
-resources/api-handler.vsix
-.npmrc
-*.tgz
-test/test-project/package-lock.json
+out/
+node_modules/
+.npmrc
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,25 +34,17 @@ Now that you have the code, you will need to build the project. First, we need t
 npm install
 ```
 
-Now you can compile the typescript project. We recommend using the predefined script for that:
-
-```nodejs
-npm run build
-```
-
-After these steps, you should be able to run the project and make your changes. Just make sure to rebuild the project after changing the source files so you can test it.
-
 ### Test It
 
-**When you make a change, make sure the tests are passing**. In the ```test/test-project``` directory there is a dummy VS Code extension we use to test the framework itself.
+**When you make a change, make sure the tests are passing**. In the ```tests/test-project``` directory there is a dummy VS Code extension we use to test the framework itself.
 
 For that, you can use the following script and launch the tests:
 
 ```nodejs
-npm test
+npm run test:build
 ```
 
-If you are adding a new feature, be sure to **write new tests** for it. If you navigate to the ```test/test-project/src/test``` folder, you will find a test file structure that mirrors the source files. Put your new test into the appropriate existing file, or create a new one that follows the same structure.
+If you are adding a new feature, be sure to **write new tests** for it. If you navigate to the ```tests/test-project/src/test``` folder, you will find a test file structure that mirrors the source files. Put your new test into the appropriate existing file, or create a new one that follows the same structure.
 
 ### Pull Requests
 
@@ -73,21 +65,20 @@ Lastly, a pull request check on [Github Actions](../../actions) is going to kick
 
 - [ ] Check all related PR's were merged and the `Main CI` is green
 
-1. _(optional)_ Publish `monaco-page-objects` package
+1. _(optional)_ Publish `@vscode-extension-tester/page-objects` package
     - `cd page-objects`
     - [ ] `npm version (major|minor|patch)`
     - [ ] `npm publish`
-2. _(optional)_ Publish `vscode-extension-tester-locators` package
+2. _(optional)_ Publish `@vscode-extension-tester/locators` package
     - `cd locators`
     - [ ] `npm version (major|minor|patch)`
-    - [ ] bump `monaco-page-objects` peerDependency to recently published in step 1)
     - [ ] `npm publish`
 3. Publish `vscode-extension-tester` package
     - [ ] `npm version (major|minor|patch) --no-git-tag-version`
-    - [ ] bump `page-objects` dependency
-      - `npm install monaco-page-objects@latest`
-    - [ ] bump `locators` dependency
-      - `npm install vscode-extension-tester-locators@latest`
+    - [ ] bump `@vscode-extension-tester/page-objects` dependency
+      - `npm install @vscode-extension-tester/page-objects@latest`
+    - [ ] bump `@vscode-extension-tester/locators` dependency
+      - `npm install @vscode-extension-tester/locators@latest`
     - [ ] commit changes and open new PR
     - [ ] wait for PR is approved and merged
     - [ ] after merge, wait until `Main CI` is green
@@ -98,7 +89,7 @@ Lastly, a pull request check on [Github Actions](../../actions) is going to kick
 ### Post publish tasks
 
 - [ ] Close published version [milestone](https://github.com/redhat-developer/vscode-extension-tester/milestones) and update ExTester [project board](https://github.com/orgs/redhat-developer/projects/41/views/3)
-- Update `sample-projects/helloworld-sample` project
+- Update `examples/helloworld-extester` project
   - [ ] Bump `vscode-extension-tester` version to recently released one
   - [ ] Run tests and check everything is working properly
 - _(optional)_ Spread a message about new release using IM tools, mailing lists and social media

diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/vscode-extension-tester"><img src="https://img.shields.io/npm/v/vscode-extension-tester?label=extester&color=orange&style=for-the-badge" alt="ExTester"/></a>
-  <a href="https://www.npmjs.com/package/vscode-extension-tester-locators"><img src="https://img.shields.io/npm/v/vscode-extension-tester-locators?color=orange&label=locators&style=for-the-badge" alt="ExTester Locators"/></a>
-  <a href="https://www.npmjs.com/package/monaco-page-objects"><img src="https://img.shields.io/npm/v/monaco-page-objects?color=orange&label=page%20objects&style=for-the-badge" alt="ExTester Page Objects"/></a>
+  <a href="https://www.npmjs.com/package/@vscode-extension-tester/locators"><img src="https://img.shields.io/npm/v/v@vscode-extension-tester/locators?color=orange&label=locators&style=for-the-badge" alt="ExTester Locators"/></a>
+  <a href="https://www.npmjs.com/package/@vscode-extension-tester/page-objects"><img src="https://img.shields.io/npm/v/@vscode-extension-tester/page-objects?color=orange&label=page%20objects&style=for-the-badge" alt="ExTester Page Objects"/></a>
   <a href="https://github.com/redhat-developer/vscode-extension-tester/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue.svg?style=for-the-badge&logo=appveyor" alt="License"/></a>
   </br>
   <a href="https://github.com/redhat-developer/vscode-extension-tester/actions/workflows/main.yml"><img src="https://img.shields.io/github/actions/workflow/status/redhat-developer/vscode-extension-tester/main.yml?label=Main%20CI&style=for-the-badge" alt="Main CI"></a>
@@ -54,10 +54,10 @@ npm install --save-dev vscode-extension-tester@latest
 
 Make sure to check out the 🔗 [Documentation](#documentation) for detailed instructions.
 
-- 📄 [How to set up the tests](../../wiki/Test-Setup)
-- 📄 [Configuring Mocha](../../wiki/Mocha-Configuration)
-- 📄 [An example simple test case](../../wiki/Writing-Simple-Tests)
-- 📄 [Page objects API quick guide](../../wiki/Page-Object-APIs)
+- 📄 [How to set up the tests](./docs/Test-Setup)
+- 📄 [Configuring Mocha](./docs/Mocha-Configuration)
+- 📄 [An example simple test case](./docs/Writing-Simple-Tests)
+- 📄 [Page objects API quick guide](./docs/Page-Object-APIs)
 
 ### Documentation
 

diff --git a/wiki/ActionsControl.md → docs/ActionsControl.md b/wiki/ActionsControl.md → docs/ActionsControl.md
@@ -1,7 +1,7 @@
 ![actionControl](https://user-images.githubusercontent.com/4181232/56589258-27bb1900-65e5-11e9-9aef-7643f44697f4.png)
 
 #### Look up the ActionsControl by title
-Import and find the control through activity bar 
+Import and find the control through activity bar
 ```typescript
 import { ActivityBar, ActionsControl } from 'vscode-extension-tester';
 ...

diff --git a/wiki/ActivityBar.md → docs/ActivityBar.md b/wiki/ActivityBar.md → docs/ActivityBar.md
diff --git a/wiki/BottomBarPanel.md → docs/BottomBarPanel.md b/wiki/BottomBarPanel.md → docs/BottomBarPanel.md
diff --git a/wiki/ContentAssist.md → docs/ContentAssist.md b/wiki/ContentAssist.md → docs/ContentAssist.md
diff --git a/wiki/ContextMenu.md → docs/ContextMenu.md b/wiki/ContextMenu.md → docs/ContextMenu.md
diff --git a/wiki/ContextMenuItem.md → docs/ContextMenuItem.md b/wiki/ContextMenuItem.md → docs/ContextMenuItem.md
diff --git a/wiki/CustomEditor.md → docs/CustomEditor.md b/wiki/CustomEditor.md → docs/CustomEditor.md
diff --git a/wiki/CustomTreeSection.md → docs/CustomTreeSection.md b/wiki/CustomTreeSection.md → docs/CustomTreeSection.md
diff --git a/wiki/DebugConsoleView.md → docs/DebugConsoleView.md b/wiki/DebugConsoleView.md → docs/DebugConsoleView.md
diff --git a/wiki/DebugToolbar.md → docs/DebugToolbar.md b/wiki/DebugToolbar.md → docs/DebugToolbar.md
diff --git a/wiki/DebugView.md → docs/DebugView.md b/wiki/DebugView.md → docs/DebugView.md
diff --git a/wiki/Debugging-Tests.md → docs/Debugging-Tests.md b/wiki/Debugging-Tests.md → docs/Debugging-Tests.md
@@ -40,4 +40,4 @@ We recommend using separate mocha configuration files for running, and debugging
 
 To learn more about mocha configuration, check [[Mocha-Configuration]].
 
-An example debugging setup can be found in [helloworld-sample](../tree/master/sample-projects/helloworld-sample).
+An example debugging setup can be found in [helloworld-extester](../tree/main/examples/helloworld-extester).
diff --git a/wiki/DefaultTreeSection.md → docs/DefaultTreeSection.md b/wiki/DefaultTreeSection.md → docs/DefaultTreeSection.md
diff --git a/wiki/DiffEditor.md → docs/DiffEditor.md b/wiki/DiffEditor.md → docs/DiffEditor.md
diff --git a/wiki/EditorView.md → docs/EditorView.md b/wiki/EditorView.md → docs/EditorView.md
diff --git a/wiki/ExtensionsViewSection.md → docs/ExtensionsViewSection.md b/wiki/ExtensionsViewSection.md → docs/ExtensionsViewSection.md
diff --git a/wiki/FindWidget.md → docs/FindWidget.md b/wiki/FindWidget.md → docs/FindWidget.md
diff --git a/wiki/Home.md → docs/Home.md b/wiki/Home.md → docs/Home.md
diff --git a/wiki/Input.md → docs/Input.md b/wiki/Input.md → docs/Input.md
diff --git a/wiki/Mocha-Configuration.md → docs/Mocha-Configuration.md b/wiki/Mocha-Configuration.md → docs/Mocha-Configuration.md
diff --git a/wiki/ModalDialog.md → docs/ModalDialog.md b/wiki/ModalDialog.md → docs/ModalDialog.md
diff --git a/wiki/Notification.md → docs/Notification.md b/wiki/Notification.md → docs/Notification.md
diff --git a/wiki/NotificationsCenter.md → docs/NotificationsCenter.md b/wiki/NotificationsCenter.md → docs/NotificationsCenter.md
diff --git a/wiki/OutputView.md → docs/OutputView.md b/wiki/OutputView.md → docs/OutputView.md
diff --git a/wiki/Page-Object-APIs.md → docs/Page-Object-APIs.md b/wiki/Page-Object-APIs.md → docs/Page-Object-APIs.md
diff --git a/wiki/ProblemsView.md → docs/ProblemsView.md b/wiki/ProblemsView.md → docs/ProblemsView.md
diff --git a/wiki/ScmView.md → docs/ScmView.md b/wiki/ScmView.md → docs/ScmView.md
diff --git a/wiki/Setting.md → docs/Setting.md b/wiki/Setting.md → docs/Setting.md
diff --git a/wiki/SettingsEditor.md → docs/SettingsEditor.md b/wiki/SettingsEditor.md → docs/SettingsEditor.md
diff --git a/wiki/SideBarView.md → docs/SideBarView.md b/wiki/SideBarView.md → docs/SideBarView.md
diff --git a/wiki/StatusBar.md → docs/StatusBar.md b/wiki/StatusBar.md → docs/StatusBar.md
diff --git a/wiki/Taking Screenshots.md → docs/Taking Screenshots.md b/wiki/Taking Screenshots.md → docs/Taking Screenshots.md
diff --git a/wiki/TerminalView.md → docs/TerminalView.md b/wiki/TerminalView.md → docs/TerminalView.md
diff --git a/wiki/Test-Setup.md → docs/Test-Setup.md b/wiki/Test-Setup.md → docs/Test-Setup.md
diff --git a/wiki/TextEditor.md → docs/TextEditor.md b/wiki/TextEditor.md → docs/TextEditor.md
diff --git a/wiki/TitleBar.md → docs/TitleBar.md b/wiki/TitleBar.md → docs/TitleBar.md
diff --git a/wiki/TitleBarItem.md → docs/TitleBarItem.md b/wiki/TitleBarItem.md → docs/TitleBarItem.md
diff --git a/wiki/ViewContent.md → docs/ViewContent.md b/wiki/ViewContent.md → docs/ViewContent.md
diff --git a/wiki/ViewContol.md → docs/ViewContol.md b/wiki/ViewContol.md → docs/ViewContol.md
diff --git a/wiki/ViewItem.md → docs/ViewItem.md b/wiki/ViewItem.md → docs/ViewItem.md
diff --git a/wiki/ViewSection.md → docs/ViewSection.md b/wiki/ViewSection.md → docs/ViewSection.md
diff --git a/wiki/ViewTitlePart.md → docs/ViewTitlePart.md b/wiki/ViewTitlePart.md → docs/ViewTitlePart.md
diff --git a/wiki/WebView.md → docs/WebView.md b/wiki/WebView.md → docs/WebView.md
diff --git a/wiki/WebviewView.md → docs/WebviewView.md b/wiki/WebviewView.md → docs/WebviewView.md
diff --git a/wiki/WindowControls.md → docs/WindowControls.md b/wiki/WindowControls.md → docs/WindowControls.md
diff --git a/wiki/Workbench.md → docs/Workbench.md b/wiki/Workbench.md → docs/Workbench.md
diff --git a/wiki/Writing-Simple-Tests.md → docs/Writing-Simple-Tests.md b/wiki/Writing-Simple-Tests.md → docs/Writing-Simple-Tests.md
diff --git a/wiki/images/webview-view-example.png → docs/images/webview-view-example.png b/wiki/images/webview-view-example.png → docs/images/webview-view-example.png
diff --git a/...projects/helloworld-sample/.eslintrc.json → examples/helloworld-extester/.eslintrc.json b/...projects/helloworld-sample/.eslintrc.json → examples/helloworld-extester/.eslintrc.json
@@ -1,9 +1,4 @@
 {
-    "env": {
-        "browser": true,
-        "es6": true,
-        "node": true
-    },
     "parser": "@typescript-eslint/parser",
     "plugins": [
         "@typescript-eslint"

diff --git a/sample-projects/helloworld-sample/.gitignore → examples/helloworld-extester/.gitignore b/sample-projects/helloworld-sample/.gitignore → examples/helloworld-extester/.gitignore
diff --git a/...le-projects/helloworld-sample/.mocharc.js → examples/helloworld-extester/.mocharc.js b/...le-projects/helloworld-sample/.mocharc.js → examples/helloworld-extester/.mocharc.js
diff --git a/...cts/helloworld-sample/.vscode/launch.json → ...s/helloworld-extester/.vscode/launch.json b/...cts/helloworld-sample/.vscode/launch.json → ...s/helloworld-extester/.vscode/launch.json
diff --git a/...ects/helloworld-sample/.vscode/tasks.json → ...es/helloworld-extester/.vscode/tasks.json b/...ects/helloworld-sample/.vscode/tasks.json → ...es/helloworld-extester/.vscode/tasks.json
diff --git a/...-projects/helloworld-sample/.vscodeignore → examples/helloworld-extester/.vscodeignore b/...-projects/helloworld-sample/.vscodeignore → examples/helloworld-extester/.vscodeignore
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ on: @@
       push:
         branches: [ main ]
         paths:
-          - wiki/**
+          - docs/**
           - .github/workflows/publish-wiki.yml
     concurrency:
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,4 +40,4 @@ We recommend using separate mocha configuration files for running, and debugging

		To learn more about mocha configuration, check [[Mocha-Configuration]].

		An example debugging setup can be found in [helloworld-sample](../tree/master/sample-projects/helloworld-sample).
		An example debugging setup can be found in [helloworld-extester](../tree/main/examples/helloworld-extester).