@teambit/react 0.0.565 → 0.0.569

package/templates/react-env/files/doc.ts

@@ -0,0 +1,163 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function docFile({ name, componentId }: ComponentContext) {
+  return `---
+description: 'A standard React component development environment'
+labels: ['react', 'typescript', 'env', 'extension']
+---
+
+## Overview
+
+A customized version which extends the default React component development environment created by teambit. This environment can be applied to all your components or a set of components under the variants of your \`workspace.json\` file. That means they will use your custom environment instead of the default environment. Environment components are just like any other Bit components in that they can be exported and then shared and used in various projects which makes it easier to create standards when working with many teams.
+
+### Usage instructions
+
+Under the **variant** section of your \`workspace.json\` file choose which components you want to have the custom environment set. You can find the id of the extension in the \`${name}.aspect.ts\` file.
+
+\`\`\`json
+{
+  "teambit.workspace/variants": {
+    "{ui/**}, {pages/**}": {
+      "${componentId}": {}
+    }
+  }
+}
+\`\`\`
+
+## Runtime Configurations
+
+Extend the \`main.runtime\` file when you want to add custom configurations at runtime.
+
+### Compilation
+
+By default, Component compilation is done with the TypeScript compiler. Target format is \`ES2015\` which
+supports execution from both NodeJS and browser runtimes for server-side rendering. You can modify the \`tsconfig.json\` file to add your own compiler options which will then be merged with the default configs set by teambit.
+
+Example:
+
+\`\`\`json
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "es2015",
+    "moduleResolution": "node",
+    "lib": ["es2017", "dom"],
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "emitDecoratorMetadata": true,
+    "allowJs": true,
+    "baseUrl": ".",
+    "jsx": "react"
+  }
+}
+\`\`\`
+
+### Testing
+
+Component testing is done through [Jest](https://jestjs.io/) with the default \`teambit.react/react\` environment. You can modify the \`jestconfig.js\` file to add your own configurations which will then be merged with the default configs set by teambit.
+
+Example:
+
+To Override the Jest config to ignore transpiling from specific folders add this to the \`jestconfig.js\` file:
+
+\`\`\`js
+const reactJestConfig = require('@teambit/react/jest/jest.config');
+module.exports = {
+  ...reactJestConfig,
+  transformIgnorePatterns: ['/node_modules/(?!(prop-types|@teambit))']
+};
+\`\`\`
+
+### Webpack
+
+Bit uses webpack 5 to bundle components. You can modify the \`webpack.config.js\` file to add your own configurations which will then be merged with the default configs set by teambit.
+
+Example:
+
+\`\`\`ts
+module.exports = {
+  module: {
+    // add your custom rules here
+    rules: []
+  }
+};
+\`\`\`
+
+### ESLint
+
+Bit uses ESLint to lint your components. You can add your own rules in the \`${name}.main.runtime\` file.
+
+Example:
+
+\`\`\`ts
+react.useEslint({
+  transformers: [
+    (config) => {
+      config.setRule('no-console', ['error']);
+      // add more rules here
+      return config;
+    }
+  ]
+}),
+\`\`\`
+
+To use ESLint:
+
+\`\`\`bash
+bit lint
+bit lint --fix
+\`\`\`
+
+### Formatting
+
+Bit uses Prettier to format your components. You can add your own rules in the \`${name}.main.runtime\` file.
+
+Example:
+
+\`\`\`ts
+react.usePrettier({
+  transformers: [
+    (config) => {
+      config.setKey('tabWidth', 2);
+      // add more rules here
+      return config;
+    }
+  ]
+}),
+\`\`\`
+
+To use Prettier:
+
+\`\`\`bash
+bit format --check
+bit format
+\`\`\`
+
+### Dependencies
+
+Override the default dependencies in the \`${name}.main.runtime\` file to include react types of a different version for example.
+
+\`\`\`ts
+react.overrideDependencies({
+  devDependencies: {
+    '@types/react': '17.0.3'
+  }
+});
+\`\`\`
+
+## Preview Configurations
+
+Extend the \`${name}.preview.runtime\` file when you want to add your own customizations only for previewing in the Bit UI.
+
+### Adding a Theme
+
+A custom theme has been added to the env which wraps all the composition files with the required theme so they can be developed with the correct themeing rather than the browsers default. This is added only in the preview runtime and not in the main runtime meaning it is only applied to compositions and not when consuming components. Adding a theme when consuming should be done at App level as you component may be consumed in various apps and have different themes applied depending on where it is consumed.
+
+Example:
+
+\`\`\`ts
+react.registerProvider([ThemeCompositions]);
+`;
+}

