@teambit/generator 0.0.554 → 0.0.558

package/templates/workspace-generator/files/git-ignore-tpl.ts

@@ -1,113 +0,0 @@
-export function gitIgnoreTemplate() {
-  return `export function gitIgnore() {
-  return \`# Bit
-.bit
-public
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-.history
-\`;
-}
-`;
-}

package/templates/workspace-generator/files/index-tpl.ts

@@ -1,29 +0,0 @@
-export function indexTemplate() {
-  return `import { WorkspaceContext, WorkspaceTemplate } from '@teambit/generator';
-import { workspaceConfig } from './files/workspace-config';
-import { readme } from './files/readme-file';
-import { gitIgnore } from './files/git-ignore';
-
-export const workspaceTemplate: WorkspaceTemplate = {
-  name: 'template-example',
-  description: 'demonstration of a workspace template',
-  generateFiles: async (context: WorkspaceContext) => [
-    {
-      relativePath: 'workspace.jsonc',
-      content: await workspaceConfig(context),
-    },
-    {
-      relativePath: '.gitignore',
-      content: gitIgnore(),
-    },
-    {
-      relativePath: 'README.md',
-      content: readme(),
-    },
-  ],
-  importComponents: () => [
-    { id: 'teambit.react/templates/ui/text', path: 'ui/text' },
-  ],
-};
-`;
-}

package/templates/workspace-generator/files/index.ts

@@ -1,10 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function indexFile({ namePascalCase, name }: ComponentContext) {
-  return `import { ${namePascalCase}Aspect } from './${name}.aspect';
-
-export type { ${namePascalCase}Main } from './${name}.main.runtime';
-export default ${namePascalCase}Aspect;
-export { ${namePascalCase}Aspect };
-`;
-}

package/templates/workspace-generator/files/main-runtime.ts

@@ -1,24 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function mainRuntime({ name, namePascalCase }: ComponentContext) {
-  return `import { MainRuntime } from '@teambit/cli';
-import { GeneratorMain, GeneratorAspect } from '@teambit/generator';
-import { ${namePascalCase}Aspect } from './${name}.aspect';
-import { workspaceTemplate } from './template';
-
-export class ${namePascalCase}Main {
-  static slots = [];
-
-  static dependencies = [GeneratorAspect];
-
-  static runtime = MainRuntime;
-
-  static async provider([generator]: [GeneratorMain]) {
-    generator.registerWorkspaceTemplate([workspaceTemplate]);
-    return new ${namePascalCase}Main();
-  }
-}
-
-${namePascalCase}Aspect.addRuntime(${namePascalCase}Main);
-`;
-}

package/templates/workspace-generator/files/readme-tpl.ts

@@ -1,39 +0,0 @@
-export function readmeTemplate() {
-  return `export function readme() {
-  return \`## Workspace Generator
-
-Easily generate a new workspace with a single command.
-
-## Registering your Workspace
-
-Register your workspace template under the aspect environment in the variants section of the workspace.jsonc file.
-
-\\\`\\\`\\\`json
-"teambit.workspace/variants": {
-    "{workspace-name}": {
-      "teambit.harmony/aspect": {}
-    }
-  }
-\\\`\\\`\\\`
-
-## Customizing your Workspace
-
-See the docs for more info on [Customizing your Generator](https://harmony-docs.bit.dev/extending-bit/creating-a-custom-workspace-generator)
-
-## Using the Workspace Generator
-
-How to use this generator locally, essentially for development purposes:
-
-\\\`\\\`\\\`js
-bit new <template-name> <workspace-name> --load-from /Users/me/path/to/this/dir --aspect <workspace-template-id>
-\\\`\\\`\\\`
-
-How to use this generator after exporting to a remote scope:
-
-\\\`\\\`\\\`js
-bit new <template-name> <workspace-name> --aspect <workspace-template-id>
-\\\`\\\`\\\`
-\`;
-}
-`;
-}

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

