@teambit/generator 1.0.8 → 1.0.9

package/starter-list.ts

@@ -0,0 +1,21 @@
+import { EnvContext, EnvHandler } from '@teambit/envs';
+import { WorkspaceTemplate } from './workspace-template';
+
+export type StarterListOptions = {
+  name?: string;
+};
+
+export class StarterList {
+  constructor(readonly name: string, private starters: EnvHandler<WorkspaceTemplate>[], private context: EnvContext) {}
+
+  compute(): WorkspaceTemplate[] {
+    return this.starters.map((starter) => starter(this.context));
+  }
+
+  static from(starters: EnvHandler<WorkspaceTemplate>[], options: StarterListOptions = {}) {
+    return (context: EnvContext) => {
+      const name = options.name || 'starter-list';
+      return new StarterList(name, starters, context);
+    };
+  }
+}

package/starter.plugin.ts

@@ -0,0 +1,16 @@
+import { PluginDefinition } from '@teambit/aspect-loader';
+import { MainRuntime } from '@teambit/cli';
+import { GeneratorMain } from './generator.main.runtime';
+
+export class StarterPlugin implements PluginDefinition {
+  constructor(private generator: GeneratorMain) {}
+
+  pattern = '*.starter.*';
+
+  runtimes = [MainRuntime.name];
+
+  register(object: any) {
+    const templates = Array.isArray(object) ? object : [object];
+    return this.generator.registerWorkspaceTemplate(templates);
+  }
+}

package/teambit_generator_generator-preview.js

@@ -0,0 +1,11 @@
+(function(root,factory){typeof exports=="object"&&typeof module=="object"?module.exports=factory():typeof define=="function"&&define.amd?define([],factory):typeof exports=="object"?exports["teambit.generator/generator-preview"]=factory():root["teambit.generator/generator-preview"]=factory()})(self,()=>(()=>{"use strict";var __webpack_modules__={493:(__unused_webpack_module,exports2,__webpack_require__2)=>{var __bit_component={id:"teambit.generator/aspect-docs/generator@0.0.165",homepage:"https://bit.cloud/teambit/generator/aspect-docs/generator",exported:!0};Object.defineProperty(exports2,"__esModule",{value:!0}),exports2.default=MDXContent;var _react=_interopRequireDefault(__webpack_require__2(363)),_react2=__webpack_require__2(40),_excluded=["components"];function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}_interopRequireDefault.__bit_component=__bit_component;function _extends(){return _extends=Object.assign?Object.assign.bind():function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source)Object.prototype.hasOwnProperty.call(source,key)&&(target[key]=source[key])}return target},_extends.apply(this,arguments)}_extends.__bit_component=__bit_component;function _objectWithoutProperties(source,excluded){if(source==null)return{};var target=_objectWithoutPropertiesLoose(source,excluded),key,i;if(Object.getOwnPropertySymbols){var sourceSymbolKeys=Object.getOwnPropertySymbols(source);for(i=0;i<sourceSymbolKeys.length;i++)key=sourceSymbolKeys[i],!(excluded.indexOf(key)>=0)&&(!Object.prototype.propertyIsEnumerable.call(source,key)||(target[key]=source[key]))}return target}_objectWithoutProperties.__bit_component=__bit_component;function _objectWithoutPropertiesLoose(source,excluded){if(source==null)return{};var target={},sourceKeys=Object.keys(source),key,i;for(i=0;i<sourceKeys.length;i++)key=sourceKeys[i],!(excluded.indexOf(key)>=0)&&(target[key]=source[key]);return target}_objectWithoutPropertiesLoose.__bit_component=__bit_component;var layoutProps={},MDXLayout="wrapper";function MDXContent(_ref){var components=_ref.components,props=_objectWithoutProperties(_ref,_excluded);return(0,_react2.mdx)(MDXLayout,_extends({},layoutProps,props,{components,mdxType:"MDXLayout"}),(0,_react2.mdx)("p",null,"Generator extension enable generating new components by pre-defined templates"),(0,_react2.mdx)("h3",null,"Component location"),(0,_react2.mdx)("p",null,"Component location in the workspace directory tree is defined with the ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"bit create")," command (see below). For example, a component named ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"ShoppingCart")," created in the ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"acme.shopper")," and the namespace ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"ui")," will be generated in the following directory:"),(0,_react2.mdx)("pre",null,(0,_react2.mdx)("code",{parentName:"pre"},`acme.shopper/ui/shopping-cart
+`)),(0,_react2.mdx)("h3",null,"Component name"),(0,_react2.mdx)("p",null,"When using templates Bit will use CamelCasing for passing the component-name to the template, but generated file structure should be in kebab-case, for better cross-operating-system compatibility of the component."),(0,_react2.mdx)("h3",null,"Automatically ",(0,_react2.mdx)("inlineCode",{parentName:"h3"},"add")," component"),(0,_react2.mdx)("p",null,"Bit should automatically register the new component to the ",(0,_react2.mdx)("inlineCode",{parentName:"p"},".bitmap")," file with a symmetrical name to the component-location in the workspace."),(0,_react2.mdx)("h2",null,"Register a template"),(0,_react2.mdx)("p",null,"Any aspect (include envs) can register templates. Each template should have a name and a list of files. Each file has a relative-path to the component-dir and template content. See the ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"component-template.ts")," file for more info about the exact API."),(0,_react2.mdx)("ul",null,(0,_react2.mdx)("li",{parentName:"ul"},"Component name should be available as a param for the file-content-template."),(0,_react2.mdx)("li",{parentName:"ul"},"TBD: An environment must have a default template (if not set, use first template in array?).")),(0,_react2.mdx)("p",null,"To register a template, use the Generator API: ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"registerComponentTemplate(templates: ComponentTemplate[])"),"."),(0,_react2.mdx)("p",null,"To make the templates of an aspect available on a workspace, they need to be added to the workspace.jsonc. For example:"),(0,_react2.mdx)("pre",null,(0,_react2.mdx)("code",{parentName:"pre",className:"language-json"},`"teambit.generator/generator": {
+    "aspects": [
+      "teambit.harmony/aspect"
+    ]
+  },
+`)),(0,_react2.mdx)("p",null,"In the example above, the aspect ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"teambit.harmony/aspect")," is configured to be available for the generator."),(0,_react2.mdx)("h2",null,"Show all available templates"),(0,_react2.mdx)("p",null,"Introduce a new command ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"bit templates"),", which groups all available templates by aspects."),(0,_react2.mdx)("h2",null,"Hide core templates"),(0,_react2.mdx)("p",null,"Configure the Generator aspect to hide core templates when running ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"bit templates"),". They'll be only shown when using ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"--show-all")," flag."),(0,_react2.mdx)("pre",null,(0,_react2.mdx)("code",{parentName:"pre",className:"language-json"},`"teambit.generator/generator": {
+    "hideCoreTemplates": true
+  },
+`)),(0,_react2.mdx)("h2",null,"Generate a template from CLI"),(0,_react2.mdx)("p",null,"Introduce a ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"create")," command to use templates."),(0,_react2.mdx)("pre",null,(0,_react2.mdx)("code",{parentName:"pre",className:"language-sh"},`bit create <template-name> <component-name...> [--scope | -s] [--namespace | -n] [--aspect | -a]
+`)),(0,_react2.mdx)("h3",null,"Args"),(0,_react2.mdx)("h4",null,(0,_react2.mdx)("inlineCode",{parentName:"h4"},"<component name>")),(0,_react2.mdx)("p",null,"Name of the component to create. Will be used as the component's dir name and fed to the component template."),(0,_react2.mdx)("p",null,(0,_react2.mdx)("strong",{parentName:"p"},"generated file structure should use kebab-case, while the template itself be in camel case"),"."),(0,_react2.mdx)("h3",null,"Options"),(0,_react2.mdx)("h4",null,(0,_react2.mdx)("inlineCode",{parentName:"h4"},"[--scope | -s]")),(0,_react2.mdx)("p",null,"Sets the component's scope and base directory. If not defined, use the ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"defaultScope")," from ",(0,_react2.mdx)("inlineCode",{parentName:"p"},"teambit.workspace/workspace")," config."),(0,_react2.mdx)("h4",null,(0,_react2.mdx)("inlineCode",{parentName:"h4"},"[--namespace | -n]")),(0,_react2.mdx)("p",null,"Sets the component's namespace and nested dirs inside the scope. If not define, use empty string."),(0,_react2.mdx)("h4",null,(0,_react2.mdx)("inlineCode",{parentName:"h4"},"[--aspect | -a]")),(0,_react2.mdx)("p",null,"Aspect ID that registered this template, required only if there are two templates with the same name from several aspects in the workspace."),(0,_react2.mdx)("h2",null,"Creating a custom template generator"),(0,_react2.mdx)("p",null,"See our ",(0,_react2.mdx)("a",{parentName:"p",href:"https://harmony-docs.bit.dev/extending-bit/creating-a-custom-generator"},"tutorial")," on how to Create your own custom component generator."))}MDXContent.__bit_component=__bit_component,MDXContent.isMDXComponent=!0},736:function(__unused_webpack_module,exports2,__webpack_require__2){var __bit_component={id:"teambit.generator/aspect-docs/generator@0.0.165",homepage:"https://bit.cloud/teambit/generator/aspect-docs/generator",exported:!0},__importDefault=this&&this.__importDefault||function(mod){return mod&&mod.__esModule?mod:{default:mod}};Object.defineProperty(exports2,"__esModule",{value:!0}),exports2.Generator=void 0;var generator_mdx_1=__webpack_require__2(493);Object.defineProperty(exports2,"Generator",{enumerable:!0,get:function(){return __importDefault(generator_mdx_1).default}})},951:(__unused_webpack_module,exports2,__webpack_require__2)=>{var __bit_component={id:"teambit.generator/generator@6489e18b89a4a26b88b415fb314ab2af864f1df7",homepage:"https://bit.cloud/teambit/generator/generator",exported:!0};Object.defineProperty(exports2,"__esModule",{value:!0}),exports2.Logo=void 0;function _react(){const data=_interopRequireDefault(__webpack_require__2(363));return _react=function(){return data},data}_react.__bit_component=__bit_component;function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}_interopRequireDefault.__bit_component=__bit_component;const Logo=()=>_react().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},_react().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/generator-new.svg"}));Logo.__bit_component=__bit_component,exports2.Logo=Logo},40:module2=>{module2.exports=MdxJsReact},363:module2=>{module2.exports=React}},__webpack_module_cache__={};function __webpack_require__(moduleId){var cachedModule=__webpack_module_cache__[moduleId];if(cachedModule!==void 0)return cachedModule.exports;var module2=__webpack_module_cache__[moduleId]={exports:{}};return __webpack_modules__[moduleId].call(module2.exports,module2,module2.exports,__webpack_require__),module2.exports}__webpack_require__.d=(exports2,definition)=>{for(var key in definition)__webpack_require__.o(definition,key)&&!__webpack_require__.o(exports2,key)&&Object.defineProperty(exports2,key,{enumerable:!0,get:definition[key]})},__webpack_require__.o=(obj,prop)=>Object.prototype.hasOwnProperty.call(obj,prop),__webpack_require__.r=exports2=>{typeof Symbol<"u"&&Symbol.toStringTag&&Object.defineProperty(exports2,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(exports2,"__esModule",{value:!0})};var __webpack_exports__={};return(()=>{__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{compositions:()=>compositions,compositions_metadata:()=>compositions_metadata,overview:()=>overview});var generator_docs_namespaceObject={};__webpack_require__.r(generator_docs_namespaceObject),__webpack_require__.d(generator_docs_namespaceObject,{default:()=>MDXContent});var generator_composition=__webpack_require__(951),external_React_=__webpack_require__(363),external_MdxJsReact_=__webpack_require__(40);const external_TeambitMdxUiMdxScopeContext_namespaceObject=TeambitMdxUiMdxScopeContext;var dist=__webpack_require__(736),_excluded=["components"];function _extends(){return _extends=Object.assign?Object.assign.bind():function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source)Object.prototype.hasOwnProperty.call(source,key)&&(target[key]=source[key])}return target},_extends.apply(this,arguments)}function _objectWithoutProperties(source,excluded){if(source==null)return{};var target=_objectWithoutPropertiesLoose(source,excluded),key,i;if(Object.getOwnPropertySymbols){var sourceSymbolKeys=Object.getOwnPropertySymbols(source);for(i=0;i<sourceSymbolKeys.length;i++)key=sourceSymbolKeys[i],!(excluded.indexOf(key)>=0)&&(!Object.prototype.propertyIsEnumerable.call(source,key)||(target[key]=source[key]))}return target}function _objectWithoutPropertiesLoose(source,excluded){if(source==null)return{};var target={},sourceKeys=Object.keys(source),key,i;for(i=0;i<sourceKeys.length;i++)key=sourceKeys[i],!(excluded.indexOf(key)>=0)&&(target[key]=source[key]);return target}var layoutProps={},MDXLayout="wrapper";function MDXContent(_ref){var components=_ref.components,props=_objectWithoutProperties(_ref,_excluded);return(0,external_MdxJsReact_.mdx)(MDXLayout,_extends({},layoutProps,props,{components,mdxType:"MDXLayout"}),(0,external_MdxJsReact_.mdx)(external_TeambitMdxUiMdxScopeContext_namespaceObject.MDXScopeProvider,{components:{Generator:dist.Generator},mdxType:"MDXScopeProvider"},(0,external_MdxJsReact_.mdx)(dist.Generator,{mdxType:"Generator"})))}MDXContent.isMDXComponent=!0;var __bit_component={id:"teambit.generator/generator@6489e18b89a4a26b88b415fb314ab2af864f1df7",homepage:"https://bit.cloud/teambit/generator/generator",exported:!0};const compositions=[generator_composition],overview=[generator_docs_namespaceObject],compositions_metadata={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),__webpack_exports__})());

package/template-list.ts

@@ -0,0 +1,21 @@
+import { EnvContext, EnvHandler } from '@teambit/envs';
+import { ComponentTemplate } from './component-template';
+
+export type TemplateListOptions = {
+  name?: string;
+};
+
+export class TemplateList {
+  constructor(readonly name: string, private templates: EnvHandler<ComponentTemplate>[], private context: EnvContext) {}
+
+  compute(): ComponentTemplate[] {
+    return this.templates.map((template) => template(this.context));
+  }
+
+  static from(templates: EnvHandler<ComponentTemplate>[], options: TemplateListOptions = {}) {
+    return (context: EnvContext) => {
+      const name = options.name || 'template-list';
+      return new TemplateList(name, templates, context);
+    };
+  }
+}

package/templates/basic/basic.starter.ts

@@ -6,17 +6,22 @@ export const BasicWorkspaceStarter: Starter = {
   name: 'basic',
   description: 'a basic workspace',
   generateFiles: async (context: WorkspaceContext) => {
-    return [
+    const files = [
       {
         relativePath: 'workspace.jsonc',
         content: await workspaceConfig(context),
       },
-      {
+    ];
+
+    if (!context.skipGit) {
+      files.push({
         relativePath: '.gitignore',
         content: gitIgnore(),
-      },
-    ];
+      });
+    }
+
+    return files;
   },
 };
 
-export default BasicWorkspaceStarter;
+export default BasicWorkspaceStarter;

package/templates/basic/template/files/workspace-config.ts

@@ -3,11 +3,11 @@ import { WorkspaceContext } from '../../../..';
 
 export async function workspaceConfig({ name, defaultScope }: WorkspaceContext) {
   const configParsed = await getWorkspaceConfigTemplateParsed();
-  const packageManagerDefaultConfig = configParsed['teambit.dependencies/dependency-resolver'];
+  const dependencyResolverDefaultConfig = configParsed['teambit.dependencies/dependency-resolver'];
   configParsed['teambit.workspace/workspace'].name = name;
   configParsed['teambit.workspace/workspace'].defaultScope = defaultScope || 'org.scope';
   configParsed['teambit.dependencies/dependency-resolver'] = {
-    ...packageManagerDefaultConfig,
+    ...dependencyResolverDefaultConfig,
     policy: {
       dependencies: {
         '@teambit/node.node': 'latest',

package/templates/starter/files/starter.ts

@@ -25,6 +25,10 @@ export function starterFile({ namePascalCase, name }: ComponentContext) {
         },
       ];
     }
+
+    // import: () => [
+    //   { id: 'teambit.community/component-showcase' },
+    // ]
   
     static from(options: Partial<${namePascalCase}StarterOptions>) {
       return () =>
@@ -37,4 +41,4 @@ export function starterFile({ namePascalCase, name }: ComponentContext) {
   }
   
 `;