package/templates/react-env/files/index.ts

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

package/templates/react-env/files/jest.config.ts

@@ -0,0 +1,21 @@
+export function jestConfigFile() {
+  return `
+  // Override the Jest config to ignore transpiling from specific folders
+  // See the base Jest config: https://bit.dev/teambit/react/react/~code/jest/jest.config.js
+
+  // const reactJestConfig = require('@teambit/react/jest/jest.config');
+  // uncomment the line below and install the package if you want to use this function
+  // const {
+  //   generateNodeModulesPattern,
+  // } = require('@teambit/dependencies.modules.packages-excluder');
+  // const packagesToExclude = ['prop-types', '@teambit'];
+
+  // module.exports = {
+  //   ...reactJestConfig,
+  //   transformIgnorePatterns: [
+  //     ...reactJestConfig.transformIgnorePatterns,
+  //     '/' + generateNodeModulesPattern({ packages: packagesToExclude }),
+  //   ],
+  // };
+  `;
+}

package/templates/react-env/files/main.runtime.ts

@@ -0,0 +1,84 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function mainRuntimeFile({ namePascalCase: Name, name }: ComponentContext) {
+  return `import { MainRuntime } from '@teambit/cli';
+import { ReactAspect, ReactMain } from '@teambit/react';
+import { EnvsAspect, EnvsMain } from '@teambit/envs';
+import { ${Name}Aspect } from './${name}.aspect';
+// import { previewConfigTransformer, devServerConfigTransformer } from './webpack/webpack-transformers';
+
+/**
+ * Uncomment to include config files for overrides of Typescript or Webpack
+ */
+// const tsconfig = require('./typescript/tsconfig');
+
+export class ${Name}Main {
+  static slots = [];
+
+  static dependencies = [ReactAspect, EnvsAspect];
+
+  static runtime = MainRuntime;
+
+  static async provider([react, envs]: [ReactMain, EnvsMain]) {
+    const templatesReactEnv = envs.compose(react.reactEnv, [
+      /**
+       * Uncomment to override the config files for TypeScript, Webpack or Jest
+       * Your config gets merged with the defaults
+       */
+
+      // react.overrideTsConfig(tsconfig),
+      // react.useWebpack({
+      //   previewConfig: [previewConfigTransformer],
+      //   devServerConfig: [devServerConfigTransformer],
+      // }),
+      // react.overrideJestConfig(require.resolve('./jest/jest.config')),
+
+      /**
+       * override the ESLint default config here then check your files for lint errors
+       * @example
+       * bit lint
+       * bit lint --fix
+       */
+      react.useEslint({
+        transformers: [
+          (config) => {
+            config.setRule('no-console', ['error']);
+            return config;
+          }
+        ]
+      }),
+
+      /**
+       * override the Prettier default config here the check your formatting
+       * @example
+       * bit format --check
+       * bit format
+       */
+      react.usePrettier({
+        transformers: [
+          (config) => {
+            config.setKey('tabWidth', 2);
+            return config;
+          }
+        ]
+      }),
+
+      /**
+       * override dependencies here
+       * @example
+       * Uncomment types to include version 17.0.3 of the types package
+       */
+      react.overrideDependencies({
+        devDependencies: {
+          // '@types/react': '17.0.3'
+        }
+      })
+    ]);
+    envs.registerEnv(templatesReactEnv);
+    return new ${Name}Main();
+  }
+}
+
+${Name}Aspect.addRuntime(${Name}Main);
+`;
+}

package/templates/react-env/files/preview.runtime.ts

