@teambit/generator 0.0.551 → 0.0.556

package/dist/component-generator.d.ts

@@ -19,6 +19,9 @@ export declare class ComponentGenerator {
     generate(): Promise<GenerateResult[]>;
     private deleteGeneratedComponents;
     private generateOneComponent;
+    /**
+     * writes the generated template files to the default directory set in the workspace config
+     */
     private writeComponentFiles;
     private getComponentPath;
 }

package/dist/component-template.d.ts

@@ -1,18 +1,55 @@
 import { ComponentID } from '@teambit/component-id';
 export interface ComponentFile {
+    /**
+     * relative path of the file within the component.
+     */
     relativePath: string;
+    /**
+     * file content
+     */
     content: string;
+    /**
+     * whether this file will be tracked as the main file
+     */
     isMain?: boolean;
 }
 export interface ComponentContext {
+    /**
+     * component-name as entered by the user, e.g. `use-date`.
+     * without the scope and the namespace.
+     */
     name: string;
+    /**
+     * component-name as upper camel case, e.g. `use-date` becomes `UseDate`.
+     * useful when generating the file content, for example for a class name.
+     */
     namePascalCase: string;
+    /**
+     * component-name as lower camel case, e.g. `use-date` becomes `useDate`.
+     * useful when generating the file content, for example for a function/variable name.
+     */
     nameCamelCase: string;
+    /**
+     * component id.
+     * the name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope
+     */
     componentId: ComponentID;
 }
 export interface ComponentTemplate {
+    /**
+     * name of the component template. for example: `hook`, `react-component` or `module`.
+     */
     name: string;
+    /**
+     * short description of the template. shown in the `bit templates` command.
+     */
     description?: string;
+    /**
+     * hide this template so that it is not listed with `bit templates`
+     */
     hidden?: boolean;
+    /**
+     * template function for generating the file of a certain component.,
+     */
     generateFiles(context: ComponentContext): ComponentFile[];
 }

package/dist/generator.main.runtime.d.ts