-}
+}

package/templates/starter/files/workspace-config-tpl.ts

@@ -3,20 +3,30 @@ export function workspaceConfigTemplate() {
 import { getWorkspaceConfigTemplateParsed, stringifyWorkspaceConfig } from '@teambit/config';
 
 export async function workspaceConfig({ name, defaultScope }: WorkspaceContext) {
-  const scope = defaultScope || 'org.scope';
   const configParsed = await getWorkspaceConfigTemplateParsed();
+  const packageManagerDefaultConfig = configParsed['teambit.dependencies/dependency-resolver'];
   configParsed['teambit.workspace/workspace'].name = name;
-  configParsed['teambit.workspace/workspace'].defaultScope = scope;
-  configParsed['teambit.generator/generator'] = {
-    envs: [
-     scope + '/react/react-env',
-    ],
-  };
-  configParsed['teambit.workspace/variants'] = {
-    '*': {},
+  configParsed['teambit.workspace/workspace'].defaultScope = defaultScope || 'org.scope';
+  configParsed['teambit.dependencies/dependency-resolver'] = {
+    ...packageManagerDefaultConfig,
+    policy: {
+      dependencies: {
+        '@teambit/node.node': 'latest',
+        '@types/node': '16.18.44',
+        '@types/jest': '29.5.4',
+        eslint: '7.32.0',
+        '@typescript-eslint/eslint-plugin': '5.62.0',
+        'eslint-import-resolver-node': '0.3.6',
+        'eslint-plugin-import': '2.22.1',
+        'eslint-plugin-jest': '24.1.5',
+        'eslint-plugin-jsx-a11y': '6.4.1',
+        'eslint-plugin-mdx': '1.17.1',
+        'eslint-plugin-react': '7.22.0',
+      },
+    },
   };
 
   return stringifyWorkspaceConfig(configParsed);
 }
 `;
-}
+}

package/templates/starter-standalone/files/starter.ts

@@ -28,8 +28,17 @@ export function starterFile({ namePascalCase, name }: ComponentContext) {
     import: () => [
       { id: 'teambit.community/component-showcase' },
     ]
+// you can also fork components
+//    fork: () => [
+//      {
+//        id: 'teambit.react/react-env-extension',
+//        targetName: 'envs/my-react-env',
+//      },
+//    ]
+
+
   };
   
   export default ${namePascalCase}WorkspaceStarter;
 `;
-}
+}