@@ -1,18 +0,0 @@
-export function workspaceConfigTemplate() {
-  return `import { WorkspaceContext } from '@teambit/generator';
-import { getWorkspaceConfigTemplateParsed, stringifyWorkspaceConfig } from '@teambit/config';
-
-export async function workspaceConfig({ name, defaultScope }: WorkspaceContext) {
-  const configParsed = await getWorkspaceConfigTemplateParsed();
-  configParsed['teambit.workspace/workspace'].name = name;
-  configParsed['teambit.workspace/workspace'].defaultScope = defaultScope || 'company.scope';
-  configParsed['teambit.workspace/variants'] = {
-    '*': {
-      'teambit.react/react': {},
-    },
-  };
-
-  return stringifyWorkspaceConfig(configParsed);
-}
-`;
-}

package/templates/workspace-generator/index.ts

@@ -1,52 +0,0 @@
-import { ComponentContext, ComponentTemplate } from '@teambit/generator';
-import { indexFile } from './files/index';
-import { aspectFile } from './files/aspect-file';
-import { docsFile } from './files/docs-file';
-import { mainRuntime } from './files/main-runtime';
-import { gitIgnoreTemplate } from './files/git-ignore-tpl';
-import { readmeTemplate } from './files/readme-tpl';
-import { indexTemplate } from './files/index-tpl';
-import { workspaceConfigTemplate } from './files/workspace-config-tpl';
-
-export const workspaceGeneratorTemplate: ComponentTemplate = {
-  name: 'workspace-generator',
-  description:
-    'create your own workspace generator - \nDocs: https://harmony-docs.bit.dev/extending-bit/creating-a-custom-workspace-generator',
-  generateFiles: (context: ComponentContext) => {
-    return [
-      {
-        relativePath: 'index.ts',
-        content: indexFile(context),
-        isMain: true,
-      },
-      {
-        relativePath: `${context.name}.aspect.ts`,
-        content: aspectFile(context),
-      },
-      {
-        relativePath: `${context.name}.main.runtime.ts`,
-        content: mainRuntime(context),
-      },
-      {
-        relativePath: `${context.name}.docs.mdx`,
-        content: docsFile(),
-      },
-      {
-        relativePath: 'template/files/git-ignore.ts',
-        content: gitIgnoreTemplate(),
-      },
-      {
-        relativePath: 'template/files/readme-file.ts',
-        content: readmeTemplate(),
-      },
-      {
-        relativePath: 'template/files/workspace-config.ts',
-        content: workspaceConfigTemplate(),
-      },
-      {
-        relativePath: 'template/index.ts',
-        content: indexTemplate(),
-      },
-    ];
-  },
-};

package/templates.cmd.ts

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

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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/types.ts

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

package/workspace-generator.ts

