Merge pull request #178 from Accenture/develop

Release v1.0.2
Accenture · May 24, 2024 · 4984670 · 4984670
2 parents 5c55d8f + acdcff0
commit 4984670
Show file tree

Hide file tree

Showing 11 changed files with 2,184 additions and 1,285 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,37 @@
-# **Accenture SFMC DevTools** | Visual Studio Code Extension
+# **SFMC DevTools** | Visual Studio Code Extension
 
 Accenture SFMC DevTools VS Code Extension was built to simplify the command execution for [Accenture SFMC DevTools](https://github.com/Accenture/sfmc-devtools), offering a more intuitive interface that streamlines the process of retrieving and deploying Marketing Cloud assets, configuration and code across various Business Units and instances. This tool eliminates the necessity of manual command line input (CLI), making your workflow more efficient and user-friendly.
 
 ### Pre Requisites
 
-- [Node.js](https://nodejs.org/en)
-- [Git](https://git-scm.com/downloads)
-- [Accenture SFMC DevTools](https://github.com/Accenture/sfmc-devtools)
+- Install [Node.js](https://nodejs.org/en)
+- Install [Git](https://git-scm.com/downloads)
+- Install [Accenture SFMC DevTools](https://github.com/Accenture/sfmc-devtools)
 
 ### Install Accenture SFMC DevTools
 
 ```bash
 npm install -g mcdev
 ```
 
+### Install SFMC DevTools VS Code Extension
+
+- In Visual Studio Code, navigate to the Extensions tab (or click `Ctrl + Shift + X`
+- Search for `SFMC DevTools` and click on `Install`
+- After installation is completed click on the button `Reload Required` or simply reopen your Visual Studio Code
+- A `mcddev` button should display at the bottom bar
+
+### Initialize SFMC DevTools Project
+If you are starting a completely new SFMC DevTools project
+- Go to Terminal and click on New Terminal
+- Enter the command `mcdev init` and follow the interactive instructions to initialize a new project. For more guidance, consult the official SFMC DevTools documentation [here](https://github.com/Accenture/sfmc-devtools/wiki/06.a-~-Admin-Commands#init)
+
+
+### Wiki
+
+Consult the [Wiki](https://github.com/Accenture/sfmc-devtools-vscode/wiki) for a complete guide on how to use the SFMC DevTools Vscode Extension.
+
+
 ### Currently Supported Accenture SFMC DevTools commands
 
 - [Retrieve](https://github.com/Accenture/sfmc-devtools/wiki/06.b-~-Standard-Commands#retrieve)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
    "name": "sfmc-devtools-vscode",
    "displayName": "SFMC DevTools",
    "description": "Unofficial IDE for Salesforce Marketing Cloud",
-   "version": "1.0.1",
+   "version": "1.0.2",
    "license": "MIT",
    "publisher": "Accenture-oss",
    "peerDependencies": {
@@ -61,17 +61,17 @@
       "menus": {
          "explorer/context": [
             {
-               "when": "resourcePath =~ /retrieve/",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && resourcePath =~ /retrieve/",
                "command": "sfmc-devtools-vscext.devtoolsCMRetrieve",
                "group": "devtools"
             },
             {
-               "when": "resourcePath =~ /deploy/ || (resourcePath =~ /retrieve/ && (resourceExtname == '.json' || resourceExtname == '.html' || resourceExtname == '.sql' || resourceExtname == '.ssjs' || resourceLangId == 'markdown'))",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && (resourcePath =~ /deploy/ || (resourcePath =~ /retrieve/ && (resourceExtname == '.json' || resourceExtname == '.html' || resourceExtname == '.sql' || resourceExtname == '.ssjs' || resourceLangId == 'markdown' || resourceLangId == 'AMPscript' || resourceLangId == 'ampscript' || resourceDirname =~ /asset\\\\[a-zA-Z]*/)))",
                "command": "sfmc-devtools-vscext.devtoolsCMDeploy",
                "group": "devtools"
             },
             {
-               "when": "resourcePath =~ /retrieve/ && resourceFilename != 'retrieve' && resourceFilename != 'deploy'",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && resourcePath =~ /retrieve/ && resourceFilename != 'retrieve' && resourceFilename != 'deploy'",
                "command": "sfmc-devtools-vscext.devtoolsCMCopyToBU",
                "group": "devtools"
             }
@@ -92,28 +92,29 @@
          ],
          "editor/title/context": [
             {
-               "when": "resourcePath =~ /retrieve/",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && resourcePath =~ /retrieve/",
                "command": "sfmc-devtools-vscext.devtoolsCMRetrieve",
                "group": "devtools"
             },
             {
-               "when": "resourcePath =~ /deploy/ || (resourcePath =~ /retrieve/ && (resourceExtname == '.json' || resourceExtname == '.html' || resourceExtname == '.sql' || resourceExtname == '.ssjs' || resourceLangId == 'markdown'))",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && (resourcePath =~ /deploy/ || (resourcePath =~ /retrieve/ && (resourceExtname == '.json' || resourceExtname == '.html' || resourceExtname == '.sql' || resourceExtname == '.ssjs' || resourceLangId == 'markdown' || resourceLangId == 'AMPscript' || resourceLangId == 'ampscript')))",
                "command": "sfmc-devtools-vscext.devtoolsCMDeploy",
                "group": "devtools"
             },
             {
-               "when": "resourcePath =~ /retrieve/ && resourceFilename != 'retrieve' && resourceFilename != 'deploy'",
+               "when": "sfmc-devtools-vscode.isDevToolsProject && resourcePath =~ /retrieve/ && resourceFilename != 'retrieve' && resourceFilename != 'deploy'",
                "command": "sfmc-devtools-vscext.devtoolsCMCopyToBU",
                "group": "devtools"
             }
          ]
       },
       "configuration": {
-         "title": "sfmc-devtools-vscode",
+         "title": "SFMC DevTools",
          "properties": {
             "sfmc-devtools-vscode.recommendExtensions": {
                "type": "boolean",
-               "default": true
+               "default": true,
+               "description": "Indicates if recommended extensions popup should be shown to user or not."
             }
          }
       }
@@ -129,25 +130,25 @@
       "test": "jest --coverage"
    },
    "devDependencies": {
-      "@types/chai": "^4.3.11",
+      "@types/chai": "^4.3.16",
       "@types/jest": "^29.5.11",
-      "@types/node": "^20.11.17",
+      "@types/node": "^20.12.8",
       "@types/vscode": "^1.81.1",
-      "@typescript-eslint/eslint-plugin": "^7.1.0",
-      "@typescript-eslint/parser": "^7.1.0",
+      "@typescript-eslint/eslint-plugin": "^7.8.0",
+      "@typescript-eslint/parser": "^7.7.0",
       "@vscode/test-electron": "^2.3.9",
       "chai": "^5.1.0",
       "eslint": "^8.56.0",
       "jest": "^29.7.0",
       "ts-jest": "^29.1.2",
       "ts-loader": "^9.5.1",
       "typescript": "^5.3.3",
-      "webpack": "^5.90.3",
+      "webpack": "^5.91.0",
       "webpack-cli": "^5.1.4"
    },
    "dependencies": {
       "@salesforce-ux/design-system": "^2.23.2",
       "@vscode/codicons": "^0.0.35",
-      "winston": "^3.11.0"
+      "winston": "^3.13.0"
    }
 }
diff --git a/src/config/main.config.ts b/src/config/main.config.ts
@@ -22,7 +22,7 @@ export const mainConfig: {
 } = {
     credentialsFilename: ".mcdevrc.json",
     requiredFiles: [".mcdevrc.json", ".mcdev-auth.json"],
-    fileExtensions: ["meta.json", "meta.sql", "meta.html", "meta.ssjs", "doc.md"],
+    fileExtensions: ["meta.json", "meta.sql", "meta.html", "meta.ssjs", "meta.amp", "doc.md"],
     noCopyFileExtensions: ["doc.md"],
     allPlaceholder: "*All*",
     extensionsDependencies: ["IBM.output-colorizer"],