@@ -0,0 +1,27 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function previewRuntimeFile({ namePascalCase: Name, nameCamelCase: nameCamel, name }: ComponentContext) {
+  return `import { PreviewRuntime } from '@teambit/preview';
+import { ReactAspect, ReactPreview } from '@teambit/react';
+// uncomment the line below and install the theme if you want to use our theme or create your own and import it here
+// import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+
+import { ${Name}Aspect } from './${name}.aspect';
+
+export class ${Name}PreviewMain {
+  static runtime = PreviewRuntime;
+
+  static dependencies = [ReactAspect];
+
+  static async provider([react]: [ReactPreview]) {
+    const ${nameCamel}PreviewMain = new ${Name}PreviewMain();
+    // uncomment the line below to register a new provider to wrap all compositions using this environment with a custom theme.
+    // react.registerProvider([ThemeCompositions]);
+
+    return ${nameCamel}PreviewMain;
+  }
+}
+
+${Name}Aspect.addRuntime(${Name}PreviewMain);
+`;
+}

package/templates/react-env/files/typescript.config.ts

@@ -0,0 +1,21 @@
+export function typescriptConfigFile() {
+  return `{
+  // add your compiler options here
+
+  "compilerOptions": {
+    // "target": "es2017",
+    // "module": "es2015",
+    // "moduleResolution": "node",
+    // "lib": ["es2017", "dom"],
+    // "experimentalDecorators": true,
+    // "esModuleInterop": true,
+    // "outDir": "dist",
+    // "sourceMap": true,
+    // "emitDecoratorMetadata": true,
+    // "allowJs": true,
+    // "baseUrl": ".",
+    // "jsx": "react"
+  }
+}
+`;
+}

package/templates/react-env/files/webpack.config.ts

@@ -0,0 +1,48 @@
+export function webpackConfigFile() {
+  return `
+  import { WebpackConfigTransformer, WebpackConfigMutator, WebpackConfigTransformContext } from '@teambit/webpack';
+
+  /**
+   * Transformation to apply for both preview and dev server
+   * @param config
+   * @param _context
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  function commonTransformation(config: WebpackConfigMutator, _context: WebpackConfigTransformContext) {
+    // Merge config with the webpack.config.js file if you choose to import a module export format config.
+    // config.merge([webpackConfig]);
+    // config.addAliases({});
+    // config.addModuleRule(youRuleHere);
+    return config;
+  }
+
+  /**
+   * Transformation for the preview only
+   * @param config
+   * @param context
+   * @returns
+   */
+  export const previewConfigTransformer: WebpackConfigTransformer = (
+    config: WebpackConfigMutator,
+    context: WebpackConfigTransformContext
+  ) => {
+    const newConfig = commonTransformation(config, context);
+    return newConfig;
+  };
+
+  /**
+   * Transformation for the dev server only
+   * @param config
+   * @param context
+   * @returns
+   */
+  export const devServerConfigTransformer: WebpackConfigTransformer = (
+    config: WebpackConfigMutator,
+    context: WebpackConfigTransformContext
+  ) => {
+    const newConfig = commonTransformation(config, context);
+    return newConfig;
+  };
+
+`;
+}

package/templates/react-env/index.ts

@@ -0,0 +1,51 @@
+import { ComponentContext, ComponentTemplate } from '@teambit/generator';
+import { indexFile } from './files/index';
+import { docFile } from './files/doc';
+import { mainRuntimeFile } from './files/main.runtime';
+import { previewRuntimeFile } from './files/preview.runtime';
+import { aspectFile } from './files/aspect';
+import { webpackConfigFile } from './files/webpack.config';
+import { typescriptConfigFile } from './files/typescript.config';
+import { jestConfigFile } from './files/jest.config';
+
+export const reactEnvTemplate: ComponentTemplate = {
+  name: 'react-env',
+  description: 'customize the base React env with your configs and tools',
+  generateFiles: (context: ComponentContext) => {
+    return [
+      {
+        relativePath: 'index.ts',
+        content: indexFile(context),
+        isMain: true,
+      },
+      {
+        relativePath: `${context.name}.docs.mdx`,
+        content: docFile(context),
+      },
+      {
+        relativePath: `${context.name}.main.runtime.ts`,
+        content: mainRuntimeFile(context),
+      },
+      {
+        relativePath: `${context.name}.preview.runtime.ts`,
+        content: previewRuntimeFile(context),
+      },
+      {
+        relativePath: `${context.name}.aspect.ts`,
+        content: aspectFile(context),
+      },
+      {
+        relativePath: `webpack/webpack-transformers.ts`,
+        content: webpackConfigFile(),
+      },
+      {
+        relativePath: `typescript/tsconfig.json`,
+        content: typescriptConfigFile(),
+      },
+      {
+        relativePath: `jest/jest.config.js`,
+        content: jestConfigFile(),
+      },
+    ];
+  },
+};

