@devrune/cli 1.0.3 → 1.0.5

package/README.md

@@ -1,3 +1,19 @@
 # DevRune CLI
 
-Use this cli to check and manage structure on Frontend NextJS projects
+Use this CLI to check and manage structure on Frontend NextJS projects
+
+## How to install
+
+```npm install --save-dev @devrune/cli```
+
+## How to use
+
+```npx @devrune/cli```
+
+then choose what prompt suggests
+
+## Available Commands
+|Command|Description|
+|-------|-----------|
+|Check Style Guide 🖌| Check project folders according style guide |
+|Create new feature | Creates basic folder structure in ```src/[feature or shared]/[name passed in prompt]``` folder|

package/dist/check-file-name-style-guide.js

@@ -5,7 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const SRC_DIR = path_1.default.join(process.cwd(), "src");
+const util_1 = require("./util");
+const SRC_DIR = (0, util_1.isRootFolder)();
 const RESERVED_NEXT_FILES = new Set([
     "page.tsx",
     "layout.tsx",

package/dist/generate-feature.js

@@ -9,6 +9,7 @@ const node_path_1 = __importDefault(require("node:path"));
 const constants_1 = require("./constants");
 const select_1 = __importDefault(require("@inquirer/select"));
 const prompts_1 = require("@inquirer/prompts");
+const util_1 = require("./util");
 function toPascalCase(str) {
     return str
         .split("-")
@@ -22,7 +23,15 @@ function toCamelCase(str) {
 function ensureDir(dirPath) {
     node_fs_1.default.mkdirSync(dirPath, { recursive: true });
 }
+function createFile(filePath, content) {
+    if (node_fs_1.default.existsSync(filePath)) {
+        console.warn(`⚠️ File ${filePath} already exists. Skipping creation.`);
+        return;
+    }
+    node_fs_1.default.writeFileSync(filePath, content);
+}
 async function main() {
+    const srcFolder = (0, util_1.isRootFolder)();
     const type = await (0, select_1.default)({
         message: 'What do you want to create?',
         choices: [{ name: 'Feature', value: 'feature', description: 'Create feature if it should be private and nothing should be imported outside' }, { name: 'Shared', value: 'shared', description: 'Create shared feature that can be imported anywhere' }],
@@ -31,21 +40,21 @@ async function main() {
         message: `Enter ${type} name:`,
         validate: (input) => input ? true : 'Name cannot be empty',
     });
-    const ROOT_DIR_PATH = type === 'feature' ? node_path_1.default.join(constants_1.ROOT_DIR, constants_1.FEATURE_DIR) : node_path_1.default.join(constants_1.ROOT_DIR, constants_1.SHARED_DIR);
+    const ROOT_DIR_PATH = type === 'feature' ? node_path_1.default.join(srcFolder, constants_1.FEATURE_DIR) : node_path_1.default.join(srcFolder, constants_1.SHARED_DIR);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, `${name}.class.ts`), `// export class ${toPascalCase(name)} = {}`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, `${name}.class.ts`), `// export class ${toPascalCase(name)} = {}`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.API_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.API_DIR, `${name}.api.ts`), `// export const ${toCamelCase(`${name}Api`)} = {}`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.API_DIR, `${name}.api.ts`), `// export const ${toCamelCase(`${name}Api`)} = {}`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UI_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UI_DIR, `${name}.ui.ts`), `import type { ${toPascalCase(name)}Props } from '../types/${name}.type';\n\nexport const ${toPascalCase(name)} = ({}: ${toPascalCase(name)}Props) => { \n  return null;\n};`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UI_DIR, `${name}.ui.tsx`), `import type { ${toPascalCase(name)}Props } from '../types/${name}.type';\n\nexport const ${toPascalCase(name)} = ({}: ${toPascalCase(name)}Props) => { \n  return null;\n};`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.HOOKS_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.HOOKS_DIR, `use-${name}.hook.ts`), `// export const ${toCamelCase(`use${toPascalCase(name)}`)} = () => {}`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.HOOKS_DIR, `use-${name}.hook.ts`), `// export const ${toCamelCase(`use${toPascalCase(name)}`)} = () => {}`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UTILS_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UTILS_DIR, `${name}.util.ts`), `// utils for ${name} feature`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.UTILS_DIR, `${name}.util.ts`), `// utils for ${name} feature`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.TYPES_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.TYPES_DIR, `${name}.type.ts`), `// export type ${toPascalCase(name)}ModalProps = {};\nexport type ${toPascalCase(name)}Props = {};`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.TYPES_DIR, `${name}.type.ts`), `// export type ${toPascalCase(name)}ModalProps = {};\nexport type ${toPascalCase(name)}Props = {};`);
     ensureDir(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.MODALS_DIR));
