fix(vcs-hosts): deprecated the use of projectType as expected prope…

…rty provided to the scaffolder
form8ion · Jul 6, 2023 · efc9243 · efc9243
1 parent 6cbc532
commit efc9243
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -166,7 +166,9 @@ __object__:
         returned from the `prompt` function
       * `projectRoot`: __string__ path of the working directory where the CLI
         command was executed
-      * `projectType`: __string__ primary language for the project
+      * `projectType`:
+        * __string__ primary language for the project
+        * _deprecated_ will be removed with the next major version
       * `description`: __string__ brief summary of the project
       * `homepage`: __string__ url of the project homepage
   * `public`: __boolean__ (_optional_) whether this host should be presented

diff --git a/src/scaffolder.js b/src/scaffolder.js
@@ -59,6 +59,10 @@ export async function scaffold(options) {
   const vcsHostResults = vcs && await scaffoldVcsHost(vcsHosts, {
     ...vcs,
     projectRoot,
+    /**
+     * @deprecated vcs-host plugins should no longer expect `projectType` to be provided.
+     * will be removed with the next major version
+     */
     projectType: projectLanguage,
     description,
     visibility,