@teambit/generator 1.0.228 → 1.0.230

package/dist/templates/starter-standalone/index.d.ts

@@ -0,0 +1,2 @@
+import { ComponentTemplate } from '../../component-template';
+export declare const starterTemplate: ComponentTemplate;

package/dist/templates.cmd.d.ts

@@ -0,0 +1,18 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { GeneratorMain } from './generator.main.runtime';
+export type TemplatesOptions = {
+    showAll?: boolean;
+    aspect?: string;
+};
+export declare class TemplatesCmd implements Command {
+    private generator;
+    name: string;
+    description: string;
+    extendedDescription: string;
+    alias: string;
+    loader: boolean;
+    group: string;
+    options: CommandOptions;
+    constructor(generator: GeneratorMain);
+    report(args: [], templatesOptions: TemplatesOptions): Promise<string>;
+}

package/dist/types.d.ts

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

package/dist/workspace-generator.d.ts

@@ -0,0 +1,43 @@
+import { Component } from '@teambit/component';
+import { ComponentID } from '@teambit/component-id';
+import { WorkspaceTemplate } from './workspace-template';
+import { NewOptions } from './new.cmd';
+export type GenerateResult = {
+    id: ComponentID;
+    dir: string;
+    files: string[];
+    envId: string;
+};
+export declare class WorkspaceGenerator {
+    private workspaceName;
+    private workspacePath;
+    private options;
+    private template;
+    private aspectComponent?;
+    private harmony;
+    private workspace;
+    private install;
+    private importer;
+    private logger?;
+    private forking;
+    private git;
+    private wsConfigFiles;
+    private generator;
+    constructor(workspaceName: string, workspacePath: string, options: NewOptions & {
+        currentDir?: boolean;
+    }, template: WorkspaceTemplate, aspectComponent?: Component | undefined);
+    generate(): Promise<string>;
+    private initGit;
+    private setupGitBitmapMergeDriver;
+    private buildUI;
+    private getWorkspaceContext;
+    /**
+     * writes the generated template files to the default directory set in the workspace config
+     */
+    private writeWorkspaceFiles;
+    private reloadBitInWorkspaceDir;
+    private createComponentsFromRemote;
+    private forkComponentsFromRemote;
+    private importComponentsFromRemote;
+    private compileComponents;
+}

package/dist/workspace-template.d.ts

