@teambit/generator 0.0.1144 → 0.0.1146

package/templates/starter-standalone/index.ts

@@ -0,0 +1,44 @@
+import { ComponentContext, ComponentTemplate } from '@teambit/generator';
+import { indexFile } from './files/index';
+import { starterFile } from './files/starter';
+import { docFile } from './files/doc-file';
+import { gitIgnoreTemplate } from './files/git-ignore-tpl';
+import { workspaceConfigTemplate } from './files/workspace-config-tpl';
+
+export const starterTemplate: ComponentTemplate = {
+  name: 'standalone-starter',
+  description:
+    'create your own workspace starter (standalone) - \nDocs: https://bit.dev/reference/starters/create-starter',
+  generateFiles: (context: ComponentContext) => {
+    return [
+      {
+        relativePath: 'index.ts',
+        content: indexFile(context),
+        isMain: true,
+      },
+      {
+        relativePath: `${context.name}.starter.ts`,
+        content: starterFile(context),
+      },
+      {
+        relativePath: `${context.name}.docs.mdx`,
+        content: docFile(context),
+      },
+      {
+        relativePath: 'template/files/git-ignore.ts',
+        content: gitIgnoreTemplate(),
+      },
+
+      {
+        relativePath: 'template/files/workspace-config.ts',
+        content: workspaceConfigTemplate(),
+      },
+    ];
+  },
+  config: {
+    'teambit.harmony/aspect': {},
+    'teambit.envs/envs': {
+      env: 'teambit.harmony/aspect',
+    },
+  },
+};

package/dist/templates/component-generator/files/aspect-file.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["aspectFile","namePascalCase","componentId"],"sources":["aspect-file.ts"],"sourcesContent":["import { ComponentContext } from '@teambit/generator';\n\nexport function aspectFile({ namePascalCase, componentId }: ComponentContext) {\n  return `import { Aspect } from '@teambit/harmony';\n\nexport const ${namePascalCase}Aspect = Aspect.create({\n  id: '${componentId}',\n});\n  `;\n}\n"],"mappings":";;;;;;AAEO,SAASA,UAAUA,CAAC;EAAEC,cAAc;EAAEC;AAA8B,CAAC,EAAE;EAC5E,OAAQ;AACV;AACA,eAAeD,cAAe;AAC9B,SAASC,WAAY;AACrB;AACA,GAAG;AACH"}

package/dist/templates/component-generator/files/main-runtime.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["mainRuntime","name","namePascalCase"],"sources":["main-runtime.ts"],"sourcesContent":["import { ComponentContext } from '@teambit/generator';\n\nexport function mainRuntime({ name, namePascalCase }: ComponentContext) {\n  return `import { MainRuntime } from '@teambit/cli';\nimport { GeneratorMain, GeneratorAspect, ComponentContext } from '@teambit/generator';\nimport { ${namePascalCase}Aspect } from './${name}.aspect';\n\nexport class ${namePascalCase}Main {\n  static slots = [];\n  static dependencies = [GeneratorAspect];\n  static runtime = MainRuntime;\n  static async provider([generator]: [GeneratorMain]) {\n  /**\n  * Array of templates. Add as many templates as you want\n  * Separate the templates to multiple files if you prefer\n  * Modify, add or remove files as needed\n  * See the docs file of this component for more info\n  */\n\n  if (generator) generator.registerComponentTemplate([\n      {\n        name: 'component1',\n        description: 'description for component1',\n        generateFiles: (context: ComponentContext) => {\n          return [\n\n            // index file\n            {\n              relativePath: 'index.ts',\n              isMain: true,\n              content: \\`export { \\${context.namePascalCase} } from './\\${context.name}';\nexport type { \\${context.namePascalCase}Props } from './\\${context.name}';\n\\`,\n            },\n\n            // component file\n            {\n              relativePath: \\`\\${context.name}.tsx\\`,\n              content: \\`import React from 'react';\n\nexport type \\${context.namePascalCase}Props = {\n  /**\n   * a text to be rendered in the component.\n   */\n  text: string\n};\n\nexport function \\${context.namePascalCase}({ text }: \\${context.namePascalCase}Props) {\n  return (\n    <div>\n      {text}\n    </div>\n  );\n}\\`,\n            },\n\n            // docs file\n            {\n              relativePath: \\`\\${context.name}.docs.mdx\\`,\n              content: \\`---\ndescription: 'A React Component for rendering text.'\nlabels: ['text', 'ui']\n---\n\nimport { \\${context.namePascalCase} } from './\\${context.name}';\n\\`\n            },\n\n            // composition file\n            {\n              relativePath: \\`\\${context.name}.composition.tsx\\`,\n              content: \\`import React from 'react';\nimport { \\${context.namePascalCase} } from './\\${context.name}';\n\nexport const Basic\\${context.namePascalCase}  = () => (\n  <\\${context.namePascalCase}  text=\"hello from \\${context.namePascalCase} \" />\n);\n\\`\n            },\n\n            // test file\n            {\n              relativePath: \\`\\${context.name}.spec.tsx\\`,\n              content: \\`import React from 'react';\nimport { render } from '@testing-library/react';\nimport { Basic\\${context.namePascalCase} } from './\\${context.name}.composition';\n\nit('should render with the correct text', () => {\n  const { getByText } = render(<Basic\\${context.namePascalCase} />);\n  const rendered = getByText('hello from \\${context.namePascalCase}');\n  expect(rendered).toBeTruthy();\n});\n\\`\n            },\n            // add more files here such as css/sass\n          ];\n        },\n      },\n\n    // component 2\n    {\n        name: 'component2',\n        description: 'description for component2',\n        generateFiles: (context: ComponentContext) => {\n          return [\n\n            // index file\n            {\n              relativePath: 'index.ts',\n              isMain: true,\n              content: \\`export {} from '';\n\\`,\n            },\n          ]\n        }\n      }\n    ]);\n\n    return new ${namePascalCase}Main();\n  }\n}\n\n${namePascalCase}Aspect.addRuntime(${namePascalCase}Main);\n`;\n}\n"],"mappings":";;;;;;AAEO,SAASA,WAAWA,CAAC;EAAEC,IAAI;EAAEC;AAAiC,CAAC,EAAE;EACtE,OAAQ;AACV;AACA,WAAWA,cAAe,oBAAmBD,IAAK;AAClD;AACA,eAAeC,cAAe;AAC9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,iBAAiBA,cAAe;AAChC;AACA;AACA;AACA,EAAEA,cAAe,qBAAoBA,cAAe;AACpD,CAAC;AACD"}