package/templates/react-hook/files/component.ts

@@ -0,0 +1,16 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const componentFile = (context: ComponentContext) => {
+  const { name, nameCamelCase: Name } = context;
+  return {
+    relativePath: `${name}.tsx`,
+    content: `import { useState } from 'react';
+
+export function ${Name}() {
+  const [count, setCount] = useState(0)
+  const increment = () => setCount((c) => c + 1)
+  return { count, increment }
+}
+`,
+  };
+};

package/templates/react-hook/files/composition.ts

@@ -0,0 +1,23 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const compositionFile = (context: ComponentContext) => {
+  const { name, nameCamelCase: Name } = context;
+
+  return {
+    relativePath: `${name}.composition.tsx`,
+    content: `import React from 'react';
+import { ${Name} } from './${name}';
+
+export const Basic${Name} = () => {
+  const { count, increment } = ${Name}();
+
+  return (
+    <>
+      <h1>The count is {count}</h1>
+      <button onClick={increment}>increment</button>
+    </>
+  );
+};
+`,
+  };
+};

package/templates/react-hook/files/docs.ts

@@ -0,0 +1,33 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const docsFile = (context: ComponentContext) => {
+  const { name, nameCamelCase: Name } = context;
+
+  return {
+    relativePath: `${name}.docs.mdx`,
+    content: `---
+description: 'A React Hook that increments a count by 1 each time it is called.'
+labels: ['hook', 'counter']
+---
+
+import { ${Name} } from './${name}';
+
+## A React Hook to increment a count
+
+Increments the state of \`count\` by 1 each time \`increment\` is called
+
+### Component usage
+
+In this example clicking the button calls \`increment\` which increments the \`count\` by 1
+
+\`\`\`js
+import { ${Name} } from './${name}';
+
+const { count, increment } = ${Name}();
+
+<h1>The count is {count}</h1>
+<button onClick={increment}>increment</button>
+\`\`\`
+`,
+  };
+};

package/templates/react-hook/files/test.ts

@@ -0,0 +1,20 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const testFile = (context: ComponentContext) => {
+  const { name, nameCamelCase: Name } = context;
+
+  return {
+    relativePath: `${name}.spec.tsx`,
+    content: `import { renderHook, act } from '@testing-library/react-hooks';
+import { ${Name} } from './${name}';
+
+it('should increment counter', () => {
+  const { result } = renderHook(() => ${Name}())
+  act(() => {
+    result.current.increment()
+  })
+  expect(result.current.count).toBe(1)
+})
+`,
+  };
+};

package/templates/react-hook/index.ts

@@ -0,0 +1,21 @@
+import { ComponentTemplate, ComponentContext } from '@teambit/generator';
+import { componentFile } from './files/component';
+import { compositionFile } from './files/composition';
+import { docsFile } from './files/docs';
+import { testFile } from './files/test';
+
+export const reactHook: ComponentTemplate = {
+  name: 'react-hook',
+  description: 'a react hook component',
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, nameCamelCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.ts',
+      content: `export { ${Name} } from './${name}';
+`,
+    };
+
+    return [indexFile, componentFile(context), compositionFile(context), docsFile(context), testFile(context)];
+  },
+};

package/templates/react-workspace/index.ts

@@ -0,0 +1,27 @@
+import { WorkspaceContext, WorkspaceTemplate } from '@teambit/generator';
+import { generateFiles as generateCommonFiles } from '../workspace-common';
+
+export const reactWorkspaceTemplate: WorkspaceTemplate = {
+  name: 'react',
+  description: 'React workspace with demo components',
+  generateFiles: async (context: WorkspaceContext) => {
+    return generateCommonFiles(context);
+  },
+  importComponents: () => {
+    return [
+      {
+        id: 'teambit.react/templates/envs/my-react',
+        targetName: 'envs/my-react',
+        path: 'demo/envs/my-react',
+      },
+      { id: 'teambit.react/templates/ui/text', targetName: 'ui/text', path: 'demo/ui/text' },
+      { id: 'teambit.react/templates/ui/heading', targetName: 'ui/heading', path: 'demo/ui/heading' },
+      { id: 'teambit.react/templates/ui/card', targetName: 'ui/card', path: 'demo/ui/card' },
+      {
+        id: 'teambit.react/templates/pages/welcome',
+        targetName: 'pages/welcome',
+        path: 'demo/pages/welcome',
+      },
+    ];
+  },
+};

