@teambit/generator 1.0.9 → 1.0.11

package/templates/starter/files/starter.ts

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

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

@@ -3,30 +3,20 @@ 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 = 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',
-      },
-    },
+  configParsed['teambit.workspace/workspace'].defaultScope = scope;
+  configParsed['teambit.generator/generator'] = {
+    envs: [
+     scope + '/react/react-env',
+    ],
+  };
+  configParsed['teambit.workspace/variants'] = {
+    '*': {},
   };
 
   return stringifyWorkspaceConfig(configParsed);
 }
 `;
-}
+}

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

@@ -28,17 +28,8 @@ 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,30 +4,19 @@ 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.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',
-      },
-    },
+  configParsed['teambit.generator/generator'] = {
+    envs: [
+      'teambit.react/react-env',
+      'teambit.node/node',
+    ],
+  };
+  configParsed['teambit.workspace/variants'] = {
+    '*': {},
   };
-
 
   return stringifyWorkspaceConfig(configParsed);
 }
 `;
-}
+}

package/tsconfig.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2019",
+      "DOM",
+      "ES6",
+      "DOM.Iterable",
+      "ScriptHost"
+    ],
+    "target": "es2015",
+    "module": "CommonJS",
+    "jsx": "react",
+    "allowJs": true,
+    "composite": true,
+    "declaration": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "rootDir": ".",
+    "resolveJsonModule": true,
+    "emitDeclarationOnly": true,
+    "emitDecoratorMetadata": true,
+    "allowSyntheticDefaultImports": true,
+    "strictPropertyInitialization": false,
+    "strict": true,
+    "noImplicitAny": false,
+    "preserveConstEnums": true
+  },
+  "exclude": [
+    "dist",
+    "package.json"
+  ],
+  "include": [
+    "**/*",
+    "**/*.json"
+  ]
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  const src: string;
+  export default src;
+}
+
+// @TODO Gilad
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}

package/component-generator.ts