package/templates/starter-standalone/files/workspace-config-tpl.ts

@@ -4,19 +4,30 @@ import { getWorkspaceConfigTemplateParsed, stringifyWorkspaceConfig } from '@tea
 
 export async function workspaceConfig({ name, defaultScope }: WorkspaceContext) {
   const configParsed = await getWorkspaceConfigTemplateParsed();
+  const packageManagerDefaultConfig = configParsed['teambit.dependencies/dependency-resolver'];
   configParsed['teambit.workspace/workspace'].name = name;
   configParsed['teambit.workspace/workspace'].defaultScope = defaultScope || 'org.scope';
-  configParsed['teambit.generator/generator'] = {
-    envs: [
-      'teambit.react/react-env',
-      'teambit.node/node',
-    ],
-  };
-  configParsed['teambit.workspace/variants'] = {
-    '*': {},
+  configParsed['teambit.dependencies/dependency-resolver'] = {
+    ...packageManagerDefaultConfig,
+    policy: {
+      dependencies: {
+        '@teambit/node.node': 'latest',
+        '@types/node': '16.18.44',
+        '@types/jest': '29.5.4',
+        eslint: '7.32.0',
+        '@typescript-eslint/eslint-plugin': '5.62.0',
+        'eslint-import-resolver-node': '0.3.6',
+        'eslint-plugin-import': '2.22.1',
+        'eslint-plugin-jest': '24.1.5',
+        'eslint-plugin-jsx-a11y': '6.4.1',
+        'eslint-plugin-mdx': '1.17.1',
+        'eslint-plugin-react': '7.22.0',
+      },
+    },
   };
 
+
   return stringifyWorkspaceConfig(configParsed);
 }
 `;
-}
+}

package/templates.cmd.ts

@@ -0,0 +1,55 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import chalk from 'chalk';
+import { groupBy } from 'lodash';
+import { GeneratorMain, TemplateDescriptor } from './generator.main.runtime';
+
+export type TemplatesOptions = {
+  showAll?: boolean;
+  aspect?: string;
+};
+
+export class TemplatesCmd implements Command {
+  name = 'templates';
+  description = 'list available templates for "bit create" and "bit new"';
+  extendedDescription =
+    'list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)';
+  alias = '';
+  loader = true;
+  group = 'development';
+  options = [
+    ['s', 'show-all', 'show hidden templates'],
+    ['a', 'aspect <aspect-id>', 'show templates provided by the aspect-id'],
+  ] as CommandOptions;
+
+  constructor(private generator: GeneratorMain) {}
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async report(args: [], templatesOptions: TemplatesOptions) {
+    let results = await this.generator.listTemplates(templatesOptions);
+
+    // Make sure that we don't list hidden templates
+    if (!templatesOptions.showAll) {
+      results = results.filter((template) => !template.hidden);
+    }
+
+    const grouped = groupBy(results, 'aspectId');
+    const titleStr = this.generator.isRunningInsideWorkspace()
+      ? `The following template(s) are available with the command bit create:  \nExample - bit create <template-name> <component-name>`
+      : `The following template(s) are available with the command bit new: \nExample - bit new <template-name> <workspace-name>`;
+    const title = chalk.green(`\n${titleStr}\n`);
+    const templateOutput = (template: TemplateDescriptor) => {
+      const desc = template.description ? ` (${template.description})` : '';
+      return `    ${template.name}${chalk.dim(desc)}`;
+    };
+    const output = Object.keys(grouped)
+      .map((aspectId) => {
+        const names = grouped[aspectId].map(templateOutput).join('\n');
+        const groupTitle = grouped[aspectId][0].titlePrefix
+          ? `${grouped[aspectId][0].titlePrefix} (${aspectId})`
+          : aspectId;
+        return `${chalk.blue.bold(groupTitle)}\n${names}\n`;
+      })
+      .join('\n');
+    return title + output;
+  }
+}

package/types.ts

@@ -0,0 +1,3 @@
+export interface CreateExtConfig {
+  template: string;
+}

package/workspace-generator.ts

@@ -0,0 +1,205 @@
+import fs from 'fs-extra';
+import { loadBit } from '@teambit/bit';
+import { Harmony } from '@teambit/harmony';
+import { Component } from '@teambit/component';
+import execa from 'execa';
+import pMapSeries from 'p-map-series';
+import UIAspect, { UiMain } from '@teambit/ui';
+import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
+import { WorkspaceAspect, Workspace } from '@teambit/workspace';
+import ForkingAspect, { ForkingMain } from '@teambit/forking';
+import { init } from '@teambit/legacy/dist/api/consumer';
+import ImporterAspect, { ImporterMain } from '@teambit/importer';
+import { CompilerAspect, CompilerMain } from '@teambit/compiler';
+import getGitExecutablePath from '@teambit/legacy/dist/utils/git/git-executable';
+import GitNotFound from '@teambit/legacy/dist/utils/git/exceptions/git-not-found';
+import { resolve, join } from 'path';
+import { ComponentID } from '@teambit/component-id';
+import GitAspect, { GitMain } from '@teambit/git';
+import { InstallAspect, InstallMain } from '@teambit/install';
+import WorkspaceConfigFilesAspect, { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';
+// import { ComponentGenerator } from './component-generator';
+import { WorkspaceTemplate, WorkspaceContext } from './workspace-template';
+import { NewOptions } from './new.cmd';
+import { GeneratorAspect } from './generator.aspect';
+
+export type GenerateResult = { id: ComponentID; dir: string; files: string[]; envId: string };
+
+export class WorkspaceGenerator {
+  private workspacePath: string;
+  private harmony: Harmony;
+  private workspace: Workspace;
+  private install: InstallMain;
+  private importer: ImporterMain;
+  private logger?: Logger;
+  private forking: ForkingMain;
+  private git: GitMain;
+  private wsConfigFiles: WorkspaceConfigFilesMain;
+  // private componentGenerator?: ComponentGenerator;
+
+  constructor(
+    private workspaceName: string,
+    private options: NewOptions,
+    private template: WorkspaceTemplate,
+    private aspectComponent?: Component
+  ) {
+    this.workspacePath = resolve(this.workspaceName);
+  }
+
+  async generate(): Promise<string> {
+    if (fs.existsSync(this.workspacePath)) {
+      throw new Error(`unable to create a workspace at "${this.workspaceName}", this path already exist`);
+    }
+    await fs.ensureDir(this.workspacePath);
+    try {
+      process.chdir(this.workspacePath);
+      await this.initGit();
+      await init(this.workspacePath, this.options.skipGit, false, false, false, false, false, false, {});
+      await this.writeWorkspaceFiles();
+      await this.reloadBitInWorkspaceDir();
+      // Setting the workspace to be in install context to prevent errors during the workspace generation
+      // the workspace will be in install context until the end of the generation install process
+      this.workspace.inInstallContext = true;
+      await this.setupGitBitmapMergeDriver();
+      await this.forkComponentsFromRemote();
+      await this.importComponentsFromRemote();
+      await this.workspace.clearCache();
+      await this.install.install(undefined, {
+        dedupe: true,
+        import: false,
+        copyPeerToRuntimeOnRoot: true,
+        copyPeerToRuntimeOnComponents: false,
+        updateExisting: false,
+      });
+
+      // compile the components again now that we have the dependencies installed
+      await this.compileComponents(true);
+      await this.wsConfigFiles.writeConfigFiles({});
+    } catch (err: any) {
+      this.logger?.error(`failed generating a new workspace, will delete the dir ${this.workspacePath}`, err);
+      await fs.remove(this.workspacePath);
+      throw err;
+    }
+
+    return this.workspacePath;
+  }
+
+  private async initGit() {
+    if (this.options.skipGit) return;
+    const gitExecutablePath = getGitExecutablePath();
+    const params = ['init'];
+    try {
+      await execa(gitExecutablePath, params);
+    } catch (err: any) {
+      if (err.exitCodeName === 'ENOENT') {
+        throw new GitNotFound(gitExecutablePath, err);
+      }
+      throw err;
+    }
+  }
+
+  private async setupGitBitmapMergeDriver() {
+    if (this.options.skipGit) return;
+    await this.git.setGitMergeDriver({ global: false });
+  }
+
+  private async buildUI() {
+    const uiMain = this.harmony.get<UiMain>(UIAspect.id);
+    await uiMain.createRuntime({});
+  }
+
+  private getWorkspaceContext(): WorkspaceContext {
+    return {
+      name: this.workspaceName,
+      defaultScope: this.options.defaultScope,
+      empty: this.options.empty,
+      aspectComponent: this.aspectComponent,
+      template: this.template,
+      skipGit: this.options.skipGit,
+    };
+  }
+
+  /**
+   * writes the generated template files to the default directory set in the workspace config
+   */
+  private async writeWorkspaceFiles(): Promise<void> {
+    const workspaceContext = this.getWorkspaceContext();
+    const templateFiles = await this.template.generateFiles(workspaceContext);
+    await Promise.all(
+      templateFiles.map(async (templateFile) => {
+        await fs.outputFile(join(this.workspacePath, templateFile.relativePath), templateFile.content);
+      })
+    );
+  }
+
+  private async reloadBitInWorkspaceDir() {
+    this.harmony = await loadBit(this.workspacePath);
+    this.workspace = this.harmony.get<Workspace>(WorkspaceAspect.id);
+    this.install = this.harmony.get<InstallMain>(InstallAspect.id);
+    const loggerMain = this.harmony.get<LoggerMain>(LoggerAspect.id);
+    this.logger = loggerMain.createLogger(GeneratorAspect.id);
+    this.importer = this.harmony.get<ImporterMain>(ImporterAspect.id);
+    this.forking = this.harmony.get<ForkingMain>(ForkingAspect.id);
+    this.git = this.harmony.get<GitMain>(GitAspect.id);
+    this.wsConfigFiles = this.harmony.get<WorkspaceConfigFilesMain>(WorkspaceConfigFilesAspect.id);
+  }
+
+  // WIP
+  // private async createComponentsFromRemote() {
+  //   if (this.options.empty || !this.template.create) return
+  //   const workspaceContext = this.getWorkspaceContext();
+  //   const componentsToCreate = this.template.create(workspaceContext)
+  //   await pMapSeries(componentsToCreate, async (componentToCreate) => {
+  //     await ComponentGenerator.generate(componentToCreate);
+  //   });
+  // }
+
+  private async forkComponentsFromRemote() {
+    if (this.options.empty) return;
+    const workspaceContext = this.getWorkspaceContext();
+    const componentsToFork =
+      this.template?.importComponents?.(workspaceContext) || this.template?.fork?.(workspaceContext) || [];
+    if (!componentsToFork.length) return;
+    const componentsToForkRestructured = componentsToFork.map(({ id, targetName, path, env, config }) => ({
+      sourceId: id,
+      targetId: targetName,
+      path,
+      env,
+      config,
+    }));
+    await this.forking.forkMultipleFromRemote(componentsToForkRestructured, {
+      scope: this.workspace.defaultScope,
+      refactor: true,
+      install: false,
+    });
+  }
+
+  private async importComponentsFromRemote() {
+    if (this.options.empty) return;
+    const workspaceContext = this.getWorkspaceContext();
+    const componentsToImport = this.template?.import?.(workspaceContext) || [];
+
+    if (!componentsToImport.length) return;
+
+    await pMapSeries(componentsToImport, async (componentToImport) => {
+      await this.importer.import(
+        {
+          ids: [componentToImport.id],
+          installNpmPackages: false,
+          writeToPath: componentToImport.path,
+        },
+        []
+      );
+    });
+
+    await this.workspace.bitMap.write();
+  }
+
+  private async compileComponents(clearCache = true) {
+    if (clearCache) {
+      await this.workspace.clearCache();
+    }
+    const compiler = this.harmony.get<CompilerMain>(CompilerAspect.id);
+    await compiler.compileOnWorkspace();
+  }
+}