package/templates/react-workspace-app/index.ts

@@ -0,0 +1,20 @@
+import { WorkspaceContext, WorkspaceTemplate } from '@teambit/generator';
+import { generateFiles as generateCommonFiles } from '../workspace-common';
+
+export const reactWorkspaceAppTemplate: WorkspaceTemplate = {
+  name: 'react-app',
+  description: 'EXPERIMENTAL. react workspace for an app',
+  hidden: true,
+  generateFiles: async (context: WorkspaceContext) => {
+    return generateCommonFiles(context);
+  },
+  importComponents: () => {
+    return [
+      { id: 'teambit.react/templates/apps/my-app', path: 'apps/my-app' },
+      { id: 'teambit.react/templates/envs/my-react', path: 'envs/my-react' },
+      { id: 'teambit.react/templates/themes/theme', path: 'themes/theme' },
+      { id: 'teambit.react/templates/styles/colors', path: 'styles/colors' },
+      { id: 'teambit.react/templates/ui/heading', path: 'ui/heading' },
+    ];
+  },
+};

package/templates/react-workspace-deprecated/index.ts

@@ -0,0 +1,28 @@
+import { WorkspaceContext, WorkspaceTemplate } from '@teambit/generator';
+import { generateFiles as generateCommonFiles } from '../workspace-common';
+
+export const deprecatedReactWorkspaceTemplate: WorkspaceTemplate = {
+  name: 'react-workspace',
+  description: 'React workspace with demo components',
+  hidden: true,
+  generateFiles: async (context: WorkspaceContext) => {
+    return generateCommonFiles(context);
+  },
+  importComponents: () => {
+    return [
+      {
+        id: 'teambit.react/templates/envs/my-react',
+        targetName: 'envs/my-react',
+        path: 'demo/envs/my-react',
+      },
+      { id: 'teambit.react/templates/ui/text', targetName: 'ui/text', path: 'demo/ui/text' },
+      { id: 'teambit.react/templates/ui/heading', targetName: 'ui/heading', path: 'demo/ui/heading' },
+      { id: 'teambit.react/templates/ui/card', targetName: 'ui/card', path: 'demo/ui/card' },
+      {
+        id: 'teambit.react/templates/pages/welcome',
+        targetName: 'pages/welcome',
+        path: 'demo/pages/welcome',
+      },
+    ];
+  },
+};

package/templates/react-workspace-lib/index.ts

@@ -0,0 +1,21 @@
+import { WorkspaceContext, WorkspaceTemplate } from '@teambit/generator';
+import { generateFiles as generateCommonFiles } from '../workspace-common';
+
+export const reactWorkspaceLibTemplate: WorkspaceTemplate = {
+  name: 'react-lib',
+  description: 'EXPERIMENTAL. react workspace for a component library',
+  hidden: true,
+  generateFiles: async (context: WorkspaceContext) => {
+    return generateCommonFiles(context);
+  },
+  importComponents: () => {
+    return [
+      { id: 'teambit.react/templates/envs/my-react', targetName: 'envs/my-react', path: 'demo/envs/my-react' },
+      { id: 'teambit.react/templates/ui/text', targetName: 'ui/text', path: 'demo/ui/text' },
+      { id: 'teambit.react/templates/ui/heading', targetName: 'ui/heading', path: 'demo/ui/heading' },
+      { id: 'teambit.react/templates/ui/card', targetName: 'ui/card', path: 'demo/ui/card' },
+      { id: 'teambit.react/templates/styles/colors', targetName: 'styles/colors', path: 'demo/styles/colors' },
+      { id: 'teambit.react/templates/themes/theme', targetName: 'themes/theme', path: 'demo/themes/theme' },
+    ];
+  },
+};

package/templates/workspace-common/files/eslint-config.ts

@@ -0,0 +1,6 @@
+export const eslintConfig = `module.exports = {
+  extends: ['@teambit/eslint-config-bit-react'],
+  parserOptions: {
+    project: './tsconfig.json'
+  },
+}`;