@@ -1,271 +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 EnvsAspect, { EnvsMain } from '@teambit/envs';
-import camelcase from 'camelcase';
-import { BitError } from '@teambit/bit-error';
-import { Logger } from '@teambit/logger';
-import { TrackerMain } from '@teambit/tracker';
-import { linkToNodeModulesByIds } from '@teambit/workspace.modules.node-modules-linker';
-import { PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import componentIdToPackageName from '@teambit/legacy/dist/utils/bit/component-id-to-package-name';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import { NewComponentHelperMain } from '@teambit/new-component-helper';
-import { ComponentID } from '@teambit/component-id';
-import { WorkspaceConfigFilesMain } from '@teambit/workspace-config-files';
-
-import { ComponentTemplate, ComponentFile, ComponentConfig } from './component-template';
-import { CreateOptions } from './create.cmd';
-import { OnComponentCreateSlot } from './generator.main.runtime';
-
-export type GenerateResult = {
-  id: ComponentID;
-  dir: string;
-  files: string[];
-  envId: string;
-  envSetBy: string;
-  packageName: string;
-};
-
-export type OnComponentCreateFn = (generateResults: GenerateResult[]) => Promise<void>;
-
-export class ComponentGenerator {
-  constructor(
-    private workspace: Workspace,
-    private componentIds: ComponentID[],
-    private options: Partial<CreateOptions>,
-    private template: ComponentTemplate,
-    private envs: EnvsMain,
-    private newComponentHelper: NewComponentHelperMain,
-    private tracker: TrackerMain,
-    private wsConfigFiles: WorkspaceConfigFilesMain,
-    private logger: Logger,
-    private onComponentCreateSlot: OnComponentCreateSlot,
-    private aspectId: string,
-    private envId?: ComponentID
-  ) {}
-
-  async generate(): Promise<GenerateResult[]> {
-    const dirsToDeleteIfFailed: string[] = [];
-    const generateResults = await pMapSeries(this.componentIds, async (componentId) => {
-      try {
-        const componentPath = this.newComponentHelper.getNewComponentPath(
-          componentId,
-          this.options.path,
-          this.componentIds.length
-        );
-        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.bitMap.write();
-
-    const ids = generateResults.map((r) => r.id);
-    await this.tryLinkToNodeModules(ids);
-    await this.runOnComponentCreateHook(generateResults);
-    // We are running this after the runOnComponentCreateHook as it require
-    // the env to be installed to work properly, and the hook might install
-    // the env.
-    await this.tryWriteConfigFiles(ids);
-
-    return generateResults;
-  }
-
-  private async tryLinkToNodeModules(ids: ComponentID[]) {
-    try {
-      await linkToNodeModulesByIds(
-        this.workspace,
-        ids.map((id) => id._legacy)
-      );
-    } catch (err: any) {
-      this.logger.consoleFailure(
-        `failed linking the new components to node_modules, please run "bit link" manually. error: ${err.message}`
-      );
-    }
-  }
-
-  private async runOnComponentCreateHook(generateResults: GenerateResult[]) {
-    const fns = this.onComponentCreateSlot.values();
-    if (!fns.length) return;
-    await Promise.all(fns.map((fn) => fn(generateResults)));
-  }
-
-  /**
-   * The function `tryWriteConfigFiles` attempts to write workspace config files, and if it fails, it logs an error
-   * message.
-   * @returns If the condition `!shouldWrite` is true, then nothing is being returned. Otherwise, if the `writeConfigFiles`
-   * function is successfully executed, nothing is being returned. If an error occurs during the execution of
-   * `writeConfigFiles`, an error message is being returned.
-   */
-  private async tryWriteConfigFiles(ids: ComponentID[]) {
-    try {
-      const shouldWrite = this.wsConfigFiles.isWorkspaceConfigWriteEnabled();
-      if (!shouldWrite) return;
-      ids.map((id) => this.workspace.clearComponentCache(id));
-      await this.wsConfigFiles.writeConfigFiles({
-        clean: true,
-        silent: true,
-        dedupe: true,
-      });
-    } catch (err: any) {
-      this.logger.consoleFailure(
-        `failed generating workspace config files, please run "bit ws-config write" manually. error: ${err.message}`
-      );
-    }
-  }
-
-  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 aspectId = ComponentID.fromString(this.aspectId);
-
-    const files = await this.template.generateFiles({
-      name,
-      namePascalCase,
-      nameCamelCase,
-      componentId,
-      aspectId,
-      envId: this.envId,
-    });
-    const mainFile = files.find((file) => file.isMain);
-    await this.writeComponentFiles(componentPath, files);
-    const addResults = await this.tracker.track({
-      rootDir: componentPath,
-      mainFile: mainFile?.relativePath,
-      componentName: componentId.fullName,
-      defaultScope: this.options.scope,
-    });
-    const component = await this.workspace.get(componentId);
-    const hasEnvConfiguredOriginally = this.envs.hasEnvConfigured(component);
-    const envBeforeConfigChanges = this.envs.getEnv(component);
-    let config = this.template.config;
-    if (config && typeof config === 'function') {
-      const boundConfig = this.template.config?.bind(this.template);
-      config = boundConfig({ aspectId: this.aspectId });
-    }
-
-    if (!config && this.envId) {
-      const isInWorkspace = this.workspace.exists(this.envId);
-      config = {
-        [isInWorkspace ? this.envId.toStringWithoutVersion() : this.envId.toString()]: {},
-        'teambit.envs/envs': {
-          env: this.envId.toStringWithoutVersion(),
-        },
-      };
-    }
-
-    const templateEnv = config?.[EnvsAspect.id]?.env;
-
-    if (config && templateEnv && hasEnvConfiguredOriginally) {
-      // remove the env we got from the template.
-      delete config[templateEnv];
-      delete config[EnvsAspect.id].env;
-      if (Object.keys(config[EnvsAspect.id]).length === 0) delete config[EnvsAspect.id];
-      if (Object.keys(config).length === 0) config = undefined;
-    }
-
-    const configWithEnv = await this.addEnvIfProvidedByFlag(config);
-    if (configWithEnv) this.workspace.bitMap.setEntireConfig(component.id, configWithEnv);
-
-    const getEnvData = () => {
-      const envFromFlag = this.options.env; // env entered by the user when running `bit create --env`
-      const envFromTemplate = config?.[EnvsAspect.id]?.env;
-      if (envFromFlag) {
-        return {
-          envId: envFromFlag,
-          setBy: '--env flag',
-        };
-      }
-      if (envFromTemplate) {
-        return {
-          envId: envFromTemplate,
-          setBy: 'template',
-        };
-      }
-      return {
-        envId: envBeforeConfigChanges.id,
-        setBy: hasEnvConfiguredOriginally ? 'workspace variants' : '<default>',
-      };
-    };
-    const { envId, setBy } = getEnvData();
-    return {
-      id: componentId,
-      dir: componentPath,
-      files: addResults.files,
-      packageName: componentIdToPackageName(component.state._consumer),
-      envId,
-      envSetBy: setBy,
-    };
-  }
-
-  private async addEnvIfProvidedByFlag(config?: ComponentConfig): Promise<ComponentConfig | undefined> {
-    const userEnv = this.options.env; // env entered by the user when running `bit create --env`
-    const templateEnv = config?.[EnvsAspect.id]?.env;
-    if (!userEnv || userEnv === templateEnv) {
-      return config;
-    }
-    config = config || {};
-    if (templateEnv) {
-      // the component template has an env and the user wants a different env.
-      delete config[templateEnv];
-    }
-    await this.tracker.addEnvToConfig(userEnv, config);
-
-    return config;
-  }
-
-  /**
-   * 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;
-  }
-}

package/component-template.ts

@@ -1,122 +0,0 @@
-import { ComponentID } from '@teambit/component';
-
-/**
- * BaseComponentTemplateOptions describes the foundational properties for components.
- */
-export interface BaseComponentTemplateOptions {
-  /**
-   * 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;
-
-  /**
-   * aspect id of the aspect that register the template itself
-   */
-  aspectId: ComponentID | string;
-
-  /**
-   * env id of the env that register the template itself.
-   * This will be usually identical to the aspectId but aspectId will always exist,
-   * while envId will be undefined if the template is not registered by an env.
-   */
-  envId?: ComponentID;
-
-  /**
-   * path of the component.
-   */
-  path?: string;
-  /**
-   * scope of the component.
-   */
-  scope?: string;
-  /**
-   * namespace of the component.
-   */
-  namespace?: string;
-}
-
-/**
- * ComponentContext represents foundational properties for a component context.
- */
-export type ComponentContext = BaseComponentTemplateOptions;
-
-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 ConfigContext {
-  /**
-   * Aspect id of the aspect that register the template itself
-   */
-  aspectId: string;
-}
-
-export type ComponentConfig = { [aspectName: string]: any };
-
-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;
-
-  /**
-   * env to use for the component.
-   */
-  env?: string;
-
-  /**
-   * template function for generating the file of a certain component.,
-   */
-  generateFiles(context: ComponentContext): Promise<ComponentFile[]> | ComponentFile[];
-
-  /**
-   * component config. gets saved in the .bitmap file and it 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 | ((context: ConfigContext) => ComponentConfig);
-}