Merge pull request #4342 from hayemaxi/restructure3

refactor: move toolkit to monorepo structure

These commits restructure our project into a monorepo using npm workspaces. The original toolkit extension code now lives under packages/toolkit/. Additional extensions and common modules will go under the packages/ folder. This change will allow us to divide the toolkit into separate modules and extensions as needed.

A summary of changes include:
- Creating a root package.json
- Moving all extension src code, resources/, types/, and syntaxes to a subproject with the original package.json
- Updating paths throughout the code and configs to reference the new file structure
- Script and packaging changes to work with this new structure

See `docs/ARCHITECTURE.md#monorepo-structure` for more info.

Author: hayemaxi

.eslintignore

@@ -1,11 +1,19 @@
-node_modules/**
-dist/**
+node_modules/
+dist/
 src.gen/**
 **/*.json
+**/*.gen.ts
+types/*.d.ts
+
+# Duplicate entries because prettier can be ran from root or within the workspace/subpackage.
+# TODO: Avoid this.
 src/shared/telemetry/clienttelemetry.d.ts
 src/codewhisperer/client/codewhispererclient.d.ts
 src/codewhisperer/client/codewhispereruserclient.d.ts
 src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
-**/*.gen.ts
 src/testFixtures/**
-types/*.d.ts
+packages/toolkit/src/shared/telemetry/clienttelemetry.d.ts
+packages/toolkit/src/codewhisperer/client/codewhispererclient.d.ts
+packages/toolkit/src/codewhisperer/client/codewhispereruserclient.d.ts
+packages/toolkit/src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
+packages/toolkit/src/testFixtures/**

.eslintrc.js

@@ -4,7 +4,7 @@ module.exports = {
     parserOptions: {
         ecmaVersion: 'latest',
         sourceType: 'module',
-        project: './tsconfig.json',
+        project: ['./packages/*/tsconfig.json', './plugins/*/tsconfig.json'],
         tsconfigRootDir: __dirname,
     },
     env: {

.github/CODEOWNERS

@@ -1,5 +1,5 @@
 * @aws/aws-ides-team
-src/codewhisperer/ @aws/codewhisperer-team
-src/amazonqFeatureDev/ @aws/earlybird
-src/codewhispererChat/ @aws/aws-mynah
-src/amazonq/ @aws/aws-mynah
+packages/toolkit/src/codewhisperer/ @aws/codewhisperer-team
+packages/toolkit/src/amazonqFeatureDev/ @aws/earlybird
+packages/toolkit/src/codewhispererChat/ @aws/aws-mynah
+packages/toolkit/src/amazonq/ @aws/aws-mynah

.github/dependabot.yml

@@ -7,7 +7,7 @@
 version: 2
 updates:
     - package-ecosystem: 'npm'
-      directory: '/' # Location of package manifests.
+      directory: './packages/toolkit/' # Location of package manifests.
       target-branch: 'master' # Avoid updates to "staging".
       commit-message:
           prefix: 'deps'
@@ -25,7 +25,7 @@ updates:
                   - '@smithy*'
                   - 'smithy*'
     - package-ecosystem: 'github-actions'
-      directory: '/'
+      directory: './packages/toolkit/'
       target-branch: 'master' # Avoid updates to "staging".
       commit-message:
           prefix: 'deps'

.github/workflows/release.yml

@@ -52,7 +52,7 @@ jobs:
             - name: vsix
               run: |
                   npm run createRelease  # Generate CHANGELOG.md
-                  npm run generateNonCodeFiles
+                  npm run generateNonCodeFiles -w packages/toolkit
                   cp ./README.quickstart.vscode.md ./README.md
                   npm run package -- --feature "$FEAT_NAME"
             - uses: actions/upload-artifact@v4

.gitignore

@@ -1,8 +1,8 @@
 out
 dist
 node_modules
-.vscode-test/
-coverage/
+.vscode-test
+coverage
 *.vsix
 *.zip
 *.bk
@@ -13,34 +13,40 @@ quickStart*.html
 README.quickstart.cloud9.md
 README.quickstart.vscode.md
 .gitcommit
-resources/debugger/__pycache__
+__pycache__
 
 # Generated if running the `depcruise` command from the documentation example
 /dependency-graph.svg
 
 # Auto generated definitions
-src/**/*.gen.ts
+packages/toolkit/src/**/*.gen.ts
 src.gen/*
 # Telemetry definition for testing adding telemetry
-src/shared/telemetry/vscodeTelemetry.json
+packages/toolkit/src/shared/telemetry/vscodeTelemetry.json
 
 # Test reports
-.test-reports/
+.test-reports
 
 # Auto generated type definitions
-src/shared/telemetry/clienttelemetry.d.ts
-src/codewhisperer/client/codewhispererclient.d.ts
-src/codewhisperer/client/codewhispereruserclient.d.ts
-src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
+packages/toolkit/src/shared/telemetry/clienttelemetry.d.ts
+packages/toolkit/src/codewhisperer/client/codewhispererclient.d.ts
+packages/toolkit/src/codewhisperer/client/codewhispereruserclient.d.ts
+packages/toolkit/src/amazonqFeatureDev/client/featuredevproxyclient.d.ts
 
 # Generated by tests
-src/testFixtures/**/bin
-src/testFixtures/**/obj
+packages/toolkit/src/testFixtures/**/bin
+packages/toolkit/src/testFixtures/**/obj
+
+# Generated by copyFiles.ts
+packages/toolkit/README*
+packages/toolkit/CHANGELOG.md
+packages/toolkit/LICENSE
+packages/toolkit/NOTICE
 
 # Icons