@@ -1,246 +0,0 @@
-import fs from 'fs-extra';
-import { isBinaryFile } from 'isbinaryfile';
-import { loadBit } from '@teambit/bit';
-import { Harmony } from '@teambit/harmony';
-import { Component } from '@teambit/component';
-import execa from 'execa';
-import { BitId } from '@teambit/legacy-bit-id';
-import pMapSeries from 'p-map-series';
-import UIAspect, { UiMain } from '@teambit/ui';
-import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
-import { WorkspaceAspect, Workspace } from '@teambit/workspace';
-import { PkgAspect, PkgMain } from '@teambit/pkg';
-import { init } from '@teambit/legacy/dist/api/consumer';
-import { CompilerAspect, CompilerMain } from '@teambit/compiler';
-import getGitExecutablePath from '@teambit/legacy/dist/utils/git/git-executable';
-import GitNotFound from '@teambit/legacy/dist/utils/git/exceptions/git-not-found';
-import path from 'path';
-import { DependencyResolverMain, DependencyResolverAspect } from '@teambit/dependency-resolver';
-import { ComponentID } from '@teambit/component-id';
-import { WorkspaceTemplate } from './workspace-template';
-import { NewOptions } from './new.cmd';
-import { GeneratorAspect } from './generator.aspect';
-
-export type GenerateResult = { id: ComponentID; dir: string; files: string[]; envId: string };
-
-type CompToImportResolved = {
-  id: ComponentID;
-  path: string;
-  targetName?: string;
-};
-
-export class WorkspaceGenerator {
-  private workspacePath: string;
-  private harmony: Harmony;
-  private workspace: Workspace;
-  private logger: Logger;
-  constructor(
-    private workspaceName: string,
-    private options: NewOptions,
-    private template: WorkspaceTemplate,
-    private aspectComponent?: Component
-  ) {
-    this.workspacePath = path.resolve(this.workspaceName);
-  }
-
-  async generate(): Promise<string> {
-    if (fs.existsSync(this.workspacePath)) {
-      throw new Error(`unable to create a workspace at "${this.workspaceName}", this path already exist`);
-    }
-    await fs.ensureDir(this.workspacePath);
-    try {
-      process.chdir(this.workspacePath);
-      await this.initGit();
-      await init(this.workspacePath, this.options.skipGit, false, false, false, false, {});
-      await this.writeWorkspaceFiles();
-      await this.reloadBitInWorkspaceDir();
-      await this.addComponentsFromRemote();
-      await this.workspace.install(undefined, {
-        dedupe: true,
-        import: false,
-        copyPeerToRuntimeOnRoot: true,
-        copyPeerToRuntimeOnComponents: false,
-        updateExisting: false,
-      });
-      // await this.buildUI(); // disabled for now. it takes too long
-    } catch (err: any) {
-      await fs.remove(this.workspacePath);
-      throw err;
-    }
-
-    return this.workspacePath;
-  }
-
-  private async initGit() {
-    if (this.options.skipGit) return;
-    const gitExecutablePath = getGitExecutablePath();
-    const params = ['init'];
-    try {
-      await execa(gitExecutablePath, params);
-    } catch (err: any) {
-      if (err.exitCodeName === 'ENOENT') {
-        throw new GitNotFound(gitExecutablePath, err);
-      }
-      throw err;
-    }
-  }
-
-  private async buildUI() {
-    const uiMain = this.harmony.get<UiMain>(UIAspect.id);
-    await uiMain.createRuntime({});
-  }
-
-  /**
-   * writes the generated template files to the default directory set in the workspace config
-   */
-  private async writeWorkspaceFiles(): Promise<void> {
-    const workspaceContext = {
-      name: this.workspaceName,
-      defaultScope: this.options.defaultScope,
-      empty: this.options.empty,
-      aspectComponent: this.aspectComponent,
-    };
-    const templateFiles = await this.template.generateFiles(workspaceContext);
-    await Promise.all(
-      templateFiles.map(async (templateFile) => {
-        await fs.outputFile(path.join(this.workspacePath, templateFile.relativePath), templateFile.content);
-      })
-    );
-  }
-
-  private async reloadBitInWorkspaceDir() {
-    this.harmony = await loadBit(this.workspacePath);
-    this.workspace = this.harmony.get<Workspace>(WorkspaceAspect.id);
-    const loggerMain = this.harmony.get<LoggerMain>(LoggerAspect.id);
-    this.logger = loggerMain.createLogger(GeneratorAspect.id);
-  }
-
-  private async addComponentsFromRemote() {
-    if (this.options.empty) return;
-    const componentsToImport = this.template?.importComponents?.();
-    if (!componentsToImport || !componentsToImport.length) return;
-    const dependencyResolver = this.harmony.get<DependencyResolverMain>(DependencyResolverAspect.id);
-
-    const componentsToImportResolved = await Promise.all(
-      componentsToImport.map(async (c) => ({
-        id: ComponentID.fromLegacy(BitId.parse(c.id, true)),
-        path: c.path,
-        targetName: c.targetName,
-      }))
-    );
-    const componentIds = componentsToImportResolved.map((c) => c.id);
-    // @todo: improve performance by changing `getRemoteComponent` api to accept multiple ids
-    const components = await Promise.all(componentIds.map((id) => this.workspace.scope.getRemoteComponent(id)));
-    const oldAndNewPackageNames = this.getNewPackageNames(components, componentsToImportResolved);
-    const oldAndNewComponentIds = this.getNewComponentIds(components, componentsToImportResolved);
-    await Promise.all(
-      components.map((comp) =>
-        this.replaceOriginalPackageNameWithNew(comp, oldAndNewPackageNames, oldAndNewComponentIds)
-      )
-    );
-    await pMapSeries(components, async (comp) => {
-      const compData = componentsToImportResolved.find((c) => c.id._legacy.isEqualWithoutVersion(comp.id._legacy));
-      if (!compData) throw new Error(`workspace-generator, unable to find ${comp.id.toString()} in the given ids`);
-      await this.workspace.write(compData.path, comp);
-      await this.workspace.track({
-        rootDir: compData.path,
-        componentName: compData.targetName || compData.id.fullName,
-        mainFile: comp.state._consumer.mainFile,
-      });
-      const deps = await dependencyResolver.getDependencies(comp);
-
-      const currentPackages = Object.keys(oldAndNewPackageNames);
-      // only bring auto-resolved dependencies, others should be set in the workspace.jsonc template
-      const workspacePolicyEntries = deps
-        .filter((dep) => dep.source === 'auto')
-        .map((dep) => ({
-          dependencyId: dep.getPackageName?.() || dep.id,
-          lifecycleType: dep.lifecycle === 'dev' ? 'runtime' : dep.lifecycle,
-          value: {
-            version: dep.version,
-          },
-        }))
-        .filter((entry) => !currentPackages.includes(entry.dependencyId)); // remove components that are now imported
-      dependencyResolver.addToRootPolicy(workspacePolicyEntries, { updateExisting: true });
-    });
-    await this.workspace.writeBitMap();
-    await dependencyResolver.persistConfig(this.workspace.path);
-    this.workspace.clearCache();
-    await this.compileComponents();
-  }
-
-  private async compileComponents() {
-    const compiler = this.harmony.get<CompilerMain>(CompilerAspect.id);
-    await compiler.compileOnWorkspace();
-  }
-
-  private getNewPackageNames(
-    components: Component[],
-    compsData: CompToImportResolved[]
-  ): { [oldPackageName: string]: string } {
-    const pkg = this.harmony.get<PkgMain>(PkgAspect.id);
-    const packageToReplace = {};
-    const scopeToReplace = this.workspace.defaultScope.replace('.', '/');
-    components.forEach((comp) => {
-      const newId = this.resolveNewCompId(comp, compsData);
-      const currentPackageName = pkg.getPackageName(comp);
-      const newName = newId.fullName.replace(/\//g, '.');
-      const newPackageName = `@${scopeToReplace}.${newName}`;
-      packageToReplace[currentPackageName] = newPackageName;
-    });
-    return packageToReplace;
-  }
-
-  private getNewComponentIds(
-    components: Component[],
-    compsData: CompToImportResolved[]
-  ): { [oldComponentId: string]: string } {
-    const componentToReplace = {};
-    components.forEach((comp) => {
-      const newId = this.resolveNewCompId(comp, compsData);
-      componentToReplace[comp.id.toStringWithoutVersion()] = newId.toStringWithoutVersion();
-    });
-    return componentToReplace;
-  }
-
-  private resolveNewCompId(comp: Component, compsData: CompToImportResolved[]): ComponentID {
-    const scopeToReplace = this.workspace.defaultScope;
-    const compData = compsData.find((c) => c.id._legacy.isEqualWithoutScopeAndVersion(comp.id._legacy));
-    if (!compData) {
-      throw new Error(`workspace-generator: unable to find data for "${comp.id._legacy.toString()}"`);
-    }
-    return compData.targetName
-      ? ComponentID.fromLegacy(BitId.parse(compData.targetName, false).changeScope(scopeToReplace))
-      : comp.id.changeScope(scopeToReplace);
-  }
-
-  private async replaceOriginalPackageNameWithNew(
-    comp: Component,
-    packageToReplace: Record<string, string>,
-    oldAndNewComponentIds: Record<string, string>
-  ) {
-    await Promise.all(
-      comp.filesystem.files.map(async (file) => {
-        const isBinary = await isBinaryFile(file.contents);
-        if (isBinary) return;
-        const strContent = file.contents.toString();
-        let newContent = strContent;
-        Object.keys(packageToReplace).forEach((currentPackage) => {
-          if (strContent.includes(currentPackage)) {
-            const currentPkgRegex = new RegExp(currentPackage, 'g');
-            newContent = newContent.replace(currentPkgRegex, packageToReplace[currentPackage]);
-          }
-        });
-        Object.keys(oldAndNewComponentIds).forEach((currentId) => {
-          if (strContent.includes(currentId)) {
-            const currentIdRegex = new RegExp(currentId, 'g');
-            newContent = newContent.replace(currentIdRegex, oldAndNewComponentIds[currentId]);
-          }
-        });
-        if (strContent !== newContent) {
-          file.contents = Buffer.from(newContent);
-        }
-      })
-    );
-  }
-}