@@ -0,0 +1,156 @@
+import type { Component } from '@teambit/component';
+import { ComponentConfig } from './component-template';
+/**
+ * BaseWorkspaceOptions describes the foundational properties for workspaces.
+ */
+export interface BaseWorkspaceOptions {
+    /**
+     * The name of the workspace as provided by the user (e.g., `react-app`).
+     * This is also used as the directory name for the workspace.
+     */
+    name: string;
+    /**
+     * The default scope provided by the user.
+     * This is set in the workspace.jsonc and is utilized for components within the workspace.
+     */
+    defaultScope?: string;
+    /**
+     * Indicates whether the user has opted to avoid creating components (typically with a `--empty` flag).
+     */
+    empty?: boolean;
+    /**
+     * Represents the aspect in the context where a remote aspect is imported (often via the `--aspect` flag).
+     * This is useful for obtaining the aspect-id and other related information.
+     */
+    aspectComponent?: Component;
+    /**
+     * Represents the selected template to initialize or create the workspace.
+     */
+    template: WorkspaceTemplate;
+    /**
+     * Flag to check if Git repository generation should be skipped.
+     */
+    skipGit?: boolean;
+    /**
+     * Local path to the workspace template.
+     * Useful during the development of a workspace-template.
+     */
+    loadFrom?: string;
+}
+/**
+ * WorkspaceContext represents foundational properties for a workspace context.
+ */
+export type WorkspaceContext = BaseWorkspaceOptions;
+export interface WorkspaceFile {
+    /**
+     * relative path of the file within the workspace.
+     */
+    relativePath: string;
+    /**
+     * file content
+     */
+    content: string;
+}
+export interface CreateComponentInfo {
+    /**
+     * the template for generating the component
+     */
+    templateName: string;
+    /**
+     * component name to generate
+     */
+    componentName: string;
+    /**
+     * sets the component's scope-name. if not entered, the default-scope will be used
+     */
+    scope?: string;
+    /**
+     * relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`
+     */
+    path?: string;
+    /**
+     * set the component's environment. (overrides the env from variants and the template)
+     */
+    env?: string;
+    /**
+     * aspect-id of the template.
+     */
+    aspect?: string;
+}
+export interface ForkComponentInfo extends ImportComponentInfo {
+    /**
+     * a new component name. if not specified, use the original id (without the scope)
+     */
+    targetName?: string;
+    /**
+     * a new scope for the component. if not specified, use the original scope
+     */
+    targetScope?: string;
+    /**
+     * env to use for the component.
+     */
+    env?: string;
+    /**
+     * component config. gets saved in the .bitmap file and overrides the workspace.jsonc config.
+     * for example, you can set the env that will be used for this component as follows:
+     * "teambit.envs/envs": {
+     *    "env": "teambit.harmony/aspect"
+     * },
+     */
+    config?: ComponentConfig;
+}
+/**
+ * @deprecated use ForkComponentInfo instead.
+ */
+export type ComponentToImport = ForkComponentInfo;
+export interface ImportComponentInfo {
+    /**
+     * full component id
+     */
+    id: string;
+    /**
+     * path where to write the component
+     */
+    path?: string;
+}
+export interface WorkspaceTemplate {
+    /**
+     * name of the workspace starter. for example: `react-workspace`.
+     */
+    name: string;
+    /**
+     * name of an app created in the workspace. for example: `my-app`.
+     * This will be used to instruct the user to run `bit run <appName>` in the new workspace.
+     */
+    appName?: string;
+    /**
+     * short description of the starter. shown in the `bit starter` command when outside of bit-workspace.
+     */
+    description?: string;
+    /**
+     * hide this starter so that it is not listed with `bit starter`
+     */
+    hidden?: boolean;
+    /**
+     * starter function for generating the template files,
+     */
+    generateFiles(context: WorkspaceContext): Promise<WorkspaceFile[]>;
+    /**
+     * @deprecated use `fork()` or `import()` instead
+     * this is working similarly to `fork()`
+     */
+    importComponents?: (context: WorkspaceContext) => ForkComponentInfo[];
+    /**
+     * import components into the new workspace, don't change their source code.
+     */
+    import?: (context: WorkspaceContext) => ImportComponentInfo[];
+    /**
+     * populate existing components into the new workspace and add them as new components.
+     * change their source code and update the dependency names according to the new component names.
+     */
+    fork?: (context: WorkspaceContext) => ForkComponentInfo[];
+    /**
+     * populate new components into the new workspace and add them as new components.
+     */
+    create?: (context: WorkspaceContext) => CreateComponentInfo[];
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/generator",
-  "version": "1.0.228",
+  "version": "1.0.230",
   "homepage": "https://bit.cloud/teambit/generator/generator",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.generator",
     "name": "generator",
-    "version": "1.0.228"
+    "version": "1.0.230"
   },
   "dependencies": {
     "camelcase": "6.2.0",
@@ -21,32 +21,32 @@
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/git.modules.git-ignore": "1.0.2",
-    "@teambit/envs": "1.0.227",
-    "@teambit/logger": "0.0.953",
-    "@teambit/new-component-helper": "1.0.227",
-    "@teambit/tracker": "1.0.227",
-    "@teambit/workspace-config-files": "1.0.227",
+    "@teambit/envs": "1.0.229",
+    "@teambit/logger": "0.0.955",
+    "@teambit/new-component-helper": "1.0.229",
+    "@teambit/tracker": "1.0.229",
+    "@teambit/workspace-config-files": "1.0.229",
     "@teambit/workspace.modules.node-modules-linker": "0.0.167",
-    "@teambit/workspace": "1.0.227",
-    "@teambit/component": "1.0.227",
-    "@teambit/cli": "0.0.860",
-    "@teambit/graphql": "1.0.227",
-    "@teambit/aspect-loader": "1.0.227",
-    "@teambit/bit": "1.6.120",
-    "@teambit/git": "1.0.227",
-    "@teambit/compiler": "1.0.227",
-    "@teambit/forking": "1.0.227",
-    "@teambit/importer": "1.0.227",
-    "@teambit/install": "1.0.227",
-    "@teambit/ui": "1.0.227",
-    "@teambit/config": "0.0.978"
+    "@teambit/workspace": "1.0.229",
+    "@teambit/component": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/aspect-loader": "1.0.229",
+    "@teambit/bit": "1.6.122",
+    "@teambit/git": "1.0.229",
+    "@teambit/compiler": "1.0.229",
+    "@teambit/forking": "1.0.229",
+    "@teambit/importer": "1.0.229",
+    "@teambit/install": "1.0.229",
+    "@teambit/ui": "1.0.229",
+    "@teambit/config": "0.0.980"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
     "@types/lodash": "4.14.165",
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33",
     "@teambit/generator.aspect-docs.generator": "0.0.171"
   },
   "peerDependencies": {

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,61 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.953"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_new-component-helper@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_tracker@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace-config-files@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_aspect-loader@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_bit@1.6.120"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.git_git@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_compiler@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_forking@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_importer@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_install@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_config@0.0.978"
-    }
   ]
 }