package/dist/templates/starter/files/docs-file.d.ts

@@ -1 +0,0 @@
-export declare function docsFile(): string;

package/dist/templates/starter/files/docs-file.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.docsFile = docsFile;
-function docsFile() {
-  return `---
-description: Generator for generating a workspace
-labels: ['generator', 'templates', 'workspace']
----
-
-## 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>
-\`\`\`
-`;
-}
-
-//# sourceMappingURL=docs-file.js.map

package/dist/templates/starter/files/docs-file.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["docsFile"],"sources":["docs-file.ts"],"sourcesContent":["export function docsFile() {\n  return `---\ndescription: Generator for generating a workspace\nlabels: ['generator', 'templates', 'workspace']\n---\n\n## Registering your Workspace\n\nRegister your workspace template under the aspect environment in the variants section of the workspace.jsonc file.\n\n\\`\\`\\`json\n\"teambit.workspace/variants\": {\n    \"{workspace-name}\": {\n      \"teambit.harmony/aspect\": {}\n    }\n  }\n\\`\\`\\`\n\n## Customizing your Workspace\n\nSee the docs for more info on [Customizing your Generator](https://harmony-docs.bit.dev/extending-bit/creating-a-custom-workspace-generator)\n\n## Using the Workspace Generator\n\nHow to use this generator locally, essentially for development purposes:\n\n\\`\\`\\`js\nbit new <template-name> <workspace-name> --load-from /Users/me/path/to/this/dir --aspect <workspace-template-id>\n\\`\\`\\`\n\nHow to use this generator after exporting to a remote scope:\n\n\\`\\`\\`js\nbit new <template-name> <workspace-name> --aspect <workspace-template-id>\n\\`\\`\\`\n`;\n}\n"],"mappings":";;;;;;AAAO,SAASA,QAAQA,CAAA,EAAG;EACzB,OAAQ;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;AACD"}

package/dist/templates/starter/files/readme-tpl.d.ts

@@ -1 +0,0 @@
-export declare function readmeTemplate(): string;

package/dist/templates/starter/files/readme-tpl.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.readmeTemplate = readmeTemplate;
-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>
-\\\`\\\`\\\`
-\`;
-}
-`;
-}
-
-//# sourceMappingURL=readme-tpl.js.map

package/dist/templates/starter/files/readme-tpl.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["readmeTemplate"],"sources":["readme-tpl.ts"],"sourcesContent":["export function readmeTemplate() {\n  return `export function readme() {\n  return \\`## Workspace Generator\n\nEasily generate a new workspace with a single command.\n\n## Registering your Workspace\n\nRegister your workspace template under the aspect environment in the variants section of the workspace.jsonc file.\n\n\\\\\\`\\\\\\`\\\\\\`json\n\"teambit.workspace/variants\": {\n    \"{workspace-name}\": {\n      \"teambit.harmony/aspect\": {}\n    }\n  }\n\\\\\\`\\\\\\`\\\\\\`\n\n## Customizing your Workspace\n\nSee the docs for more info on [Customizing your Generator](https://harmony-docs.bit.dev/extending-bit/creating-a-custom-workspace-generator)\n\n## Using the Workspace Generator\n\nHow to use this generator locally, essentially for development purposes:\n\n\\\\\\`\\\\\\`\\\\\\`js\nbit new <template-name> <workspace-name> --load-from /Users/me/path/to/this/dir --aspect <workspace-template-id>\n\\\\\\`\\\\\\`\\\\\\`\n\nHow to use this generator after exporting to a remote scope:\n\n\\\\\\`\\\\\\`\\\\\\`js\nbit new <template-name> <workspace-name> --aspect <workspace-template-id>\n\\\\\\`\\\\\\`\\\\\\`\n\\`;\n}\n`;\n}\n"],"mappings":";;;;;;AAAO,SAASA,cAAcA,CAAA,EAAG;EAC/B,OAAQ;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;AACD"}

