@teambit/generator 1.0.56 → 1.0.58

package/dist/component-generator.d.ts

@@ -15,6 +15,10 @@ export declare type GenerateResult = {
     envId: string;
     envSetBy: string;
     packageName: string;
+    isApp?: boolean;
+    isEnv?: boolean;
+    dependencies?: string[];
+    installMissingDependencies?: boolean;
 };
 export declare type OnComponentCreateFn = (generateResults: GenerateResult[]) => Promise<void>;
 export declare class ComponentGenerator {

package/dist/component-generator.js

@@ -207,6 +207,9 @@ class ComponentGenerator {
     });
     const component = await this.workspace.get(componentId);
     const hasEnvConfiguredOriginally = this.envs.hasEnvConfigured(component);
+    if (this.template.isApp) {
+      await this.workspace.use(componentId.toString());
+    }
     const envBeforeConfigChanges = this.envs.getEnv(component);
     let config = this.template.config;
     if (config && typeof config === 'function') {
@@ -266,7 +269,11 @@ class ComponentGenerator {
       files: addResults.files,
       packageName: (0, _componentIdToPackageName().default)(component.state._consumer),
       envId,
-      envSetBy: setBy
+      envSetBy: setBy,
+      isApp: this.template.isApp,
+      isEnv: this.template.isEnv,
+      dependencies: this.template.dependencies,
+      installMissingDependencies: this.template.installMissingDependencies
     };
   }
   async addEnvIfProvidedByFlag(config) {

package/dist/component-generator.js.map

@@ -1 +1 @@
-{"version":3,"names":["_vinyl","data","_interopRequireDefault","require","_fsExtra","_pMapSeries","_path","_envs","_camelcase","_bitError","_workspaceModules","_sources","_componentIdToPackageName","_dataToPersist","_componentId","obj","__esModule","default","ComponentGenerator","constructor","workspace","componentIds","options","template","envs","newComponentHelper","tracker","wsConfigFiles","logger","onComponentCreateSlot","aspectId","envId","generate","dirsToDeleteIfFailed","generateResults","pMapSeries","componentId","componentPath","getNewComponentPath","path","length","fs","existsSync","join","BitError","hasName","fullName","push","generateOneComponent","err","deleteGeneratedComponents","bitMap","write","ids","map","r","id","tryLinkToNodeModules","runOnComponentCreateHook","tryWriteConfigFiles","linkToNodeModulesByIds","consoleFailure","message","fns","values","Promise","all","fn","shouldWrite","isWorkspaceConfigWriteEnabled","clearComponentCache","writeConfigFiles","clean","silent","dedupe","throw","dirs","dir","absoluteDir","remove","code","_config","name","namePascalCase","camelcase","pascalCase","nameCamelCase","ComponentID","fromString","files","generateFiles","mainFile","find","file","isMain","writeComponentFiles","addResults","track","rootDir","relativePath","componentName","defaultScope","scope","component","get","hasEnvConfiguredOriginally","hasEnvConfigured","envBeforeConfigChanges","getEnv","config","_this$template$config","boundConfig","bind","isInWorkspace","exists","toStringWithoutVersion","toString","env","templateEnv","EnvsAspect","Object","keys","undefined","configWithEnv","addEnvIfProvidedByFlag","setEntireConfig","getEnvData","_config2","envFromFlag","envFromTemplate","setBy","packageName","componentIdToPackageName","state","_consumer","envSetBy","_config3","userEnv","addEnvToConfig","templateFiles","dataToPersist","DataToPersist","vinylFiles","templateFile","templateFileVinyl","Vinyl","base","contents","Buffer","from","content","AbstractVinyl","fromVinyl","results","v","addManyFiles","addBasePath","persistAllToFS","exports"],"sources":["component-generator.ts"],"sourcesContent":["import Vinyl from 'vinyl';\nimport fs from 'fs-extra';\nimport pMapSeries from 'p-map-series';\nimport path from 'path';\nimport { Workspace } from '@teambit/workspace';\nimport EnvsAspect, { EnvsMain } from '@teambit/envs';\nimport camelcase from 'camelcase';\nimport { BitError } from '@teambit/bit-error';\nimport { Logger } from '@teambit/logger';\nimport { TrackerMain } from '@teambit/tracker';\nimport { linkToNodeModulesByIds } from '@teambit/workspace.modules.node-modules-linker';\nimport { PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport componentIdToPackageName from '@teambit/legacy/dist/utils/bit/component-id-to-package-name';\nimport DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';\nimport { NewComponentHelperMain } from '@teambit/new-component-helper';\nimport { ComponentID } from '@teambit/component-id';\nimport { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';\n\nimport { ComponentTemplate, ComponentFile, ComponentConfig } from './component-template';\nimport { CreateOptions } from './create.cmd';\nimport { OnComponentCreateSlot } from './generator.main.runtime';\n\nexport type GenerateResult = {\n  id: ComponentID;\n  dir: string;\n  files: string[];\n  envId: string;\n  envSetBy: string;\n  packageName: string;\n};\n\nexport type OnComponentCreateFn = (generateResults: GenerateResult[]) => Promise<void>;\n\nexport class ComponentGenerator {\n  constructor(\n    private workspace: Workspace,\n    private componentIds: ComponentID[],\n    private options: Partial<CreateOptions>,\n    private template: ComponentTemplate,\n    private envs: EnvsMain,\n    private newComponentHelper: NewComponentHelperMain,\n    private tracker: TrackerMain,\n    private wsConfigFiles: WorkspaceConfigFilesMain,\n    private logger: Logger,\n    private onComponentCreateSlot: OnComponentCreateSlot,\n    private aspectId: string,\n    private envId?: ComponentID\n  ) {}\n\n  async generate(): Promise<GenerateResult[]> {\n    const dirsToDeleteIfFailed: string[] = [];\n    const generateResults = await pMapSeries(this.componentIds, async (componentId) => {\n      try {\n        const componentPath = this.newComponentHelper.getNewComponentPath(\n          componentId,\n          this.options.path,\n          this.componentIds.length\n        );\n        if (fs.existsSync(path.join(this.workspace.path, componentPath))) {\n          throw new BitError(`unable to create a component at \"${componentPath}\", this path already exist`);\n        }\n        if (await this.workspace.hasName(componentId.fullName)) {\n          throw new BitError(\n            `unable to create a component \"${componentId.fullName}\", a component with the same name already exist`\n          );\n        }\n        dirsToDeleteIfFailed.push(componentPath);\n        return await this.generateOneComponent(componentId, componentPath);\n      } catch (err: any) {\n        await this.deleteGeneratedComponents(dirsToDeleteIfFailed);\n        throw err;\n      }\n    });\n\n    await this.workspace.bitMap.write();\n\n    const ids = generateResults.map((r) => r.id);\n    await this.tryLinkToNodeModules(ids);\n    await this.runOnComponentCreateHook(generateResults);\n    // We are running this after the runOnComponentCreateHook as it require\n    // the env to be installed to work properly, and the hook might install\n    // the env.\n    await this.tryWriteConfigFiles(ids);\n\n    return generateResults;\n  }\n\n  private async tryLinkToNodeModules(ids: ComponentID[]) {\n    try {\n      await linkToNodeModulesByIds(\n        this.workspace,\n        ids.map((id) => id)\n      );\n    } catch (err: any) {\n      this.logger.consoleFailure(\n        `failed linking the new components to node_modules, please run \"bit link\" manually. error: ${err.message}`\n      );\n    }\n  }\n\n  private async runOnComponentCreateHook(generateResults: GenerateResult[]) {\n    const fns = this.onComponentCreateSlot.values();\n    if (!fns.length) return;\n    await Promise.all(fns.map((fn) => fn(generateResults)));\n  }\n\n  /**\n   * The function `tryWriteConfigFiles` attempts to write workspace config files, and if it fails, it logs an error\n   * message.\n   * @returns If the condition `!shouldWrite` is true, then nothing is being returned. Otherwise, if the `writeConfigFiles`\n   * function is successfully executed, nothing is being returned. If an error occurs during the execution of\n   * `writeConfigFiles`, an error message is being returned.\n   */\n  private async tryWriteConfigFiles(ids: ComponentID[]) {\n    const shouldWrite = this.wsConfigFiles.isWorkspaceConfigWriteEnabled();\n    if (!shouldWrite) return;\n    ids.map((id) => this.workspace.clearComponentCache(id));\n    const { err } = await this.wsConfigFiles.writeConfigFiles({\n      clean: true,\n      silent: true,\n      dedupe: true,\n      throw: false,\n    });\n    if (err) {\n      this.logger.consoleFailure(\n        `failed generating workspace config files, please run \"bit ws-config write\" manually. error: ${err.message}`\n      );\n    }\n  }\n\n  private async deleteGeneratedComponents(dirs: string[]) {\n    await Promise.all(\n      dirs.map(async (dir) => {\n        const absoluteDir = path.join(this.workspace.path, dir);\n        try {\n          await fs.remove(absoluteDir);\n        } catch (err: any) {\n          if (err.code !== 'ENOENT') {\n            // if not exist, it's fine\n            throw err;\n          }\n        }\n      })\n    );\n  }\n\n  private async generateOneComponent(componentId: ComponentID, componentPath: string): Promise<GenerateResult> {\n    const name = componentId.name;\n    const namePascalCase = camelcase(name, { pascalCase: true });\n    const nameCamelCase = camelcase(name);\n    const aspectId = ComponentID.fromString(this.aspectId);\n\n    const files = await this.template.generateFiles({\n      name,\n      namePascalCase,\n      nameCamelCase,\n      componentId,\n      aspectId,\n      envId: this.envId,\n    });\n    const mainFile = files.find((file) => file.isMain);\n    await this.writeComponentFiles(componentPath, files);\n    const addResults = await this.tracker.track({\n      rootDir: componentPath,\n      mainFile: mainFile?.relativePath,\n      componentName: componentId.fullName,\n      defaultScope: this.options.scope,\n    });\n    const component = await this.workspace.get(componentId);\n    const hasEnvConfiguredOriginally = this.envs.hasEnvConfigured(component);\n    const envBeforeConfigChanges = this.envs.getEnv(component);\n    let config = this.template.config;\n    if (config && typeof config === 'function') {\n      const boundConfig = this.template.config?.bind(this.template);\n      config = boundConfig({ aspectId: this.aspectId });\n    }\n\n    if (!config && this.envId) {\n      const isInWorkspace = this.workspace.exists(this.envId);\n      config = {\n        [isInWorkspace ? this.envId.toStringWithoutVersion() : this.envId.toString()]: {},\n        'teambit.envs/envs': {\n          env: this.envId.toStringWithoutVersion(),\n        },\n      };\n    }\n\n    const templateEnv = config?.[EnvsAspect.id]?.env;\n\n    if (config && templateEnv && hasEnvConfiguredOriginally) {\n      // remove the env we got from the template.\n      delete config[templateEnv];\n      delete config[EnvsAspect.id].env;\n      if (Object.keys(config[EnvsAspect.id]).length === 0) delete config[EnvsAspect.id];\n      if (Object.keys(config).length === 0) config = undefined;\n    }\n\n    const configWithEnv = await this.addEnvIfProvidedByFlag(config);\n    if (configWithEnv) this.workspace.bitMap.setEntireConfig(component.id, configWithEnv);\n\n    const getEnvData = () => {\n      const envFromFlag = this.options.env; // env entered by the user when running `bit create --env`\n      const envFromTemplate = config?.[EnvsAspect.id]?.env;\n      if (envFromFlag) {\n        return {\n          envId: envFromFlag,\n          setBy: '--env flag',\n        };\n      }\n      if (envFromTemplate) {\n        return {\n          envId: envFromTemplate,\n          setBy: 'template',\n        };\n      }\n      return {\n        envId: envBeforeConfigChanges.id,\n        setBy: hasEnvConfiguredOriginally ? 'workspace variants' : '<default>',\n      };\n    };\n    const { envId, setBy } = getEnvData();\n    return {\n      id: componentId,\n      dir: componentPath,\n      files: addResults.files,\n      packageName: componentIdToPackageName(component.state._consumer),\n      envId,\n      envSetBy: setBy,\n    };\n  }\n\n  private async addEnvIfProvidedByFlag(config?: ComponentConfig): Promise<ComponentConfig | undefined> {\n    const userEnv = this.options.env; // env entered by the user when running `bit create --env`\n    const templateEnv = config?.[EnvsAspect.id]?.env;\n    if (!userEnv || userEnv === templateEnv) {\n      return config;\n    }\n    config = config || {};\n    if (templateEnv) {\n      // the component template has an env and the user wants a different env.\n      delete config[templateEnv];\n    }\n    await this.tracker.addEnvToConfig(userEnv, config);\n\n    return config;\n  }\n\n  /**\n   * writes the generated template files to the default directory set in the workspace config\n   */\n  private async writeComponentFiles(\n    componentPath: string,\n    templateFiles: ComponentFile[]\n  ): Promise<PathOsBasedRelative[]> {\n    const dataToPersist = new DataToPersist();\n    const vinylFiles = templateFiles.map((templateFile) => {\n      const templateFileVinyl = new Vinyl({\n        base: componentPath,\n        path: path.join(componentPath, templateFile.relativePath),\n        contents: Buffer.from(templateFile.content),\n      });\n      return AbstractVinyl.fromVinyl(templateFileVinyl);\n    });\n    const results = vinylFiles.map((v) => v.path);\n    dataToPersist.addManyFiles(vinylFiles);\n    dataToPersist.addBasePath(this.workspace.path);\n    await dataToPersist.persistAllToFS();\n    return results;\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,YAAA;EAAA,MAAAJ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAE,WAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,MAAA;EAAA,MAAAL,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAG,KAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAM,MAAA;EAAA,MAAAN,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAI,KAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,UAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,SAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAS,kBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,iBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAU,SAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,0BAAA;EAAA,MAAAX,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAS,yBAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,eAAA;EAAA,MAAAZ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAU,cAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAa,aAAA;EAAA,MAAAb,IAAA,GAAAE,OAAA;EAAAW,YAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAoD,SAAAC,uBAAAa,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAkB7C,MAAMG,kBAAkB,CAAC;EAC9BC,WAAWA,CACDC,SAAoB,EACpBC,YAA2B,EAC3BC,OAA+B,EAC/BC,QAA2B,EAC3BC,IAAc,EACdC,kBAA0C,EAC1CC,OAAoB,EACpBC,aAAuC,EACvCC,MAAc,EACdC,qBAA4C,EAC5CC,QAAgB,EAChBC,KAAmB,EAC3B;IAAA,KAZQX,SAAoB,GAApBA,SAAoB;IAAA,KACpBC,YAA2B,GAA3BA,YAA2B;IAAA,KAC3BC,OAA+B,GAA/BA,OAA+B;IAAA,KAC/BC,QAA2B,GAA3BA,QAA2B;IAAA,KAC3BC,IAAc,GAAdA,IAAc;IAAA,KACdC,kBAA0C,GAA1CA,kBAA0C;IAAA,KAC1CC,OAAoB,GAApBA,OAAoB;IAAA,KACpBC,aAAuC,GAAvCA,aAAuC;IAAA,KACvCC,MAAc,GAAdA,MAAc;IAAA,KACdC,qBAA4C,GAA5CA,qBAA4C;IAAA,KAC5CC,QAAgB,GAAhBA,QAAgB;IAAA,KAChBC,KAAmB,GAAnBA,KAAmB;EAC1B;EAEH,MAAMC,QAAQA,CAAA,EAA8B;IAC1C,MAAMC,oBAA8B,GAAG,EAAE;IACzC,MAAMC,eAAe,GAAG,MAAM,IAAAC,qBAAU,EAAC,IAAI,CAACd,YAAY,EAAE,MAAOe,WAAW,IAAK;MACjF,IAAI;QACF,MAAMC,aAAa,GAAG,IAAI,CAACZ,kBAAkB,CAACa,mBAAmB,CAC/DF,WAAW,EACX,IAAI,CAACd,OAAO,CAACiB,IAAI,EACjB,IAAI,CAAClB,YAAY,CAACmB,MACpB,CAAC;QACD,IAAIC,kBAAE,CAACC,UAAU,CAACH,eAAI,CAACI,IAAI,CAAC,IAAI,CAACvB,SAAS,CAACmB,IAAI,EAAEF,aAAa,CAAC,CAAC,EAAE;UAChE,MAAM,KAAIO,oBAAQ,EAAE,oCAAmCP,aAAc,4BAA2B,CAAC;QACnG;QACA,IAAI,MAAM,IAAI,CAACjB,SAAS,CAACyB,OAAO,CAACT,WAAW,CAACU,QAAQ,CAAC,EAAE;UACtD,MAAM,KAAIF,oBAAQ,EACf,iCAAgCR,WAAW,CAACU,QAAS,iDACxD,CAAC;QACH;QACAb,oBAAoB,CAACc,IAAI,CAACV,aAAa,CAAC;QACxC,OAAO,MAAM,IAAI,CAACW,oBAAoB,CAACZ,WAAW,EAAEC,aAAa,CAAC;MACpE,CAAC,CAAC,OAAOY,GAAQ,EAAE;QACjB,MAAM,IAAI,CAACC,yBAAyB,CAACjB,oBAAoB,CAAC;QAC1D,MAAMgB,GAAG;MACX;IACF,CAAC,CAAC;IAEF,MAAM,IAAI,CAAC7B,SAAS,CAAC+B,MAAM,CAACC,KAAK,CAAC,CAAC;IAEnC,MAAMC,GAAG,GAAGnB,eAAe,CAACoB,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACC,EAAE,CAAC;IAC5C,MAAM,IAAI,CAACC,oBAAoB,CAACJ,GAAG,CAAC;IACpC,MAAM,IAAI,CAACK,wBAAwB,CAACxB,eAAe,CAAC;IACpD;IACA;IACA;IACA,MAAM,IAAI,CAACyB,mBAAmB,CAACN,GAAG,CAAC;IAEnC,OAAOnB,eAAe;EACxB;EAEA,MAAcuB,oBAAoBA,CAACJ,GAAkB,EAAE;IACrD,IAAI;MACF,MAAM,IAAAO,0CAAsB,EAC1B,IAAI,CAACxC,SAAS,EACdiC,GAAG,CAACC,GAAG,CAAEE,EAAE,IAAKA,EAAE,CACpB,CAAC;IACH,CAAC,CAAC,OAAOP,GAAQ,EAAE;MACjB,IAAI,CAACrB,MAAM,CAACiC,cAAc,CACvB,6FAA4FZ,GAAG,CAACa,OAAQ,EAC3G,CAAC;IACH;EACF;EAEA,MAAcJ,wBAAwBA,CAACxB,eAAiC,EAAE;IACxE,MAAM6B,GAAG,GAAG,IAAI,CAAClC,qBAAqB,CAACmC,MAAM,CAAC,CAAC;IAC/C,IAAI,CAACD,GAAG,CAACvB,MAAM,EAAE;IACjB,MAAMyB,OAAO,CAACC,GAAG,CAACH,GAAG,CAACT,GAAG,CAAEa,EAAE,IAAKA,EAAE,CAACjC,eAAe,CAAC,CAAC,CAAC;EACzD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAcyB,mBAAmBA,CAACN,GAAkB,EAAE;IACpD,MAAMe,WAAW,GAAG,IAAI,CAACzC,aAAa,CAAC0C,6BAA6B,CAAC,CAAC;IACtE,IAAI,CAACD,WAAW,EAAE;IAClBf,GAAG,CAACC,GAAG,CAAEE,EAAE,IAAK,IAAI,CAACpC,SAAS,CAACkD,mBAAmB,CAACd,EAAE,CAAC,CAAC;IACvD,MAAM;MAAEP;IAAI,CAAC,GAAG,MAAM,IAAI,CAACtB,aAAa,CAAC4C,gBAAgB,CAAC;MACxDC,KAAK,EAAE,IAAI;MACXC,MAAM,EAAE,IAAI;MACZC,MAAM,EAAE,IAAI;MACZC,KAAK,EAAE;IACT,CAAC,CAAC;IACF,IAAI1B,GAAG,EAAE;MACP,IAAI,CAACrB,MAAM,CAACiC,cAAc,CACvB,+FAA8FZ,GAAG,CAACa,OAAQ,EAC7G,CAAC;IACH;EACF;EAEA,MAAcZ,yBAAyBA,CAAC0B,IAAc,EAAE;IACtD,MAAMX,OAAO,CAACC,GAAG,CACfU,IAAI,CAACtB,GAAG,CAAC,MAAOuB,GAAG,IAAK;MACtB,MAAMC,WAAW,GAAGvC,eAAI,CAACI,IAAI,CAAC,IAAI,CAACvB,SAAS,CAACmB,IAAI,EAAEsC,GAAG,CAAC;MACvD,IAAI;QACF,MAAMpC,kBAAE,CAACsC,MAAM,CAACD,WAAW,CAAC;MAC9B,CAAC,CAAC,OAAO7B,GAAQ,EAAE;QACjB,IAAIA,GAAG,CAAC+B,IAAI,KAAK,QAAQ,EAAE;UACzB;UACA,MAAM/B,GAAG;QACX;MACF;IACF,CAAC,CACH,CAAC;EACH;EAEA,MAAcD,oBAAoBA,CAACZ,WAAwB,EAAEC,aAAqB,EAA2B;IAAA,IAAA4C,OAAA;IAC3G,MAAMC,IAAI,GAAG9C,WAAW,CAAC8C,IAAI;IAC7B,MAAMC,cAAc,GAAG,IAAAC,oBAAS,EAACF,IAAI,EAAE;MAAEG,UAAU,EAAE;IAAK,CAAC,CAAC;IAC5D,MAAMC,aAAa,GAAG,IAAAF,oBAAS,EAACF,IAAI,CAAC;IACrC,MAAMpD,QAAQ,GAAGyD,0BAAW,CAACC,UAAU,CAAC,IAAI,CAAC1D,QAAQ,CAAC;IAEtD,MAAM2D,KAAK,GAAG,MAAM,IAAI,CAAClE,QAAQ,CAACmE,aAAa,CAAC;MAC9CR,IAAI;MACJC,cAAc;MACdG,aAAa;MACblD,WAAW;MACXN,QAAQ;MACRC,KAAK,EAAE,IAAI,CAACA;IACd,CAAC,CAAC;IACF,MAAM4D,QAAQ,GAAGF,KAAK,CAACG,IAAI,CAAEC,IAAI,IAAKA,IAAI,CAACC,MAAM,CAAC;IAClD,MAAM,IAAI,CAACC,mBAAmB,CAAC1D,aAAa,EAAEoD,KAAK,CAAC;IACpD,MAAMO,UAAU,GAAG,MAAM,IAAI,CAACtE,OAAO,CAACuE,KAAK,CAAC;MAC1CC,OAAO,EAAE7D,aAAa;MACtBsD,QAAQ,EAAEA,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEQ,YAAY;MAChCC,aAAa,EAAEhE,WAAW,CAACU,QAAQ;MACnCuD,YAAY,EAAE,IAAI,CAAC/E,OAAO,CAACgF;IAC7B,CAAC,CAAC;IACF,MAAMC,SAAS,GAAG,MAAM,IAAI,CAACnF,SAAS,CAACoF,GAAG,CAACpE,WAAW,CAAC;IACvD,MAAMqE,0BAA0B,GAAG,IAAI,CAACjF,IAAI,CAACkF,gBAAgB,CAACH,SAAS,CAAC;IACxE,MAAMI,sBAAsB,GAAG,IAAI,CAACnF,IAAI,CAACoF,MAAM,CAACL,SAAS,CAAC;IAC1D,IAAIM,MAAM,GAAG,IAAI,CAACtF,QAAQ,CAACsF,MAAM;IACjC,IAAIA,MAAM,IAAI,OAAOA,MAAM,KAAK,UAAU,EAAE;MAAA,IAAAC,qBAAA;MAC1C,MAAMC,WAAW,IAAAD,qBAAA,GAAG,IAAI,CAACvF,QAAQ,CAACsF,MAAM,cAAAC,qBAAA,uBAApBA,qBAAA,CAAsBE,IAAI,CAAC,IAAI,CAACzF,QAAQ,CAAC;MAC7DsF,MAAM,GAAGE,WAAW,CAAC;QAAEjF,QAAQ,EAAE,IAAI,CAACA;MAAS,CAAC,CAAC;IACnD;IAEA,IAAI,CAAC+E,MAAM,IAAI,IAAI,CAAC9E,KAAK,EAAE;MACzB,MAAMkF,aAAa,GAAG,IAAI,CAAC7F,SAAS,CAAC8F,MAAM,CAAC,IAAI,CAACnF,KAAK,CAAC;MACvD8E,MAAM,GAAG;QACP,CAACI,aAAa,GAAG,IAAI,CAAClF,KAAK,CAACoF,sBAAsB,CAAC,CAAC,GAAG,IAAI,CAACpF,KAAK,CAACqF,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;QACjF,mBAAmB,EAAE;UACnBC,GAAG,EAAE,IAAI,CAACtF,KAAK,CAACoF,sBAAsB,CAAC;QACzC;MACF,CAAC;IACH;IAEA,MAAMG,WAAW,IAAArC,OAAA,GAAG4B,MAAM,cAAA5B,OAAA,gBAAAA,OAAA,GAANA,OAAA,CAASsC,eAAU,CAAC/D,EAAE,CAAC,cAAAyB,OAAA,uBAAvBA,OAAA,CAAyBoC,GAAG;IAEhD,IAAIR,MAAM,IAAIS,WAAW,IAAIb,0BAA0B,EAAE;MACvD;MACA,OAAOI,MAAM,CAACS,WAAW,CAAC;MAC1B,OAAOT,MAAM,CAACU,eAAU,CAAC/D,EAAE,CAAC,CAAC6D,GAAG;MAChC,IAAIG,MAAM,CAACC,IAAI,CAACZ,MAAM,CAACU,eAAU,CAAC/D,EAAE,CAAC,CAAC,CAAChB,MAAM,KAAK,CAAC,EAAE,OAAOqE,MAAM,CAACU,eAAU,CAAC/D,EAAE,CAAC;MACjF,IAAIgE,MAAM,CAACC,IAAI,CAACZ,MAAM,CAAC,CAACrE,MAAM,KAAK,CAAC,EAAEqE,MAAM,GAAGa,SAAS;IAC1D;IAEA,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACC,sBAAsB,CAACf,MAAM,CAAC;IAC/D,IAAIc,aAAa,EAAE,IAAI,CAACvG,SAAS,CAAC+B,MAAM,CAAC0E,eAAe,CAACtB,SAAS,CAAC/C,EAAE,EAAEmE,aAAa,CAAC;IAErF,MAAMG,UAAU,GAAGA,CAAA,KAAM;MAAA,IAAAC,QAAA;MACvB,MAAMC,WAAW,GAAG,IAAI,CAAC1G,OAAO,CAAC+F,GAAG,CAAC,CAAC;MACtC,MAAMY,eAAe,IAAAF,QAAA,GAAGlB,MAAM,cAAAkB,QAAA,gBAAAA,QAAA,GAANA,QAAA,CAASR,eAAU,CAAC/D,EAAE,CAAC,cAAAuE,QAAA,uBAAvBA,QAAA,CAAyBV,GAAG;MACpD,IAAIW,WAAW,EAAE;QACf,OAAO;UACLjG,KAAK,EAAEiG,WAAW;UAClBE,KAAK,EAAE;QACT,CAAC;MACH;MACA,IAAID,eAAe,EAAE;QACnB,OAAO;UACLlG,KAAK,EAAEkG,eAAe;UACtBC,KAAK,EAAE;QACT,CAAC;MACH;MACA,OAAO;QACLnG,KAAK,EAAE4E,sBAAsB,CAACnD,EAAE;QAChC0E,KAAK,EAAEzB,0BAA0B,GAAG,oBAAoB,GAAG;MAC7D,CAAC;IACH,CAAC;IACD,MAAM;MAAE1E,KAAK;MAAEmG;IAAM,CAAC,GAAGJ,UAAU,CAAC,CAAC;IACrC,OAAO;MACLtE,EAAE,EAAEpB,WAAW;MACfyC,GAAG,EAAExC,aAAa;MAClBoD,KAAK,EAAEO,UAAU,CAACP,KAAK;MACvB0C,WAAW,EAAE,IAAAC,mCAAwB,EAAC7B,SAAS,CAAC8B,KAAK,CAACC,SAAS,CAAC;MAChEvG,KAAK;MACLwG,QAAQ,EAAEL;IACZ,CAAC;EACH;EAEA,MAAcN,sBAAsBA,CAACf,MAAwB,EAAwC;IAAA,IAAA2B,QAAA;IACnG,MAAMC,OAAO,GAAG,IAAI,CAACnH,OAAO,CAAC+F,GAAG,CAAC,CAAC;IAClC,MAAMC,WAAW,IAAAkB,QAAA,GAAG3B,MAAM,cAAA2B,QAAA,gBAAAA,QAAA,GAANA,QAAA,CAASjB,eAAU,CAAC/D,EAAE,CAAC,cAAAgF,QAAA,uBAAvBA,QAAA,CAAyBnB,GAAG;IAChD,IAAI,CAACoB,OAAO,IAAIA,OAAO,KAAKnB,WAAW,EAAE;MACvC,OAAOT,MAAM;IACf;IACAA,MAAM,GAAGA,MAAM,IAAI,CAAC,CAAC;IACrB,IAAIS,WAAW,EAAE;MACf;MACA,OAAOT,MAAM,CAACS,WAAW,CAAC;IAC5B;IACA,MAAM,IAAI,CAAC5F,OAAO,CAACgH,cAAc,CAACD,OAAO,EAAE5B,MAAM,CAAC;IAElD,OAAOA,MAAM;EACf;;EAEA;AACF;AACA;EACE,MAAcd,mBAAmBA,CAC/B1D,aAAqB,EACrBsG,aAA8B,EACE;IAChC,MAAMC,aAAa,GAAG,KAAIC,wBAAa,EAAC,CAAC;IACzC,MAAMC,UAAU,GAAGH,aAAa,CAACrF,GAAG,CAAEyF,YAAY,IAAK;MACrD,MAAMC,iBAAiB,GAAG,KAAIC,gBAAK,EAAC;QAClCC,IAAI,EAAE7G,aAAa;QACnBE,IAAI,EAAEA,eAAI,CAACI,IAAI,CAACN,aAAa,EAAE0G,YAAY,CAAC5C,YAAY,CAAC;QACzDgD,QAAQ,EAAEC,MAAM,CAACC,IAAI,CAACN,YAAY,CAACO,OAAO;MAC5C,CAAC,CAAC;MACF,OAAOC,wBAAa,CAACC,SAAS,CAACR,iBAAiB,CAAC;IACnD,CAAC,CAAC;IACF,MAAMS,OAAO,GAAGX,UAAU,CAACxF,GAAG,CAAEoG,CAAC,IAAKA,CAAC,CAACnH,IAAI,CAAC;IAC7CqG,aAAa,CAACe,YAAY,CAACb,UAAU,CAAC;IACtCF,aAAa,CAACgB,WAAW,CAAC,IAAI,CAACxI,SAAS,CAACmB,IAAI,CAAC;IAC9C,MAAMqG,aAAa,CAACiB,cAAc,CAAC,CAAC;IACpC,OAAOJ,OAAO;EAChB;AACF;AAACK,OAAA,CAAA5I,kBAAA,GAAAA,kBAAA"}
+{"version":3,"names":["_vinyl","data","_interopRequireDefault","require","_fsExtra","_pMapSeries","_path","_envs","_camelcase","_bitError","_workspaceModules","_sources","_componentIdToPackageName","_dataToPersist","_componentId","obj","__esModule","default","ComponentGenerator","constructor","workspace","componentIds","options","template","envs","newComponentHelper","tracker","wsConfigFiles","logger","onComponentCreateSlot","aspectId","envId","generate","dirsToDeleteIfFailed","generateResults","pMapSeries","componentId","componentPath","getNewComponentPath","path","length","fs","existsSync","join","BitError","hasName","fullName","push","generateOneComponent","err","deleteGeneratedComponents","bitMap","write","ids","map","r","id","tryLinkToNodeModules","runOnComponentCreateHook","tryWriteConfigFiles","linkToNodeModulesByIds","consoleFailure","message","fns","values","Promise","all","fn","shouldWrite","isWorkspaceConfigWriteEnabled","clearComponentCache","writeConfigFiles","clean","silent","dedupe","throw","dirs","dir","absoluteDir","remove","code","_config","name","namePascalCase","camelcase","pascalCase","nameCamelCase","ComponentID","fromString","files","generateFiles","mainFile","find","file","isMain","writeComponentFiles","addResults","track","rootDir","relativePath","componentName","defaultScope","scope","component","get","hasEnvConfiguredOriginally","hasEnvConfigured","isApp","use","toString","envBeforeConfigChanges","getEnv","config","_this$template$config","boundConfig","bind","isInWorkspace","exists","toStringWithoutVersion","env","templateEnv","EnvsAspect","Object","keys","undefined","configWithEnv","addEnvIfProvidedByFlag","setEntireConfig","getEnvData","_config2","envFromFlag","envFromTemplate","setBy","packageName","componentIdToPackageName","state","_consumer","envSetBy","isEnv","dependencies","installMissingDependencies","_config3","userEnv","addEnvToConfig","templateFiles","dataToPersist","DataToPersist","vinylFiles","templateFile","templateFileVinyl","Vinyl","base","contents","Buffer","from","content","AbstractVinyl","fromVinyl","results","v","addManyFiles","addBasePath","persistAllToFS","exports"],"sources":["component-generator.ts"],"sourcesContent":["import Vinyl from 'vinyl';\nimport fs from 'fs-extra';\nimport pMapSeries from 'p-map-series';\nimport path from 'path';\nimport { Workspace } from '@teambit/workspace';\nimport EnvsAspect, { EnvsMain } from '@teambit/envs';\nimport camelcase from 'camelcase';\nimport { BitError } from '@teambit/bit-error';\nimport { Logger } from '@teambit/logger';\nimport { TrackerMain } from '@teambit/tracker';\nimport { linkToNodeModulesByIds } from '@teambit/workspace.modules.node-modules-linker';\nimport { PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport componentIdToPackageName from '@teambit/legacy/dist/utils/bit/component-id-to-package-name';\nimport DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';\nimport { NewComponentHelperMain } from '@teambit/new-component-helper';\nimport { ComponentID } from '@teambit/component-id';\nimport { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';\n\nimport { ComponentTemplate, ComponentFile, ComponentConfig } from './component-template';\nimport { CreateOptions } from './create.cmd';\nimport { OnComponentCreateSlot } from './generator.main.runtime';\n\nexport type GenerateResult = {\n  id: ComponentID;\n  dir: string;\n  files: string[];\n  envId: string;\n  envSetBy: string;\n  packageName: string;\n  isApp?: boolean;\n  isEnv?: boolean;\n  dependencies?: string[];\n  installMissingDependencies?: boolean;\n};\n\nexport type OnComponentCreateFn = (generateResults: GenerateResult[]) => Promise<void>;\n\nexport class ComponentGenerator {\n  constructor(\n    private workspace: Workspace,\n    private componentIds: ComponentID[],\n    private options: Partial<CreateOptions>,\n    private template: ComponentTemplate,\n    private envs: EnvsMain,\n    private newComponentHelper: NewComponentHelperMain,\n    private tracker: TrackerMain,\n    private wsConfigFiles: WorkspaceConfigFilesMain,\n    private logger: Logger,\n    private onComponentCreateSlot: OnComponentCreateSlot,\n    private aspectId: string,\n    private envId?: ComponentID\n  ) {}\n\n  async generate(): Promise<GenerateResult[]> {\n    const dirsToDeleteIfFailed: string[] = [];\n    const generateResults = await pMapSeries(this.componentIds, async (componentId) => {\n      try {\n        const componentPath = this.newComponentHelper.getNewComponentPath(\n          componentId,\n          this.options.path,\n          this.componentIds.length\n        );\n        if (fs.existsSync(path.join(this.workspace.path, componentPath))) {\n          throw new BitError(`unable to create a component at \"${componentPath}\", this path already exist`);\n        }\n        if (await this.workspace.hasName(componentId.fullName)) {\n          throw new BitError(\n            `unable to create a component \"${componentId.fullName}\", a component with the same name already exist`\n          );\n        }\n        dirsToDeleteIfFailed.push(componentPath);\n        return await this.generateOneComponent(componentId, componentPath);\n      } catch (err: any) {\n        await this.deleteGeneratedComponents(dirsToDeleteIfFailed);\n        throw err;\n      }\n    });\n\n    await this.workspace.bitMap.write();\n\n    const ids = generateResults.map((r) => r.id);\n    await this.tryLinkToNodeModules(ids);\n    await this.runOnComponentCreateHook(generateResults);\n    // We are running this after the runOnComponentCreateHook as it require\n    // the env to be installed to work properly, and the hook might install\n    // the env.\n    await this.tryWriteConfigFiles(ids);\n\n    return generateResults;\n  }\n\n  private async tryLinkToNodeModules(ids: ComponentID[]) {\n    try {\n      await linkToNodeModulesByIds(\n        this.workspace,\n        ids.map((id) => id)\n      );\n    } catch (err: any) {\n      this.logger.consoleFailure(\n        `failed linking the new components to node_modules, please run \"bit link\" manually. error: ${err.message}`\n      );\n    }\n  }\n\n  private async runOnComponentCreateHook(generateResults: GenerateResult[]) {\n    const fns = this.onComponentCreateSlot.values();\n    if (!fns.length) return;\n    await Promise.all(fns.map((fn) => fn(generateResults)));\n  }\n\n  /**\n   * The function `tryWriteConfigFiles` attempts to write workspace config files, and if it fails, it logs an error\n   * message.\n   * @returns If the condition `!shouldWrite` is true, then nothing is being returned. Otherwise, if the `writeConfigFiles`\n   * function is successfully executed, nothing is being returned. If an error occurs during the execution of\n   * `writeConfigFiles`, an error message is being returned.\n   */\n  private async tryWriteConfigFiles(ids: ComponentID[]) {\n    const shouldWrite = this.wsConfigFiles.isWorkspaceConfigWriteEnabled();\n    if (!shouldWrite) return;\n    ids.map((id) => this.workspace.clearComponentCache(id));\n    const { err } = await this.wsConfigFiles.writeConfigFiles({\n      clean: true,\n      silent: true,\n      dedupe: true,\n      throw: false,\n    });\n    if (err) {\n      this.logger.consoleFailure(\n        `failed generating workspace config files, please run \"bit ws-config write\" manually. error: ${err.message}`\n      );\n    }\n  }\n\n  private async deleteGeneratedComponents(dirs: string[]) {\n    await Promise.all(\n      dirs.map(async (dir) => {\n        const absoluteDir = path.join(this.workspace.path, dir);\n        try {\n          await fs.remove(absoluteDir);\n        } catch (err: any) {\n          if (err.code !== 'ENOENT') {\n            // if not exist, it's fine\n            throw err;\n          }\n        }\n      })\n    );\n  }\n\n  private async generateOneComponent(componentId: ComponentID, componentPath: string): Promise<GenerateResult> {\n    const name = componentId.name;\n    const namePascalCase = camelcase(name, { pascalCase: true });\n    const nameCamelCase = camelcase(name);\n    const aspectId = ComponentID.fromString(this.aspectId);\n\n    const files = await this.template.generateFiles({\n      name,\n      namePascalCase,\n      nameCamelCase,\n      componentId,\n      aspectId,\n      envId: this.envId,\n    });\n    const mainFile = files.find((file) => file.isMain);\n    await this.writeComponentFiles(componentPath, files);\n    const addResults = await this.tracker.track({\n      rootDir: componentPath,\n      mainFile: mainFile?.relativePath,\n      componentName: componentId.fullName,\n      defaultScope: this.options.scope,\n    });\n    const component = await this.workspace.get(componentId);\n    const hasEnvConfiguredOriginally = this.envs.hasEnvConfigured(component);\n    if (this.template.isApp) {\n      await this.workspace.use(componentId.toString());\n    }\n    const envBeforeConfigChanges = this.envs.getEnv(component);\n    let config = this.template.config;\n    if (config && typeof config === 'function') {\n      const boundConfig = this.template.config?.bind(this.template);\n      config = boundConfig({ aspectId: this.aspectId });\n    }\n\n    if (!config && this.envId) {\n      const isInWorkspace = this.workspace.exists(this.envId);\n      config = {\n        [isInWorkspace ? this.envId.toStringWithoutVersion() : this.envId.toString()]: {},\n        'teambit.envs/envs': {\n          env: this.envId.toStringWithoutVersion(),\n        },\n      };\n    }\n\n    const templateEnv = config?.[EnvsAspect.id]?.env;\n\n    if (config && templateEnv && hasEnvConfiguredOriginally) {\n      // remove the env we got from the template.\n      delete config[templateEnv];\n      delete config[EnvsAspect.id].env;\n      if (Object.keys(config[EnvsAspect.id]).length === 0) delete config[EnvsAspect.id];\n      if (Object.keys(config).length === 0) config = undefined;\n    }\n\n    const configWithEnv = await this.addEnvIfProvidedByFlag(config);\n    if (configWithEnv) this.workspace.bitMap.setEntireConfig(component.id, configWithEnv);\n\n    const getEnvData = () => {\n      const envFromFlag = this.options.env; // env entered by the user when running `bit create --env`\n      const envFromTemplate = config?.[EnvsAspect.id]?.env;\n      if (envFromFlag) {\n        return {\n          envId: envFromFlag,\n          setBy: '--env flag',\n        };\n      }\n      if (envFromTemplate) {\n        return {\n          envId: envFromTemplate,\n          setBy: 'template',\n        };\n      }\n      return {\n        envId: envBeforeConfigChanges.id,\n        setBy: hasEnvConfiguredOriginally ? 'workspace variants' : '<default>',\n      };\n    };\n    const { envId, setBy } = getEnvData();\n    return {\n      id: componentId,\n      dir: componentPath,\n      files: addResults.files,\n      packageName: componentIdToPackageName(component.state._consumer),\n      envId,\n      envSetBy: setBy,\n      isApp: this.template.isApp,\n      isEnv: this.template.isEnv,\n      dependencies: this.template.dependencies,\n      installMissingDependencies: this.template.installMissingDependencies,\n    };\n  }\n\n  private async addEnvIfProvidedByFlag(config?: ComponentConfig): Promise<ComponentConfig | undefined> {\n    const userEnv = this.options.env; // env entered by the user when running `bit create --env`\n    const templateEnv = config?.[EnvsAspect.id]?.env;\n    if (!userEnv || userEnv === templateEnv) {\n      return config;\n    }\n    config = config || {};\n    if (templateEnv) {\n      // the component template has an env and the user wants a different env.\n      delete config[templateEnv];\n    }\n    await this.tracker.addEnvToConfig(userEnv, config);\n\n    return config;\n  }\n\n  /**\n   * writes the generated template files to the default directory set in the workspace config\n   */\n  private async writeComponentFiles(\n    componentPath: string,\n    templateFiles: ComponentFile[]\n  ): Promise<PathOsBasedRelative[]> {\n    const dataToPersist = new DataToPersist();\n    const vinylFiles = templateFiles.map((templateFile) => {\n      const templateFileVinyl = new Vinyl({\n        base: componentPath,\n        path: path.join(componentPath, templateFile.relativePath),\n        contents: Buffer.from(templateFile.content),\n      });\n      return AbstractVinyl.fromVinyl(templateFileVinyl);\n    });\n    const results = vinylFiles.map((v) => v.path);\n    dataToPersist.addManyFiles(vinylFiles);\n    dataToPersist.addBasePath(this.workspace.path);\n    await dataToPersist.persistAllToFS();\n    return results;\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,YAAA;EAAA,MAAAJ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAE,WAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAK,MAAA;EAAA,MAAAL,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAG,KAAA,YAAAA,CAAA;IAAA,OAAAL,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAM,MAAA;EAAA,MAAAN,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAI,KAAA,YAAAA,CAAA;IAAA,OAAAN,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAO,WAAA;EAAA,MAAAP,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAK,UAAA,YAAAA,CAAA;IAAA,OAAAP,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAQ,UAAA;EAAA,MAAAR,IAAA,GAAAE,OAAA;EAAAM,SAAA,YAAAA,CAAA;IAAA,OAAAR,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGA,SAAAS,kBAAA;EAAA,MAAAT,IAAA,GAAAE,OAAA;EAAAO,iBAAA,YAAAA,CAAA;IAAA,OAAAT,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAU,SAAA;EAAA,MAAAV,IAAA,GAAAE,OAAA;EAAAQ,QAAA,YAAAA,CAAA;IAAA,OAAAV,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAW,0BAAA;EAAA,MAAAX,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAS,yBAAA,YAAAA,CAAA;IAAA,OAAAX,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAY,eAAA;EAAA,MAAAZ,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAU,cAAA,YAAAA,CAAA;IAAA,OAAAZ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAa,aAAA;EAAA,MAAAb,IAAA,GAAAE,OAAA;EAAAW,YAAA,YAAAA,CAAA;IAAA,OAAAb,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAoD,SAAAC,uBAAAa,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAsB7C,MAAMG,kBAAkB,CAAC;EAC9BC,WAAWA,CACDC,SAAoB,EACpBC,YAA2B,EAC3BC,OAA+B,EAC/BC,QAA2B,EAC3BC,IAAc,EACdC,kBAA0C,EAC1CC,OAAoB,EACpBC,aAAuC,EACvCC,MAAc,EACdC,qBAA4C,EAC5CC,QAAgB,EAChBC,KAAmB,EAC3B;IAAA,KAZQX,SAAoB,GAApBA,SAAoB;IAAA,KACpBC,YAA2B,GAA3BA,YAA2B;IAAA,KAC3BC,OAA+B,GAA/BA,OAA+B;IAAA,KAC/BC,QAA2B,GAA3BA,QAA2B;IAAA,KAC3BC,IAAc,GAAdA,IAAc;IAAA,KACdC,kBAA0C,GAA1CA,kBAA0C;IAAA,KAC1CC,OAAoB,GAApBA,OAAoB;IAAA,KACpBC,aAAuC,GAAvCA,aAAuC;IAAA,KACvCC,MAAc,GAAdA,MAAc;IAAA,KACdC,qBAA4C,GAA5CA,qBAA4C;IAAA,KAC5CC,QAAgB,GAAhBA,QAAgB;IAAA,KAChBC,KAAmB,GAAnBA,KAAmB;EAC1B;EAEH,MAAMC,QAAQA,CAAA,EAA8B;IAC1C,MAAMC,oBAA8B,GAAG,EAAE;IACzC,MAAMC,eAAe,GAAG,MAAM,IAAAC,qBAAU,EAAC,IAAI,CAACd,YAAY,EAAE,MAAOe,WAAW,IAAK;MACjF,IAAI;QACF,MAAMC,aAAa,GAAG,IAAI,CAACZ,kBAAkB,CAACa,mBAAmB,CAC/DF,WAAW,EACX,IAAI,CAACd,OAAO,CAACiB,IAAI,EACjB,IAAI,CAAClB,YAAY,CAACmB,MACpB,CAAC;QACD,IAAIC,kBAAE,CAACC,UAAU,CAACH,eAAI,CAACI,IAAI,CAAC,IAAI,CAACvB,SAAS,CAACmB,IAAI,EAAEF,aAAa,CAAC,CAAC,EAAE;UAChE,MAAM,KAAIO,oBAAQ,EAAE,oCAAmCP,aAAc,4BAA2B,CAAC;QACnG;QACA,IAAI,MAAM,IAAI,CAACjB,SAAS,CAACyB,OAAO,CAACT,WAAW,CAACU,QAAQ,CAAC,EAAE;UACtD,MAAM,KAAIF,oBAAQ,EACf,iCAAgCR,WAAW,CAACU,QAAS,iDACxD,CAAC;QACH;QACAb,oBAAoB,CAACc,IAAI,CAACV,aAAa,CAAC;QACxC,OAAO,MAAM,IAAI,CAACW,oBAAoB,CAACZ,WAAW,EAAEC,aAAa,CAAC;MACpE,CAAC,CAAC,OAAOY,GAAQ,EAAE;QACjB,MAAM,IAAI,CAACC,yBAAyB,CAACjB,oBAAoB,CAAC;QAC1D,MAAMgB,GAAG;MACX;IACF,CAAC,CAAC;IAEF,MAAM,IAAI,CAAC7B,SAAS,CAAC+B,MAAM,CAACC,KAAK,CAAC,CAAC;IAEnC,MAAMC,GAAG,GAAGnB,eAAe,CAACoB,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACC,EAAE,CAAC;IAC5C,MAAM,IAAI,CAACC,oBAAoB,CAACJ,GAAG,CAAC;IACpC,MAAM,IAAI,CAACK,wBAAwB,CAACxB,eAAe,CAAC;IACpD;IACA;IACA;IACA,MAAM,IAAI,CAACyB,mBAAmB,CAACN,GAAG,CAAC;IAEnC,OAAOnB,eAAe;EACxB;EAEA,MAAcuB,oBAAoBA,CAACJ,GAAkB,EAAE;IACrD,IAAI;MACF,MAAM,IAAAO,0CAAsB,EAC1B,IAAI,CAACxC,SAAS,EACdiC,GAAG,CAACC,GAAG,CAAEE,EAAE,IAAKA,EAAE,CACpB,CAAC;IACH,CAAC,CAAC,OAAOP,GAAQ,EAAE;MACjB,IAAI,CAACrB,MAAM,CAACiC,cAAc,CACvB,6FAA4FZ,GAAG,CAACa,OAAQ,EAC3G,CAAC;IACH;EACF;EAEA,MAAcJ,wBAAwBA,CAACxB,eAAiC,EAAE;IACxE,MAAM6B,GAAG,GAAG,IAAI,CAAClC,qBAAqB,CAACmC,MAAM,CAAC,CAAC;IAC/C,IAAI,CAACD,GAAG,CAACvB,MAAM,EAAE;IACjB,MAAMyB,OAAO,CAACC,GAAG,CAACH,GAAG,CAACT,GAAG,CAAEa,EAAE,IAAKA,EAAE,CAACjC,eAAe,CAAC,CAAC,CAAC;EACzD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAcyB,mBAAmBA,CAACN,GAAkB,EAAE;IACpD,MAAMe,WAAW,GAAG,IAAI,CAACzC,aAAa,CAAC0C,6BAA6B,CAAC,CAAC;IACtE,IAAI,CAACD,WAAW,EAAE;IAClBf,GAAG,CAACC,GAAG,CAAEE,EAAE,IAAK,IAAI,CAACpC,SAAS,CAACkD,mBAAmB,CAACd,EAAE,CAAC,CAAC;IACvD,MAAM;MAAEP;IAAI,CAAC,GAAG,MAAM,IAAI,CAACtB,aAAa,CAAC4C,gBAAgB,CAAC;MACxDC,KAAK,EAAE,IAAI;MACXC,MAAM,EAAE,IAAI;MACZC,MAAM,EAAE,IAAI;MACZC,KAAK,EAAE;IACT,CAAC,CAAC;IACF,IAAI1B,GAAG,EAAE;MACP,IAAI,CAACrB,MAAM,CAACiC,cAAc,CACvB,+FAA8FZ,GAAG,CAACa,OAAQ,EAC7G,CAAC;IACH;EACF;EAEA,MAAcZ,yBAAyBA,CAAC0B,IAAc,EAAE;IACtD,MAAMX,OAAO,CAACC,GAAG,CACfU,IAAI,CAACtB,GAAG,CAAC,MAAOuB,GAAG,IAAK;MACtB,MAAMC,WAAW,GAAGvC,eAAI,CAACI,IAAI,CAAC,IAAI,CAACvB,SAAS,CAACmB,IAAI,EAAEsC,GAAG,CAAC;MACvD,IAAI;QACF,MAAMpC,kBAAE,CAACsC,MAAM,CAACD,WAAW,CAAC;MAC9B,CAAC,CAAC,OAAO7B,GAAQ,EAAE;QACjB,IAAIA,GAAG,CAAC+B,IAAI,KAAK,QAAQ,EAAE;UACzB;UACA,MAAM/B,GAAG;QACX;MACF;IACF,CAAC,CACH,CAAC;EACH;EAEA,MAAcD,oBAAoBA,CAACZ,WAAwB,EAAEC,aAAqB,EAA2B;IAAA,IAAA4C,OAAA;IAC3G,MAAMC,IAAI,GAAG9C,WAAW,CAAC8C,IAAI;IAC7B,MAAMC,cAAc,GAAG,IAAAC,oBAAS,EAACF,IAAI,EAAE;MAAEG,UAAU,EAAE;IAAK,CAAC,CAAC;IAC5D,MAAMC,aAAa,GAAG,IAAAF,oBAAS,EAACF,IAAI,CAAC;IACrC,MAAMpD,QAAQ,GAAGyD,0BAAW,CAACC,UAAU,CAAC,IAAI,CAAC1D,QAAQ,CAAC;IAEtD,MAAM2D,KAAK,GAAG,MAAM,IAAI,CAAClE,QAAQ,CAACmE,aAAa,CAAC;MAC9CR,IAAI;MACJC,cAAc;MACdG,aAAa;MACblD,WAAW;MACXN,QAAQ;MACRC,KAAK,EAAE,IAAI,CAACA;IACd,CAAC,CAAC;IACF,MAAM4D,QAAQ,GAAGF,KAAK,CAACG,IAAI,CAAEC,IAAI,IAAKA,IAAI,CAACC,MAAM,CAAC;IAClD,MAAM,IAAI,CAACC,mBAAmB,CAAC1D,aAAa,EAAEoD,KAAK,CAAC;IACpD,MAAMO,UAAU,GAAG,MAAM,IAAI,CAACtE,OAAO,CAACuE,KAAK,CAAC;MAC1CC,OAAO,EAAE7D,aAAa;MACtBsD,QAAQ,EAAEA,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEQ,YAAY;MAChCC,aAAa,EAAEhE,WAAW,CAACU,QAAQ;MACnCuD,YAAY,EAAE,IAAI,CAAC/E,OAAO,CAACgF;IAC7B,CAAC,CAAC;IACF,MAAMC,SAAS,GAAG,MAAM,IAAI,CAACnF,SAAS,CAACoF,GAAG,CAACpE,WAAW,CAAC;IACvD,MAAMqE,0BAA0B,GAAG,IAAI,CAACjF,IAAI,CAACkF,gBAAgB,CAACH,SAAS,CAAC;IACxE,IAAI,IAAI,CAAChF,QAAQ,CAACoF,KAAK,EAAE;MACvB,MAAM,IAAI,CAACvF,SAAS,CAACwF,GAAG,CAACxE,WAAW,CAACyE,QAAQ,CAAC,CAAC,CAAC;IAClD;IACA,MAAMC,sBAAsB,GAAG,IAAI,CAACtF,IAAI,CAACuF,MAAM,CAACR,SAAS,CAAC;IAC1D,IAAIS,MAAM,GAAG,IAAI,CAACzF,QAAQ,CAACyF,MAAM;IACjC,IAAIA,MAAM,IAAI,OAAOA,MAAM,KAAK,UAAU,EAAE;MAAA,IAAAC,qBAAA;MAC1C,MAAMC,WAAW,IAAAD,qBAAA,GAAG,IAAI,CAAC1F,QAAQ,CAACyF,MAAM,cAAAC,qBAAA,uBAApBA,qBAAA,CAAsBE,IAAI,CAAC,IAAI,CAAC5F,QAAQ,CAAC;MAC7DyF,MAAM,GAAGE,WAAW,CAAC;QAAEpF,QAAQ,EAAE,IAAI,CAACA;MAAS,CAAC,CAAC;IACnD;IAEA,IAAI,CAACkF,MAAM,IAAI,IAAI,CAACjF,KAAK,EAAE;MACzB,MAAMqF,aAAa,GAAG,IAAI,CAAChG,SAAS,CAACiG,MAAM,CAAC,IAAI,CAACtF,KAAK,CAAC;MACvDiF,MAAM,GAAG;QACP,CAACI,aAAa,GAAG,IAAI,CAACrF,KAAK,CAACuF,sBAAsB,CAAC,CAAC,GAAG,IAAI,CAACvF,KAAK,CAAC8E,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;QACjF,mBAAmB,EAAE;UACnBU,GAAG,EAAE,IAAI,CAACxF,KAAK,CAACuF,sBAAsB,CAAC;QACzC;MACF,CAAC;IACH;IAEA,MAAME,WAAW,IAAAvC,OAAA,GAAG+B,MAAM,cAAA/B,OAAA,gBAAAA,OAAA,GAANA,OAAA,CAASwC,eAAU,CAACjE,EAAE,CAAC,cAAAyB,OAAA,uBAAvBA,OAAA,CAAyBsC,GAAG;IAEhD,IAAIP,MAAM,IAAIQ,WAAW,IAAIf,0BAA0B,EAAE;MACvD;MACA,OAAOO,MAAM,CAACQ,WAAW,CAAC;MAC1B,OAAOR,MAAM,CAACS,eAAU,CAACjE,EAAE,CAAC,CAAC+D,GAAG;MAChC,IAAIG,MAAM,CAACC,IAAI,CAACX,MAAM,CAACS,eAAU,CAACjE,EAAE,CAAC,CAAC,CAAChB,MAAM,KAAK,CAAC,EAAE,OAAOwE,MAAM,CAACS,eAAU,CAACjE,EAAE,CAAC;MACjF,IAAIkE,MAAM,CAACC,IAAI,CAACX,MAAM,CAAC,CAACxE,MAAM,KAAK,CAAC,EAAEwE,MAAM,GAAGY,SAAS;IAC1D;IAEA,MAAMC,aAAa,GAAG,MAAM,IAAI,CAACC,sBAAsB,CAACd,MAAM,CAAC;IAC/D,IAAIa,aAAa,EAAE,IAAI,CAACzG,SAAS,CAAC+B,MAAM,CAAC4E,eAAe,CAACxB,SAAS,CAAC/C,EAAE,EAAEqE,aAAa,CAAC;IAErF,MAAMG,UAAU,GAAGA,CAAA,KAAM;MAAA,IAAAC,QAAA;MACvB,MAAMC,WAAW,GAAG,IAAI,CAAC5G,OAAO,CAACiG,GAAG,CAAC,CAAC;MACtC,MAAMY,eAAe,IAAAF,QAAA,GAAGjB,MAAM,cAAAiB,QAAA,gBAAAA,QAAA,GAANA,QAAA,CAASR,eAAU,CAACjE,EAAE,CAAC,cAAAyE,QAAA,uBAAvBA,QAAA,CAAyBV,GAAG;MACpD,IAAIW,WAAW,EAAE;QACf,OAAO;UACLnG,KAAK,EAAEmG,WAAW;UAClBE,KAAK,EAAE;QACT,CAAC;MACH;MACA,IAAID,eAAe,EAAE;QACnB,OAAO;UACLpG,KAAK,EAAEoG,eAAe;UACtBC,KAAK,EAAE;QACT,CAAC;MACH;MACA,OAAO;QACLrG,KAAK,EAAE+E,sBAAsB,CAACtD,EAAE;QAChC4E,KAAK,EAAE3B,0BAA0B,GAAG,oBAAoB,GAAG;MAC7D,CAAC;IACH,CAAC;IACD,MAAM;MAAE1E,KAAK;MAAEqG;IAAM,CAAC,GAAGJ,UAAU,CAAC,CAAC;IACrC,OAAO;MACLxE,EAAE,EAAEpB,WAAW;MACfyC,GAAG,EAAExC,aAAa;MAClBoD,KAAK,EAAEO,UAAU,CAACP,KAAK;MACvB4C,WAAW,EAAE,IAAAC,mCAAwB,EAAC/B,SAAS,CAACgC,KAAK,CAACC,SAAS,CAAC;MAChEzG,KAAK;MACL0G,QAAQ,EAAEL,KAAK;MACfzB,KAAK,EAAE,IAAI,CAACpF,QAAQ,CAACoF,KAAK;MAC1B+B,KAAK,EAAE,IAAI,CAACnH,QAAQ,CAACmH,KAAK;MAC1BC,YAAY,EAAE,IAAI,CAACpH,QAAQ,CAACoH,YAAY;MACxCC,0BAA0B,EAAE,IAAI,CAACrH,QAAQ,CAACqH;IAC5C,CAAC;EACH;EAEA,MAAcd,sBAAsBA,CAACd,MAAwB,EAAwC;IAAA,IAAA6B,QAAA;IACnG,MAAMC,OAAO,GAAG,IAAI,CAACxH,OAAO,CAACiG,GAAG,CAAC,CAAC;IAClC,MAAMC,WAAW,IAAAqB,QAAA,GAAG7B,MAAM,cAAA6B,QAAA,gBAAAA,QAAA,GAANA,QAAA,CAASpB,eAAU,CAACjE,EAAE,CAAC,cAAAqF,QAAA,uBAAvBA,QAAA,CAAyBtB,GAAG;IAChD,IAAI,CAACuB,OAAO,IAAIA,OAAO,KAAKtB,WAAW,EAAE;MACvC,OAAOR,MAAM;IACf;IACAA,MAAM,GAAGA,MAAM,IAAI,CAAC,CAAC;IACrB,IAAIQ,WAAW,EAAE;MACf;MACA,OAAOR,MAAM,CAACQ,WAAW,CAAC;IAC5B;IACA,MAAM,IAAI,CAAC9F,OAAO,CAACqH,cAAc,CAACD,OAAO,EAAE9B,MAAM,CAAC;IAElD,OAAOA,MAAM;EACf;;EAEA;AACF;AACA;EACE,MAAcjB,mBAAmBA,CAC/B1D,aAAqB,EACrB2G,aAA8B,EACE;IAChC,MAAMC,aAAa,GAAG,KAAIC,wBAAa,EAAC,CAAC;IACzC,MAAMC,UAAU,GAAGH,aAAa,CAAC1F,GAAG,CAAE8F,YAAY,IAAK;MACrD,MAAMC,iBAAiB,GAAG,KAAIC,gBAAK,EAAC;QAClCC,IAAI,EAAElH,aAAa;QACnBE,IAAI,EAAEA,eAAI,CAACI,IAAI,CAACN,aAAa,EAAE+G,YAAY,CAACjD,YAAY,CAAC;QACzDqD,QAAQ,EAAEC,MAAM,CAACC,IAAI,CAACN,YAAY,CAACO,OAAO;MAC5C,CAAC,CAAC;MACF,OAAOC,wBAAa,CAACC,SAAS,CAACR,iBAAiB,CAAC;IACnD,CAAC,CAAC;IACF,MAAMS,OAAO,GAAGX,UAAU,CAAC7F,GAAG,CAAEyG,CAAC,IAAKA,CAAC,CAACxH,IAAI,CAAC;IAC7C0G,aAAa,CAACe,YAAY,CAACb,UAAU,CAAC;IACtCF,aAAa,CAACgB,WAAW,CAAC,IAAI,CAAC7I,SAAS,CAACmB,IAAI,CAAC;IAC9C,MAAM0G,aAAa,CAACiB,cAAc,CAAC,CAAC;IACpC,OAAOJ,OAAO;EAChB;AACF;AAACK,OAAA,CAAAjJ,kBAAA,GAAAA,kBAAA"}

package/dist/component-template.d.ts

@@ -87,9 +87,31 @@ export interface ComponentTemplateOptions {
      */
     hidden?: boolean;
     /**
-     * env to use for the component.
+     * env to use for the generated component.
      */
     env?: string;
+    /**
+     * adds a metadata that the component that this template creates is of type env.
+     * This will be used later to do further configuration for example:
+     * - ensure to create the .bit_root for it
+     */
+    isEnv?: boolean;
+    /**
+     * adds a metadata that the component that this template creates is of type app.
+     * This will be used later to do further configuration for example:
+     * - add it to the workspace.jsonc as app
+     * - ensure to create the .bit_root for it
+     */
+    isApp?: boolean;
+    /**
+     * list of dependencies to install when the component is created.
+     */
+    dependencies?: string[];
+    /**
+     * Perform installation of missing dependencies after component generation.
+     * This is the same as of running `bit install --add-missing-deps` after component generation.
+     */
+    installMissingDependencies?: boolean;
 }
 export interface ComponentTemplate extends ComponentTemplateOptions {
     name: string;

package/dist/component-template.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["component-template.ts"],"sourcesContent":["import { ComponentID } from '@teambit/component';\n\n/**\n * BaseComponentTemplateOptions describes the foundational properties for components.\n */\nexport interface BaseComponentTemplateOptions {\n  /**\n   * component-name as entered by the user, e.g. `use-date`.\n   * without the scope and the namespace.\n   */\n  name: string;\n\n  /**\n   * component-name as upper camel case, e.g. `use-date` becomes `UseDate`.\n   * useful when generating the file content, for example for a class name.\n   */\n  namePascalCase: string;\n\n  /**\n   * component-name as lower camel case, e.g. `use-date` becomes `useDate`.\n   * useful when generating the file content, for example for a function/variable name.\n   */\n  nameCamelCase: string;\n\n  /**\n   * component id.\n   * the name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope\n   */\n  componentId: ComponentID;\n\n  /**\n   * aspect id of the aspect that register the template itself\n   */\n  aspectId: ComponentID | string;\n\n  /**\n   * env id of the env that register the template itself.\n   * This will be usually identical to the aspectId but aspectId will always exist,\n   * while envId will be undefined if the template is not registered by an env.\n   */\n  envId?: ComponentID;\n\n  /**\n   * path of the component.\n   */\n  path?: string;\n  /**\n   * scope of the component.\n   */\n  scope?: string;\n  /**\n   * namespace of the component.\n   */\n  namespace?: string;\n}\n\n/**\n * ComponentContext represents foundational properties for a component context.\n */\nexport type ComponentContext = BaseComponentTemplateOptions;\n\nexport interface ComponentFile {\n  /**\n   * relative path of the file within the component.\n   */\n  relativePath: string;\n\n  /**\n   * file content\n   */\n  content: string;\n\n  /**\n   * whether this file will be tracked as the main file\n   */\n  isMain?: boolean;\n}\n\nexport interface ConfigContext {\n  /**\n   * Aspect id of the aspect that register the template itself\n   */\n  aspectId: string;\n}\n\nexport type ComponentConfig = { [aspectName: string]: any };\n\nexport interface ComponentTemplateOptions {\n  /**\n   * name of the component template. for example: `hook`, `react-component` or `module`.\n   */\n  name?: string;\n\n  /**\n   * short description of the template. shown in the `bit templates` command.\n   */\n  description?: string;\n\n  /**\n   * hide this template so that it is not listed with `bit templates`\n   */\n  hidden?: boolean;\n\n  /**\n   * env to use for the component.\n   */\n  env?: string;\n}\n\nexport interface ComponentTemplate extends ComponentTemplateOptions {\n  name: string;\n\n  /**\n   * template function for generating the file of a certain component.,\n   */\n  generateFiles(context: ComponentContext): Promise<ComponentFile[]> | ComponentFile[];\n\n  /**\n   * component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\n   * for example, you can set the env that will be used for this component as follows:\n   * \"teambit.envs/envs\": {\n   *    \"env\": \"teambit.harmony/aspect\"\n   * },\n   */\n  config?: ComponentConfig | ((context: ConfigContext) => ComponentConfig);\n}\n"],"mappings":""}
+{"version":3,"names":[],"sources":["component-template.ts"],"sourcesContent":["import { ComponentID } from '@teambit/component';\n\n/**\n * BaseComponentTemplateOptions describes the foundational properties for components.\n */\nexport interface BaseComponentTemplateOptions {\n  /**\n   * component-name as entered by the user, e.g. `use-date`.\n   * without the scope and the namespace.\n   */\n  name: string;\n\n  /**\n   * component-name as upper camel case, e.g. `use-date` becomes `UseDate`.\n   * useful when generating the file content, for example for a class name.\n   */\n  namePascalCase: string;\n\n  /**\n   * component-name as lower camel case, e.g. `use-date` becomes `useDate`.\n   * useful when generating the file content, for example for a function/variable name.\n   */\n  nameCamelCase: string;\n\n  /**\n   * component id.\n   * the name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope\n   */\n  componentId: ComponentID;\n\n  /**\n   * aspect id of the aspect that register the template itself\n   */\n  aspectId: ComponentID | string;\n\n  /**\n   * env id of the env that register the template itself.\n   * This will be usually identical to the aspectId but aspectId will always exist,\n   * while envId will be undefined if the template is not registered by an env.\n   */\n  envId?: ComponentID;\n\n  /**\n   * path of the component.\n   */\n  path?: string;\n  /**\n   * scope of the component.\n   */\n  scope?: string;\n  /**\n   * namespace of the component.\n   */\n  namespace?: string;\n}\n\n/**\n * ComponentContext represents foundational properties for a component context.\n */\nexport type ComponentContext = BaseComponentTemplateOptions;\n\nexport interface ComponentFile {\n  /**\n   * relative path of the file within the component.\n   */\n  relativePath: string;\n\n  /**\n   * file content\n   */\n  content: string;\n\n  /**\n   * whether this file will be tracked as the main file\n   */\n  isMain?: boolean;\n}\n\nexport interface ConfigContext {\n  /**\n   * Aspect id of the aspect that register the template itself\n   */\n  aspectId: string;\n}\n\nexport type ComponentConfig = { [aspectName: string]: any };\n\nexport interface ComponentTemplateOptions {\n  /**\n   * name of the component template. for example: `hook`, `react-component` or `module`.\n   */\n  name?: string;\n\n  /**\n   * short description of the template. shown in the `bit templates` command.\n   */\n  description?: string;\n\n  /**\n   * hide this template so that it is not listed with `bit templates`\n   */\n  hidden?: boolean;\n\n  /**\n   * env to use for the generated component.\n   */\n  env?: string;\n\n  /**\n   * adds a metadata that the component that this template creates is of type env.\n   * This will be used later to do further configuration for example:\n   * - ensure to create the .bit_root for it\n   */\n  isEnv?: boolean;\n\n  /**\n   * adds a metadata that the component that this template creates is of type app.\n   * This will be used later to do further configuration for example:\n   * - add it to the workspace.jsonc as app\n   * - ensure to create the .bit_root for it\n   */\n  isApp?: boolean;\n\n  /**\n   * list of dependencies to install when the component is created.\n   */\n  dependencies?: string[];\n\n  /**\n   * Perform installation of missing dependencies after component generation.\n   * This is the same as of running `bit install --add-missing-deps` after component generation.\n   */\n  installMissingDependencies?: boolean;\n}\n\nexport interface ComponentTemplate extends ComponentTemplateOptions {\n  name: string;\n\n  /**\n   * template function for generating the file of a certain component.,\n   */\n  generateFiles(context: ComponentContext): Promise<ComponentFile[]> | ComponentFile[];\n\n  /**\n   * component config. gets saved in the .bitmap file and it overrides the workspace.jsonc config.\n   * for example, you can set the env that will be used for this component as follows:\n   * \"teambit.envs/envs\": {\n   *    \"env\": \"teambit.harmony/aspect\"\n   * },\n   */\n  config?: ComponentConfig | ((context: ConfigContext) => ComponentConfig);\n}\n"],"mappings":""}

package/dist/{preview-1700063442591.js → preview-1700191066658.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.generator_generator@1.0.56/dist/generator.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.generator_generator@1.0.56/dist/generator.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.generator_generator@1.0.58/dist/generator.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.generator_generator@1.0.58/dist/generator.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/generator",
-  "version": "1.0.56",
+  "version": "1.0.58",
   "homepage": "https://bit.cloud/teambit/generator/generator",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.generator",
     "name": "generator",
-    "version": "1.0.56"
+    "version": "1.0.58"
   },
   "dependencies": {
     "camelcase": "6.2.0",
@@ -22,25 +22,25 @@
     "@teambit/bit-error": "0.0.404",
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/envs": "1.0.55",
-    "@teambit/logger": "0.0.908",
-    "@teambit/new-component-helper": "1.0.55",
-    "@teambit/tracker": "1.0.55",
-    "@teambit/workspace-config-files": "1.0.55",
+    "@teambit/envs": "1.0.57",
+    "@teambit/logger": "0.0.910",
+    "@teambit/new-component-helper": "1.0.57",
+    "@teambit/tracker": "1.0.57",
+    "@teambit/workspace-config-files": "1.0.57",
     "@teambit/workspace.modules.node-modules-linker": "0.0.151",
-    "@teambit/workspace": "1.0.55",
-    "@teambit/component": "1.0.55",
-    "@teambit/cli": "0.0.815",
-    "@teambit/graphql": "1.0.55",
-    "@teambit/aspect-loader": "1.0.55",
-    "@teambit/bit": "1.3.24",
-    "@teambit/git": "1.0.55",
-    "@teambit/compiler": "1.0.55",
-    "@teambit/forking": "1.0.55",
-    "@teambit/importer": "1.0.55",
-    "@teambit/install": "1.0.55",
-    "@teambit/ui": "1.0.55",
-    "@teambit/config": "0.0.831"
+    "@teambit/workspace": "1.0.57",
+    "@teambit/component": "1.0.57",
+    "@teambit/cli": "0.0.817",
+    "@teambit/graphql": "1.0.57",
+    "@teambit/aspect-loader": "1.0.57",
+    "@teambit/bit": "1.3.26",
+    "@teambit/git": "1.0.57",
+    "@teambit/compiler": "1.0.57",
+    "@teambit/forking": "1.0.57",
+    "@teambit/importer": "1.0.57",
+    "@teambit/install": "1.0.57",
+    "@teambit/ui": "1.0.57",
+    "@teambit/config": "0.0.833"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -54,7 +54,7 @@
     "@teambit/generator.aspect-docs.generator": "0.0.169"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.598",
+    "@teambit/legacy": "1.0.600",
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },