feat(proj-plugins): cross-check for project-plugins and project-gener…

…ators (#534)
teleporthq · Feb 3, 2021 · 909285c · 909285c
1 parent 1b2a976
commit 909285c
Show file tree

Hide file tree

Showing 16 changed files with 28 additions and 1 deletion.
diff --git a/packages/teleport-project-generator-angular/src/index.ts b/packages/teleport-project-generator-angular/src/index.ts
@@ -26,6 +26,7 @@ const createAngularProjectGenerator = () => {
   const pagesModuleGeneratorAngularPlugin = createAngularModulePlugin({ moduleType: 'page' })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-angular',
     components: {
       generator: createAngularComponentGenerator,
       mappings: [AngularProjectMapping as Mapping],

diff --git a/packages/teleport-project-generator-gatsby/src/index.ts b/packages/teleport-project-generator-gatsby/src/index.ts
@@ -26,6 +26,7 @@ import { createCustomHTMLEntryFile, styleSheetDependentConfigGenerator } from '.
 
 const createGatsbyProjectGenerator = () => {
   const generator = createProjectGenerator({
+    id: 'teleport-project-gatsby',
     components: {
       generator: createCustomReactGatsbyComponentGenerator,
       path: ['src', 'components'],

diff --git a/packages/teleport-project-generator-gridsome/src/index.ts b/packages/teleport-project-generator-gridsome/src/index.ts
@@ -17,6 +17,7 @@ const createGridsomeProjectGenerator = () => {
   })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-gridsome',
     components: {
       generator: createVueComponentGenerator,
       mappings: [GridsomeProjectMapping as Mapping],

diff --git a/packages/teleport-project-generator-next/src/index.ts b/packages/teleport-project-generator-next/src/index.ts
@@ -22,6 +22,7 @@ const createNextProjectGenerator = () => {
   })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-next',
     style: ReactStyleVariation.StyledJSX,
     components: {
       generator: createReactComponentGenerator,

diff --git a/packages/teleport-project-generator-nuxt/src/index.ts b/packages/teleport-project-generator-nuxt/src/index.ts
@@ -17,6 +17,7 @@ const createNuxtProjectGenerator = () => {
   })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-nuxt',
     components: {
       generator: createVueComponentGenerator,
       mappings: [NuxtMapping as Mapping],

diff --git a/packages/teleport-project-generator-preact/src/index.ts b/packages/teleport-project-generator-preact/src/index.ts
@@ -27,6 +27,7 @@ const createPreactProjectGenerator = () => {
   const routerPlugin = createReactAppRoutingPlugin({ flavor: 'preact' })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-preact',
     style: PreactStyleVariation.CSSModules,
     components: {
       generator: createPreactComponentGenerator,

diff --git a/packages/teleport-project-generator-react/src/index.ts b/packages/teleport-project-generator-react/src/index.ts
@@ -17,6 +17,7 @@ import ReactTemplate from './project-template'
 
 const createReactProjectGenerator = () => {
   const generator = createProjectGenerator({
+    id: 'teleport-project-react',
     style: ReactStyleVariation.CSSModules,
     components: {
       generator: createReactComponentGenerator,

diff --git a/packages/teleport-project-generator-reactnative/src/index.ts b/packages/teleport-project-generator-reactnative/src/index.ts
@@ -12,6 +12,7 @@ import ReactNativeTemplate from './reactnative-project-template'
 
 const createReactNativeProjectGenerator = () => {
   const generator = createProjectGenerator({
+    id: 'teleport-project-react-native',
     components: {
       generator: createReactNativeComponentGenerator,
       mappings: [ReactNativeProjectMapping as Mapping],

diff --git a/packages/teleport-project-generator-stencil/src/index.ts b/packages/teleport-project-generator-stencil/src/index.ts
@@ -21,6 +21,7 @@ const createStencilProjectGenerator = () => {
   })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-stencil',
     components: {
       generator: createStencilComponentGenerator,
       mappings: [StencilProjectMapping as Mapping],

diff --git a/packages/teleport-project-generator-vue/src/index.ts b/packages/teleport-project-generator-vue/src/index.ts
@@ -16,6 +16,7 @@ const createVueProjectGenerator = () => {
   const vueHeadConfigPlugin = createVueHeadConfigPlugin({ metaObjectKey: 'metaInfo' })
 
   const generator = createProjectGenerator({
+    id: 'teleport-project-vue',
     components: {
       generator: createVueComponentGenerator,
       mappings: [VueProjectMapping as Mapping],

diff --git a/packages/teleport-project-plugin-gatsby-styled-components/src/index.ts b/packages/teleport-project-plugin-gatsby-styled-components/src/index.ts
@@ -14,6 +14,10 @@ class PluginGatsbyStyledComponents implements ProjectPlugin {
   async runBefore(structure: ProjectPluginStructure) {
     const { strategy } = structure
 
+    if (strategy.id !== 'teleport-project-gatsby') {
+      throw new Error('Plugin can be used only with teleport-project-gatsby')
+    }
+
     strategy.style = GatsbyStyleVariation.StyledComponents
     delete strategy.framework.config
     if (strategy?.projectStyleSheet?.generator) {

diff --git a/packages/teleport-project-plugin-next-css-modules/src/index.ts b/packages/teleport-project-plugin-next-css-modules/src/index.ts
@@ -11,6 +11,10 @@ class PluginNextCSSModules implements ProjectPlugin {
   async runBefore(structure: ProjectPluginStructure) {
     const { strategy } = structure
 
+    if (strategy.id !== 'teleport-project-next') {
+      throw new Error('Plugin can be used only with teleport-project-next')
+    }
+
     strategy.style = ReactStyleVariation.CSSModules
     if (strategy?.projectStyleSheet?.generator) {
       strategy.projectStyleSheet.plugins = [createStyleSheetPlugin({ moduleExtension: true })]

diff --git a/packages/teleport-project-plugin-next-react-jss/src/index.ts b/packages/teleport-project-plugin-next-react-jss/src/index.ts
@@ -13,6 +13,10 @@ class PluginNextReactJSS implements ProjectPlugin {
   async runBefore(structure: ProjectPluginStructure) {
     const { strategy } = structure
 
+    if (strategy.id !== 'teleport-project-next') {
+      throw new Error('Plugin can be used only with teleport-project-next')
+    }
+
     strategy.style = ReactStyleVariation.ReactJSS
     if (strategy?.projectStyleSheet?.generator) {
       strategy.projectStyleSheet.plugins = [createStyleSheetPlugin(), importStatementsPlugin]

diff --git a/packages/teleport-project-plugin-next-styled-components/src/index.ts b/packages/teleport-project-plugin-next-styled-components/src/index.ts
@@ -13,6 +13,10 @@ class PluginNextStyledComponents implements ProjectPlugin {
   async runBefore(structure: ProjectPluginStructure) {
     const { strategy } = structure
 
+    if (strategy.id !== 'teleport-project-next') {
+      throw new Error('Plugin can be used only with teleport-project-next')
+    }
+
     strategy.style = ReactStyleVariation.StyledComponents
     if (strategy?.projectStyleSheet?.generator) {
       strategy.projectStyleSheet.plugins = [createStyleSheetPlugin(), importStatementsPlugin]

diff --git a/packages/teleport-test/src/standalone.ts b/packages/teleport-test/src/standalone.ts
@@ -11,7 +11,7 @@ const reactProjectUIDL = (reactProjectJSON as unknown) as ProjectUIDL
 const assetFile = readFileSync(join(__dirname, 'asset.png'))
 const base64File = Buffer.from(assetFile).toString('base64')
 const packerOptions: PackerOptions = {
-  publisher: PublisherType.CODESANDBOX,
+  publisher: PublisherType.DISK,
   projectType: ProjectType.REACT,
   publishOptions: {
     outputPath: 'dist',

diff --git a/packages/teleport-types/src/generators.ts b/packages/teleport-types/src/generators.ts
@@ -165,6 +165,7 @@ export interface GeneratorFactoryParams {
 export type ComponentGeneratorInstance = (params?: GeneratorFactoryParams) => ComponentGenerator
 
 export interface ProjectStrategy {
+  id: string
   style?: StyleVariation
   components: {
     generator: ComponentGeneratorInstance