-resources/icons/cloud9/generated/**
-resources/fonts/aws-toolkit-icons.woff
-resources/css/icons.css
+packages/toolkit/resources/icons/cloud9/generated/**
+packages/toolkit/resources/fonts/aws-toolkit-icons.woff
+packages/toolkit/resources/css/icons.css
 
 # local configuration
 .local.env

.prettierignore

@@ -1,12 +1,15 @@
 out
-resources/endpoints.json
 CHANGELOG.md
-src/shared/telemetry/service-2.json
 .changes
-src/testFixtures/**
 *.d.ts
 *.gen.ts
-dist/**
-types/*.d.ts
+dist
 src.gen/**
-plugins/*/dist/**
+
+# Duplicate entries because prettier can be ran from root or within the workspace/subpackage.
+# TODO: Avoid this.
+src/shared/telemetry/service-2.json
+src/testFixtures/**
+
+packages/toolkit/src/shared/telemetry/service-2.json
+packages/toolkit/src/testFixtures/**

.vscode/settings.json

@@ -11,5 +11,6 @@
     },
     "typescript.preferences.importModuleSpecifier": "relative",
     "javascript.preferences.importModuleSpecifier": "relative",
-    "typescript.tsdk": "node_modules/typescript/lib"
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "npm.packageManager": "npm"
 }

.vscodeignore

@@ -8,6 +8,10 @@ codebase and sending pull requests.
 
 ## Getting Started
 
+This project is set up as a typescript monorepo. The documentation throughout this project
+is referring to the subproject in [`packages/toolkit/`](./packages/toolkit/). For more information,
+see [ARCHITECTURE.md](./docs/ARCHITECTURE.md#monorepo-structure)
+
 ### Find things to do
 
 If you're looking for ideas about where to contribute, consider
@@ -35,6 +39,9 @@ Then clone the repository and install NPM packages:
 
 ### Run
 
+Due to the monorepo structure of the project, you can run the extension in VSCode by either opening the
+`aws-toolkit-vscode/packages/toolkit` folder directly, or adding it as a root folder in the VSCode Workspace.
+
 To run the extension from VSCode as a Node.js app:
 
 1. Select the Run panel from the sidebar.
@@ -153,7 +160,9 @@ See [browser.md](./docs/browser.md) for working with the browser implementation
 See [TESTPLAN.md](./docs/TESTPLAN.md) to understand the project's test
 structure, mechanics and philosophy.
 
-You can run tests directly from VSCode:
+You can run tests directly from VSCode. Due to the monorepo structure of the project, you must either open
+the `aws-toolkit-vscode/packages/toolkit/` folder directly, or add it as a root folder in the VSCode Workspace.
+Then:
 
 1. Select `View > Debug`, or select the Debug pane from the sidebar.
 2. From the dropdown at the top of the Debug pane, select the `Extension Tests` configuration.
@@ -208,7 +217,7 @@ To run tests against a specific folder in VSCode, do any one of:
 
 Running the extension in the browser (eg: [vscode.dev](https://vscode.dev/)).
 
-[See documentation here](./src/browser/README.md).
+[See documentation here](./packages/toolkit/src/browser/README.md).
 
 ### Coverage report