@@ -19,6 +19,9 @@ export declare type TemplateDescriptor = {
     hidden?: boolean;
 };
 export declare type GeneratorConfig = {
+    /**
+     * array of aspects to include in the list of templates.
+     */
     aspects: string[];
 };
 export declare class GeneratorMain {
@@ -30,15 +33,41 @@ export declare class GeneratorMain {
     private aspectLoader;
     private aspectLoaded;
     constructor(componentTemplateSlot: ComponentTemplateSlot, workspaceTemplateSlot: WorkspaceTemplateSlot, config: GeneratorConfig, workspace: Workspace, envs: EnvsMain, aspectLoader: AspectLoaderMain);
+    /**
+     * register a new component template.
+     */
     registerComponentTemplate(templates: ComponentTemplate[]): this;
+    /**
+     * register a new component template.
+     */
     registerWorkspaceTemplate(templates: WorkspaceTemplate[]): this;
+    /**
+     * list all component templates registered in the workspace or workspace templates in case the
+     * workspace is not available
+     */
     listTemplates(): Promise<TemplateDescriptor[]>;
+    /**
+     * @deprecated use this.listTemplates()
+     */
     listComponentTemplates(): Promise<TemplateDescriptor[]>;
     isRunningInsideWorkspace(): boolean;
+    /**
+     * get all component templates registered by a specific aspect ID.
+     */
     getComponentTemplateByAspect(aspectId: string): ComponentTemplate[];
+    /**
+     * returns a specific component template.
+     */
     getComponentTemplate(name: string, aspectId?: string): ComponentTemplate | undefined;
+    /**
+     * in the case the aspect-id is given and this aspect doesn't exist locally, import it to the
+     * global scope and load it from the capsule
+     */
     findTemplateInGlobalScope(aspectId: string, name?: string): Promise<WorkspaceTemplate | undefined>;
     findTemplateInOtherWorkspace(workspacePath: string, name: string, aspectId?: string): Promise<WorkspaceTemplate | undefined>;
+    /**
+     * returns a specific workspace template.
+     */
     getWorkspaceTemplate(name: string, aspectId?: string): Promise<{
         workspaceTemplate: WorkspaceTemplate;
         aspect?: Component;

package/dist/workspace-generator.d.ts

@@ -21,6 +21,9 @@ export declare class WorkspaceGenerator {
     generate(): Promise<string>;
     private initGit;
     private buildUI;
+    /**
+     * writes the generated template files to the default directory set in the workspace config
+     */
     private writeWorkspaceFiles;
     private reloadBitInWorkspaceDir;
     private addComponentsFromRemote;

package/dist/workspace-template.d.ts

@@ -1,23 +1,68 @@
 import type { Component } from '@teambit/component';
 export interface WorkspaceFile {
+    /**
+     * relative path of the file within the workspace.
+     */
     relativePath: string;
+    /**
+     * file content
+     */
     content: string;
 }
 export interface WorkspaceContext {
+    /**
+     * workspace-name as entered by the user, e.g. `react-app`.
+     * it is used as the directory name for the workspace.
+     */
     name: string;
+    /**
+     * default scope as entered by the user.
+     * it will be set in the workspace.jsonc and be used for components
+     */
     defaultScope?: string;
+    /**
+     * whether user entered `--empty` flag in `bit new` to avoid creating components.
+     */
     empty?: boolean;
+    /**
+     * in case the "--aspect" flag used to import a remote aspect, this is populated with that aspect.
+     * useful to get the aspect-id and other info.
+     */
     aspectComponent?: Component;
 }
 export interface ComponentToImport {
+    /**
+     * full component id
+     */
     id: string;
+    /**
+     * path where to write the component
+     */
     path: string;
+    /**
+     * a new component name. if not specified, use the original id (without the scope)
+     */
     targetName?: string;
 }
 export interface WorkspaceTemplate {
+    /**
+     * name of the workspace template. for example: `react-workspace`.
+     */
     name: string;
+    /**
+     * short description of the template. shown in the `bit templates` command when outside of bit-workspace.
+     */
     description?: string;
+    /**
+     * hide this template so that it is not listed with `bit templates`
+     */
     hidden?: boolean;
+    /**
+     * template function for generating the template files,
+     */
     generateFiles(context: WorkspaceContext): Promise<WorkspaceFile[]>;
+    /**
+     * populate existing components into the new workspace and add them as new components
+     */
     importComponents?: () => ComponentToImport[];
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/generator",
-  "version": "0.0.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/generator/generator",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.generator",
     "name": "generator",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "dependencies": {
     "camelcase": "6.2.0",
@@ -21,21 +21,21 @@
     "isbinaryfile": "4.0.6",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/bit-error": "0.0.368",
-    "@teambit/component-id": "0.0.372",
-    "@teambit/envs": "0.0.551",
-    "@teambit/workspace": "0.0.551",
-    "@teambit/cli": "0.0.382",
-    "@teambit/graphql": "0.0.551",
-    "@teambit/aspect-loader": "0.0.551",
-    "@teambit/bit": "0.0.553",
-    "@teambit/component": "0.0.551",
-    "@teambit/legacy-bit-id": "0.0.371",
-    "@teambit/compiler": "0.0.551",
-    "@teambit/dependency-resolver": "0.0.551",
-    "@teambit/logger": "0.0.467",
-    "@teambit/pkg": "0.0.551",
-    "@teambit/ui": "0.0.551"
+    "@teambit/bit-error": "0.0.373",
+    "@teambit/component-id": "0.0.377",
+    "@teambit/envs": "0.0.556",
+    "@teambit/workspace": "0.0.556",
+    "@teambit/cli": "0.0.387",
+    "@teambit/graphql": "0.0.556",
+    "@teambit/aspect-loader": "0.0.556",
+    "@teambit/bit": "0.0.558",
+    "@teambit/component": "0.0.556",
+    "@teambit/legacy-bit-id": "0.0.376",
+    "@teambit/compiler": "0.0.556",
+    "@teambit/dependency-resolver": "0.0.556",
+    "@teambit/logger": "0.0.472",
+    "@teambit/pkg": "0.0.556",
+    "@teambit/ui": "0.0.556"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -46,10 +46,10 @@
     "@types/react-dom": "^17.0.5",
     "@types/react": "^17.0.8",
     "@types/node": "12.20.4",
-    "@teambit/generator.aspect-docs.generator": "0.0.104"
+    "@teambit/generator.aspect-docs.generator": "0.0.109"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -77,12 +77,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/component-generator.ts

@@ -1,119 +0,0 @@
-import Vinyl from 'vinyl';
-import fs from 'fs-extra';
-import pMapSeries from 'p-map-series';
-import path from 'path';
-import { Workspace } from '@teambit/workspace';
-import { EnvsMain } from '@teambit/envs';
-import camelcase from 'camelcase';
-import { BitError } from '@teambit/bit-error';
-import { PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import { composeComponentPath } from '@teambit/legacy/dist/utils/bit/compose-component-path';
-import { ComponentID } from '@teambit/component-id';
-import { ComponentTemplate, ComponentFile } from './component-template';
-import { CreateOptions } from './create.cmd';
-
-export type GenerateResult = { id: ComponentID; dir: string; files: string[]; envId: string };
-
-export class ComponentGenerator {
-  constructor(
-    private workspace: Workspace,
-    private componentIds: ComponentID[],
-    private options: CreateOptions,
-    private template: ComponentTemplate,
-    private envs: EnvsMain
-  ) {}
-
-  async generate(): Promise<GenerateResult[]> {
-    const dirsToDeleteIfFailed: string[] = [];
-    const generateResults = await pMapSeries(this.componentIds, async (componentId) => {
-      try {
-        const componentPath = this.getComponentPath(componentId);
-        if (fs.existsSync(path.join(this.workspace.path, componentPath))) {
-          throw new BitError(`unable to create a component at "${componentPath}", this path already exist`);
-        }
-        if (await this.workspace.hasName(componentId.fullName)) {
-          throw new BitError(
-            `unable to create a component "${componentId.fullName}", a component with the same name already exist`
-          );
-        }
-        dirsToDeleteIfFailed.push(componentPath);
-        return await this.generateOneComponent(componentId, componentPath);
-      } catch (err: any) {
-        await this.deleteGeneratedComponents(dirsToDeleteIfFailed);
-        throw err;
-      }
-    });
-
-    await this.workspace.writeBitMap();
-
-    return generateResults;
-  }
-
-  private async deleteGeneratedComponents(dirs: string[]) {
-    await Promise.all(
-      dirs.map(async (dir) => {
-        const absoluteDir = path.join(this.workspace.path, dir);
-        try {
-          await fs.remove(absoluteDir);
-        } catch (err: any) {
-          if (err.code !== 'ENOENT') {
-            // if not exist, it's fine
-            throw err;
-          }
-        }
-      })
-    );
-  }
-
-  private async generateOneComponent(componentId: ComponentID, componentPath: string): Promise<GenerateResult> {
-    const name = componentId.name;
-    const namePascalCase = camelcase(name, { pascalCase: true });
-    const nameCamelCase = camelcase(name);
-    const files = this.template.generateFiles({ name, namePascalCase, nameCamelCase, componentId });
-    const mainFile = files.find((file) => file.isMain);
-    await this.writeComponentFiles(componentPath, files);
-    const addResults = await this.workspace.track({
-      rootDir: componentPath,
-      mainFile: mainFile?.relativePath,
-      componentName: componentId.fullName,
-    });
-    const component = await this.workspace.get(componentId);
-    const env = this.envs.getEnv(component);
-    return {
-      id: componentId,
-      dir: componentPath,
-      files: addResults.files,
-      envId: env.id,
-    };
-  }
-
-  /**
-   * writes the generated template files to the default directory set in the workspace config
-   */
-  private async writeComponentFiles(
-    componentPath: string,
-    templateFiles: ComponentFile[]
-  ): Promise<PathOsBasedRelative[]> {
-    const dataToPersist = new DataToPersist();
-    const vinylFiles = templateFiles.map((templateFile) => {
-      const templateFileVinyl = new Vinyl({
-        base: componentPath,
-        path: path.join(componentPath, templateFile.relativePath),
-        contents: Buffer.from(templateFile.content),
-      });
-      return AbstractVinyl.fromVinyl(templateFileVinyl);
-    });
-    const results = vinylFiles.map((v) => v.path);
-    dataToPersist.addManyFiles(vinylFiles);
-    dataToPersist.addBasePath(this.workspace.path);
-    await dataToPersist.persistAllToFS();
-    return results;
-  }
-
-  private getComponentPath(componentId: ComponentID) {
-    if (this.options.path) return this.options.path;
-    return composeComponentPath(componentId._legacy.changeScope(componentId.scope), this.workspace.defaultDirectory);
-  }
-}

package/component-template.ts

@@ -1,66 +0,0 @@
-import { ComponentID } from '@teambit/component-id';
-
-export interface ComponentFile {
-  /**
-   * relative path of the file within the component.
-   */
-  relativePath: string;
-
-  /**
-   * file content
-   */
-  content: string;
-
-  /**
-   * whether this file will be tracked as the main file
-   */
-  isMain?: boolean;
-}
-
-export interface ComponentContext {
-  /**
-   * component-name as entered by the user, e.g. `use-date`.
-   * without the scope and the namespace.
-   */
-  name: string;
-
-  /**
-   * component-name as upper camel case, e.g. `use-date` becomes `UseDate`.
-   * useful when generating the file content, for example for a class name.
-   */
-  namePascalCase: string;
-
-  /**
-   * component-name as lower camel case, e.g. `use-date` becomes `useDate`.
-   * useful when generating the file content, for example for a function/variable name.
-   */
-  nameCamelCase: string;
-
-  /**
-   * component id.
-   * the name is the name+namespace. the scope is the scope entered by --scope flag or the defaultScope
-   */
-  componentId: ComponentID;
-}
-
-export interface ComponentTemplate {
-  /**
-   * name of the component template. for example: `hook`, `react-component` or `module`.
-   */
-  name: string;
-
-  /**
-   * short description of the template. shown in the `bit templates` command.
-   */
-  description?: string;
-
-  /**
-   * hide this template so that it is not listed with `bit templates`
-   */
-  hidden?: boolean;
-
-  /**
-   * template function for generating the file of a certain component.,
-   */
-  generateFiles(context: ComponentContext): ComponentFile[];
-}

package/create.cmd.ts

@@ -1,44 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import chalk from 'chalk';
-import { GeneratorMain } from './generator.main.runtime';
-
-export type CreateOptions = {
-  namespace?: string;
-  aspect?: string;
-  scope?: string;
-  path?: string;
-};
-
-export class CreateCmd implements Command {
-  name = 'create <templateName> <componentNames...>';
-  description = 'create a new component from a template';
-  shortDescription = '';
-  alias = '';
-  loader = true;
-  group = 'development';
-  options = [
-    ['n', 'namespace <string>', `sets the component's namespace and nested dirs inside the scope`],
-    ['s', 'scope <string>', `sets the component's scope-name. if not entered, the default-scope will be used`],
-    ['a', 'aspect <string>', 'aspect-id of the template. helpful when multiple aspects use the same template name'],
-    ['p', 'path <string>', 'relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`'],
-  ] as CommandOptions;
-
-  constructor(private generator: GeneratorMain) {}
-
-  async report([templateName, componentNames]: [string, string[]], options: CreateOptions) {
-    const results = await this.generator.generateComponentTemplate(componentNames, templateName, options);
-    const title = `${results.length} component(s) were created`;
-
-    const componentsData = results
-      .map((result) => {
-        return `${chalk.bold(result.id.toString())}
-    location: ${result.dir}
-    env:      ${result.envId}
-`;
-      })
-      .join('\n');
-    const footer = `env configuration is according to workspace variants. learn more at https://harmony-docs.bit.dev/building-with-bit/environments/#configure-environment-for-components`;
-
-    return `${chalk.green(title)}\n\n${componentsData}\n\n${footer}`;
-  }
-}

package/generator.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const GeneratorAspect = Aspect.create({
-  id: 'teambit.generator/generator',
-});

package/generator.docs.mdx

@@ -1,8 +0,0 @@
----
-description: Generator for generating component templates
-labels: ['generator', 'templates']
----
-
-import { Generator } from '@teambit/generator.aspect-docs.generator';
-
-<Generator />

package/generator.graphql.ts

@@ -1,66 +0,0 @@
-import { Schema } from '@teambit/graphql';
-import gql from 'graphql-tag';
-import { GeneratorMain } from './generator.main.runtime';
-
-export function generatorSchema(generator: GeneratorMain): Schema {
-  return {
-    typeDefs: gql`
-      type GenerateResult {
-        id: String
-        dir: String
-        files: [String]
-      }
-
-      type Mutation {
-        # create Component by template
-        createComponent(
-          name: String!
-          templateName: String!
-          scope: String
-          namespace: String
-          aspect: String
-        ): [GenerateResult]
-      }
-
-      type TemplateDescriptor {
-        aspectId: String!
-        name: String!
-      }
-
-      type Generator {
-        templates: [TemplateDescriptor]
-      }
-
-      type Query {
-        generator: Generator
-      }
-    `,
-    resolvers: {
-      Mutation: {
-        createComponent: async (
-          req: any,
-          {
-            name,
-            templateName,
-            ...options
-          }: { name: string; templateName: string; scope?: string; namespace?: string; aspect?: string }
-        ) => {
-          const res = await generator.generateComponentTemplate([name], templateName, options);
-          return res.map((component) => ({
-            id: component.id.toString(),
-            dir: component.dir,
-            files: component.files,
-          }));
-        },
-      },
-      Generator: {
-        templates: async () => {
-          return generator.listTemplates();
-        },
-      },
-      Query: {
-        generator: () => generator,
-      },
-    },
-  };
-}