-    node_fs_1.default.writeFileSync(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.MODALS_DIR, `${name}.modal.ts`), `// import type { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
+    createFile(node_path_1.default.join(ROOT_DIR_PATH, name, constants_1.MODALS_DIR, `${name}.modal.tsx`), `// import type { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
 }
 main()
     .catch((e) => {

package/dist/index.js

@@ -5,11 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const select_1 = __importDefault(require("@inquirer/select"));
+const util_1 = require("./util");
+(0, util_1.isRootFolder)();
 console.log("Welcome to DevRune CLI! Use this tool to generate features and check file name style guide.");
 (0, select_1.default)({
     message: 'What do you want to create?',
-    choices: [{ name: 'Check Style Guide 🖌', value: 'check', description: 'Check project folders according style guide' },
-        { name: 'Create new feature', value: 'feature', description: 'Create new feature' }],
+    choices: [{ name: 'Check Style Guide 🎨', value: 'check', description: 'Check project folders according style guide' },
+        { name: 'Create new feature 📂', value: 'feature', description: 'Create new feature' }],
 }).then((answer) => {
     if (answer === 'check') {
         require('./check-file-name-style-guide');

package/dist/util.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRootFolder = isRootFolder;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const constants_1 = require("./constants");
+function isRootFolder() {
+    const currentDir = process.cwd();
+    const rootFolder = node_path_1.default.join(currentDir, constants_1.ROOT_DIR);
+    const folderExits = node_fs_1.default.existsSync(rootFolder);
+    if (!folderExits) {
+        console.error(`❌ Error: This command should be run from the root of the project where the ${constants_1.ROOT_DIR} folder is located.`);
+        process.exit(1);
+    }
+    return rootFolder;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrune/cli",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "bin": {
     "devrune": "./dist/index.js"
   },

package/scripts/check-file-name-style-guide.ts

@@ -1,7 +1,8 @@
 import fs from "fs";
 import path from "path";
+import { isRootFolder } from "./util";
 
-const SRC_DIR = path.join(process.cwd(), "src");
+const SRC_DIR = isRootFolder();
 
 const RESERVED_NEXT_FILES = new Set([
   "page.tsx",

package/scripts/generate-feature.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import { API_DIR, HOOKS_DIR, MODALS_DIR, FEATURE_DIR, ROOT_DIR, SHARED_DIR, TYPES_DIR, UI_DIR, UTILS_DIR } from "./constants";
 import select from "@inquirer/select";
 import {input} from '@inquirer/prompts';
+import { isRootFolder } from "./util";
 
 
 function toPascalCase(str: string) {
@@ -24,7 +25,17 @@ function ensureDir(dirPath: string) {
 }
 
 
+function createFile(filePath: string, content: string) {
+  if (fs.existsSync(filePath))  {
+    console.warn(`⚠️ File ${filePath} already exists. Skipping creation.`);
+    return;
+  }
+    
+  fs.writeFileSync(filePath, content);
+}
+
 async function main() {
+  const srcFolder = isRootFolder();
   const type = await select(
     {
       message: 'What do you want to create?',
@@ -40,21 +51,21 @@ async function main() {
     },
   );
 
-  const ROOT_DIR_PATH = type === 'feature' ? path.join(ROOT_DIR, FEATURE_DIR) : path.join(ROOT_DIR, SHARED_DIR); 
+  const ROOT_DIR_PATH = type === 'feature' ? path.join(srcFolder, FEATURE_DIR) : path.join(srcFolder, SHARED_DIR); 
   ensureDir(path.join(ROOT_DIR_PATH, name));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, `${name}.class.ts`), `// export class ${toPascalCase(name)} = {}`);
+  createFile(path.join(ROOT_DIR_PATH, name, `${name}.class.ts`), `// export class ${toPascalCase(name)} = {}`);
   ensureDir(path.join(ROOT_DIR_PATH, name, API_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, API_DIR, `${name}.api.ts`), `// export const ${toCamelCase(`${name}Api`)} = {}`);
+  createFile(path.join(ROOT_DIR_PATH, name, API_DIR, `${name}.api.ts`), `// export const ${toCamelCase(`${name}Api`)} = {}`);
   ensureDir(path.join(ROOT_DIR_PATH, name, UI_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, UI_DIR, `${name}.ui.ts`), `import type { ${toPascalCase(name)}Props } from '../types/${name}.type';\n\nexport const ${toPascalCase(name)} = ({}: ${toPascalCase(name)}Props) => { \n  return null;\n};`);
+  createFile(path.join(ROOT_DIR_PATH, name, UI_DIR, `${name}.ui.tsx`), `import type { ${toPascalCase(name)}Props } from '../types/${name}.type';\n\nexport const ${toPascalCase(name)} = ({}: ${toPascalCase(name)}Props) => { \n  return null;\n};`);
   ensureDir(path.join(ROOT_DIR_PATH, name, HOOKS_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, HOOKS_DIR, `use-${name}.hook.ts`), `// export const ${toCamelCase(`use${toPascalCase(name)}`)} = () => {}`);
+  createFile(path.join(ROOT_DIR_PATH, name, HOOKS_DIR, `use-${name}.hook.ts`), `// export const ${toCamelCase(`use${toPascalCase(name)}`)} = () => {}`);
   ensureDir(path.join(ROOT_DIR_PATH, name, UTILS_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, UTILS_DIR, `${name}.util.ts`), `// utils for ${name} feature`);
+  createFile(path.join(ROOT_DIR_PATH, name, UTILS_DIR, `${name}.util.ts`), `// utils for ${name} feature`);
   ensureDir(path.join(ROOT_DIR_PATH, name, TYPES_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, TYPES_DIR, `${name}.type.ts`), `// export type ${toPascalCase(name)}ModalProps = {};\nexport type ${toPascalCase(name)}Props = {};`);
+  createFile(path.join(ROOT_DIR_PATH, name, TYPES_DIR, `${name}.type.ts`), `// export type ${toPascalCase(name)}ModalProps = {};\nexport type ${toPascalCase(name)}Props = {};`);
   ensureDir(path.join(ROOT_DIR_PATH, name, MODALS_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, MODALS_DIR, `${name}.modal.ts`), `// import type { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
+  createFile(path.join(ROOT_DIR_PATH, name, MODALS_DIR, `${name}.modal.tsx`), `// import type { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
 
 }
 

package/scripts/index.ts

@@ -1,12 +1,15 @@
 #!/usr/bin/env node
 import select from "@inquirer/select";
+import { isRootFolder } from "./util";
+
+isRootFolder();
 
 console.log("Welcome to DevRune CLI! Use this tool to generate features and check file name style guide.");
 select(
     {
       message: 'What do you want to create?',
-      choices: [{name: 'Check Style Guide 🖌', value: 'check', description: 'Check project folders according style guide'}, 
-        {name: 'Create new feature', value: 'feature', description: 'Create new feature'}],
+      choices: [{name: 'Check Style Guide 🎨', value: 'check', description: 'Check project folders according style guide'}, 
+        {name: 'Create new feature 📂', value: 'feature', description: 'Create new feature'}],
     },
   ).then((answer) => {
     if (answer === 'check') {

package/scripts/util.ts

@@ -0,0 +1,15 @@
+import fs from "node:fs";
+import path from "node:path";
+import { ROOT_DIR } from "./constants";
+
+export function isRootFolder() {
+  const currentDir = process.cwd();
+  const rootFolder = path.join(currentDir, ROOT_DIR);
+  const folderExits = fs.existsSync(rootFolder);
+  if (!folderExits) {
+    console.error(`❌ Error: This command should be run from the root of the project where the ${ROOT_DIR} folder is located.`);
+    process.exit(1);
+  }
+
+  return rootFolder;
+}