Merge pull request #9 from pagesource/bugfix/relative-path-fixes

vinodloha · web-flow · commit 288d85710cb8 · 2022-01-31T16:20:54.000+05:30
remove relative path hardcoding
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ the teams to maintain consistency across project and saves a lot of development
 
 Generate-plop is by default configured to generate files in [TypeScript](https://www.typescriptlang.org/) format. However, you can generate javascript files as well by passing --js flag in script command.
 
-![Demo](https://s10.gifyu.com/images/generate-plop.gif)
+![Demo](https://s10.gifyu.com/images/generate-plopd707158878537f9a.gif)
 
 ## Features
 
@@ -75,7 +75,7 @@ Its only dependent on two packages:
 
 ## Documentation
 
-[Documentation coming soon](https://linktodocumentation)
+[Documentation coming soon](https://github.com/pagesource/universal-react-docs/blob/master/docs/generate-plop.md)
 ## Contributors
 
 1. [Khushboo Kumari](https://github.com/khus29)
diff --git a/constants.js b/constants.js
@@ -7,6 +7,5 @@ export default {
   STORES_PATH: 'src/stores/',
   APPS_PATH: 'apps/',
   PACKAGES_PATH: 'packages/',
-  SERVICES: 'packages/services',
-  TYPES_SRC:'types'
+  SERVICES: 'packages/services'
 };
diff --git a/index.js b/index.js
@@ -3,12 +3,17 @@ const args = process.argv.slice(2);
 import { Plop, run} from "plop";
 import minimist from "minimist";
 const argv = minimist(args);
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
 Plop.prepare(
     {
       cwd: argv.cwd,
       preload: argv.preload || [],
-      configPath: `${process.cwd()}/node_modules/component-generator/plopfile.js`,
+      configPath: `${__dirname}/plopfile.js`,
       completion: argv.completion,
     },
     function (env) {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@xt-pagesource/generate-plop",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Generate new components fast and consistently.",
   "main": "index.js",
   "type": "module",
diff --git a/pages/index.js b/pages/index.js
@@ -9,7 +9,7 @@
 import componentExists from '../utils/componentExists.js'
 import monorepoQues from '../utils/monorepoHelpers.js'
 import config from '../constants.js'
-import {getComputedFolderPath, getFileExtension} from '../utils/common.js'
+import {getComputedFolderPath, getFileExtension,getRootDirectoryPath} from '../utils/common.js'
 
 const fileExtension = getFileExtension()
 
@@ -40,10 +40,12 @@ export default {
   ],
   actions: (data) => {
     // Generate pagename/index.js and pagename/test.js
+    const rootPath = getRootDirectoryPath()
+
     const pagePath =
       data.route.trim() !== ''
-        ? `../../${getComputedFolderPath(data.monorepoPath, config.PAGES_PATH)}/${data.route}`
-        : `../../${getComputedFolderPath(data.monorepoPath, config.PAGES_PATH)}`;
+        ? `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.PAGES_PATH)}/${data.route}`
+        : `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.PAGES_PATH)}`;
     
     const actions = [
       {
@@ -54,7 +56,7 @@ export default {
       },
       {
         type: 'modify',
-        path: `../../${getComputedFolderPath(data.monorepoPath, config.ROUTES_PATH)}/paths.${fileExtension}`,
+        path: `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.ROUTES_PATH)}/paths.${fileExtension}`,
         transform: (fileContents, data) => {
           let routeVarName =
             data.route.trim() !== ''
diff --git a/react-component/index.js b/react-component/index.js
@@ -9,7 +9,7 @@
 import componentExists from '../utils/componentExists.js'
 import monorepoQues from '../utils/monorepoHelpers.js'
 import config from '../constants.js'
-import {isTypescript, getComputedFolderPath, getFileExtension} from '../utils/common.js'
+import {isTypescript, getComputedFolderPath, getFileExtension, getRootDirectoryPath} from '../utils/common.js'
 
 const fileExtension = getFileExtension()
 
@@ -57,8 +57,9 @@ export default {
   ],
   actions: (data) => {
     // Generate index.ts/js and index.test.tsx/js
+    const rootPath = getRootDirectoryPath()
     let componentTemplate;
-    let folderPath = `../../${getComputedFolderPath(data.monorepoPath, config.COMPONENT_PATH)}${data.folder}`;
+    let folderPath = `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.COMPONENT_PATH)}${data.folder}`;
 
     switch (data.type) {
       case 'Class': {
diff --git a/react-hooks/index.js b/react-hooks/index.js
@@ -9,7 +9,7 @@
 import componentExists from '../utils/componentExists.js'
 import monorepoQues from '../utils/monorepoHelpers.js'
 import config from '../constants.js'
-import {getFileExtension, getComputedFolderPath} from '../utils/common.js'
+import {getFileExtension, getComputedFolderPath, getRootDirectoryPath} from '../utils/common.js'
 
 const fileExtension = getFileExtension()
 
@@ -36,7 +36,8 @@ export default {
   ],
   actions: (data) => {
     // Generate useHookName/index.js and useHookName/test.js
-    const folderPath = `../../${getComputedFolderPath(data.monorepoPath, config.HOOKS_PATH)}`;
+    const rootPath = getRootDirectoryPath()
+    const folderPath = `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.HOOKS_PATH)}`;
   
     const actions = [
       {
diff --git a/services/index.js b/services/index.js
@@ -8,7 +8,7 @@
 
 import componentExists from '../utils/componentExists.js'
 import config from '../constants.js'
-import {getComputedFolderPath, getFileExtension, isTypescript} from '../utils/common.js'
+import {getComputedFolderPath, getFileExtension, getRootDirectoryPath, isTypescript} from '../utils/common.js'
 
 const fileExtension = getFileExtension()
 
@@ -27,30 +27,42 @@ export default {
       name: 'name',
       message: 'What should it be called?',
       default: 'ChangeTitle',
-     
+      validate: (value) => {
+        value = `${value}Service`;
+        if (/.+/.test(value)) {
+            return componentExists(value, config.API_SRC, config.SERVICES)
+            ? 'A service with this name already exists '
+            : true;
+        }
+
+        return 'The name is required';
+      }
     }
   ],
   actions: (data) => {
     // Generate serviceName.js 
-    const folderPath =  `../../${getComputedFolderPath(config.SERVICES, config.API_SRC)}`
-     
+    const rootPath = getRootDirectoryPath()
+
+    const folderPath =  `${rootPath}/${getComputedFolderPath(config.SERVICES, config.API_SRC)}`
+    
     const actions = [
       {
         type: 'add',
         path: `${folderPath}/{{properCase name}}Service.${fileExtension}`,
         templateFile: data.isGraphql == 'yes'? `./services/${fileExtension}-templates/graphql.${fileExtension}.hbs` : `./services/${fileExtension}-templates/index.${fileExtension}.hbs`,
         abortOnFail: true
       }
+      
     ];
     if(isTypescript()) {
-      actions.push({
-        type: 'add',
-        path: `${folderPath}/types/common.ts`,
-        templateFile: `./services/${fileExtension}-templates/types.ts.hbs`,
-        abortOnFail: true,
-      });
-  } 
-
-    return actions;
+        actions.push({
+          type: 'add',
+          path: `${folderPath}/types/common.ts`,
+          templateFile: `./services/${fileExtension}-templates/types.ts.hbs`,
+          abortOnFail: true,
+        });
+      }
+      return actions;
+    
   }
 };
diff --git a/stores/index.js b/stores/index.js
@@ -9,7 +9,7 @@
 import componentExists from '../utils/componentExists.js'
 import monorepoQues from '../utils/monorepoHelpers.js'
 import config from '../constants.js'
-import {isTypescript, getComputedFolderPath, getFileExtension} from '../utils/common.js'
+import {isTypescript, getComputedFolderPath, getFileExtension, getRootDirectoryPath} from '../utils/common.js'
 
 const fileExtension = getFileExtension()
 
@@ -35,7 +35,8 @@ export default {
     }
   ],
   actions: (data) => {
-    const folderPath = `../../${getComputedFolderPath(data.monorepoPath, config.STORES_PATH)}`;
+    const rootPath = getRootDirectoryPath()
+    const folderPath = `${rootPath}/${getComputedFolderPath(data.monorepoPath, config.STORES_PATH)}`;
 
     const actions = [
       {
diff --git a/utils/common.js b/utils/common.js
@@ -1,7 +1,10 @@
 /**
  * common 
  */
-
+ import { dirname } from 'path';
+ import { fileURLToPath } from 'url';
+ 
+  
 /**
  * isTypescript - Based on script args, it returns if it is Typescript or javascript generate action
  * @returns {boolean}
@@ -28,4 +31,13 @@ export function getFileExtension() {
 
 export function getComputedFolderPath(monoropePath, resourcePath) {
     return monoropePath ? `${monoropePath}/${resourcePath}` : resourcePath
+}
+
+/**
+ * getRootDirectoryPath - This will return root folder path, parallel to node_modules
+ */
+export function getRootDirectoryPath() {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+    return __dirname.substring(0, (__dirname.indexOf('node_modules')-1))
 }
diff --git a/utils/componentExists.js b/utils/componentExists.js
@@ -5,11 +5,9 @@
  */
 
 import fs from 'fs'
-import path, { dirname } from 'path';
-import { fileURLToPath } from 'url';
+import {getRootDirectoryPath} from './common.js'
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+const rootPath = getRootDirectoryPath()
 
 /**
  * @param {string} comp - resource name provided
@@ -18,9 +16,9 @@ const __dirname = dirname(__filename);
  * @returns {boolean}
  */
 function componentExists(comp, category, appPath) {
-  const componentCotainer = appPath ? fs.readdirSync(
-    path.join(__dirname, `../../../${appPath}/${category}`)) : fs.readdirSync(
-      path.join(__dirname, `../../../${category}`));
+  const compDirPath = appPath ? `${rootPath}/${appPath}/${category}` : `${rootPath}/${category}`
+
+  const componentCotainer = fs.readdirSync(compDirPath);
   
   return componentCotainer.indexOf(comp) >= 0;
 }
diff --git a/utils/monorepoHelpers.js b/utils/monorepoHelpers.js
@@ -3,19 +3,17 @@
  */
 
 import fs from 'fs'
-import path, { dirname } from 'path';
-import { fileURLToPath } from 'url';
 import config from '../constants.js'
+import {getRootDirectoryPath} from './common.js'
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+const rootPath = getRootDirectoryPath()
 
 /**
  * isMonorepo - Checks if root directory has apps or packages folder, if yes, it is monorepo application
  * @returns {boolean}
  */
 function isMonorepo() {
-  const rooteDirectories = fs.readdirSync(path.join(__dirname, `../../..`));
+  const rooteDirectories = fs.readdirSync(rootPath);
   
   return rooteDirectories.indexOf('apps') >= 0 || rooteDirectories.indexOf('packages') >= 0;
 }
@@ -25,8 +23,8 @@ function isMonorepo() {
  * @returns {Array}
  */
 function getMonorepoApps() {
-  const apps = fs.readdirSync(path.join(__dirname, `../../../${config.APPS_PATH}`));
-  const packages = fs.readdirSync(path.join(__dirname, `../../../${config.PACKAGES_PATH}`));
+  const apps = fs.readdirSync(`${rootPath}/${config.APPS_PATH}`);
+  const packages = fs.readdirSync(`${rootPath}/${config.PACKAGES_PATH}`);
   
   const appsProjects = apps.map(app => `apps/${app}`)
   const packagesProjects = packages.map(app => `packages/${app}`)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@xt-pagesource/generate-plop",`
`3`		`- "version": "0.1.1",`
	`3`	`+ "version": "0.1.2",`
`4`	`4`	`"description": "Generate new components fast and consistently.",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"type": "module",`