package/dist/templates/workspace-generator/index.d.ts

@@ -1,2 +0,0 @@
-import { ComponentTemplate } from '@teambit/generator';
-export declare const workspaceGeneratorTemplate: ComponentTemplate;

package/dist/templates/workspace-generator/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_starter","data","require","ownKeys","object","enumerableOnly","keys","Object","getOwnPropertySymbols","symbols","filter","sym","getOwnPropertyDescriptor","enumerable","push","apply","_objectSpread","target","i","arguments","length","source","forEach","key","_defineProperty2","default","getOwnPropertyDescriptors","defineProperties","defineProperty","workspaceGeneratorTemplate","starterTemplate","name","description","exports"],"sources":["index.ts"],"sourcesContent":["import { ComponentTemplate } from '@teambit/generator';\nimport { starterTemplate } from '../starter';\n\n// TODO: This is deprecated and should be removed once we update the docs to use the new starter template.\nexport const workspaceGeneratorTemplate: ComponentTemplate = {\n  ...starterTemplate,\n  name: 'workspace-generator',\n  description:\n    'DEPRECATED: use \"starter\" instead.\\ncreate your own workspace generator - \\nDocs: https://bit.dev/docs/dev-services/generator/generate-workspace',\n};\n"],"mappings":";;;;;;;;;;;;;;AACA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA6C,SAAAE,QAAAC,MAAA,EAAAC,cAAA,QAAAC,IAAA,GAAAC,MAAA,CAAAD,IAAA,CAAAF,MAAA,OAAAG,MAAA,CAAAC,qBAAA,QAAAC,OAAA,GAAAF,MAAA,CAAAC,qBAAA,CAAAJ,MAAA,GAAAC,cAAA,KAAAI,OAAA,GAAAA,OAAA,CAAAC,MAAA,WAAAC,GAAA,WAAAJ,MAAA,CAAAK,wBAAA,CAAAR,MAAA,EAAAO,GAAA,EAAAE,UAAA,OAAAP,IAAA,CAAAQ,IAAA,CAAAC,KAAA,CAAAT,IAAA,EAAAG,OAAA,YAAAH,IAAA;AAAA,SAAAU,cAAAC,MAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAC,SAAA,CAAAC,MAAA,EAAAF,CAAA,UAAAG,MAAA,WAAAF,SAAA,CAAAD,CAAA,IAAAC,SAAA,CAAAD,CAAA,QAAAA,CAAA,OAAAf,OAAA,CAAAI,MAAA,CAAAc,MAAA,OAAAC,OAAA,WAAAC,GAAA,QAAAC,gBAAA,GAAAC,OAAA,EAAAR,MAAA,EAAAM,GAAA,EAAAF,MAAA,CAAAE,GAAA,SAAAhB,MAAA,CAAAmB,yBAAA,GAAAnB,MAAA,CAAAoB,gBAAA,CAAAV,MAAA,EAAAV,MAAA,CAAAmB,yBAAA,CAAAL,MAAA,KAAAlB,OAAA,CAAAI,MAAA,CAAAc,MAAA,GAAAC,OAAA,WAAAC,GAAA,IAAAhB,MAAA,CAAAqB,cAAA,CAAAX,MAAA,EAAAM,GAAA,EAAAhB,MAAA,CAAAK,wBAAA,CAAAS,MAAA,EAAAE,GAAA,iBAAAN,MAAA;AAE7C;AACO,MAAMY,0BAA6C,GAAAb,aAAA,CAAAA,aAAA,KACrDc,0BAAe;EAClBC,IAAI,EAAE,qBAAqB;EAC3BC,WAAW,EACT;AAAkJ,EACrJ;AAACC,OAAA,CAAAJ,0BAAA,GAAAA,0BAAA"}

package/templates/starter/files/docs-file.ts

@@ -1,37 +0,0 @@
-export function docsFile() {
-  return `---
-description: Generator for generating a workspace
-labels: ['generator', 'templates', 'workspace']
----
-
-## 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/starter/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/index.ts

@@ -1,10 +0,0 @@
-import { ComponentTemplate } from '@teambit/generator';
-import { starterTemplate } from '../starter';
-
-// TODO: This is deprecated and should be removed once we update the docs to use the new starter template.
-export const workspaceGeneratorTemplate: ComponentTemplate = {
-  ...starterTemplate,
-  name: 'workspace-generator',
-  description:
-    'DEPRECATED: use "starter" instead.\ncreate your own workspace generator - \nDocs: https://bit.dev/docs/dev-services/generator/generate-workspace',
-};