@devrune/cli 1.0.0 → 1.0.2

package/README.md

@@ -1,20 +1,3 @@
-# Introduction 
-TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 
+# DevRune CLI
 
-# Getting Started
-TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1.	Installation process
-2.	Software dependencies
-3.	Latest releases
-4.	API references
-
-# Build and Test
-TODO: Describe and show how to build your code and run the tests. 
-
-# Contribute
-TODO: Explain how other users and developers can contribute to make your code better. 
-
-If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
+Use this cli to check and manage structure on Frontend NextJS projects

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

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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 RESERVED_NEXT_FILES = new Set([
+    "page.tsx",
+    "layout.tsx",
+    "template.tsx",
+    "loading.tsx",
+    "error.tsx",
+    "global-error.tsx",
+    "not-found.tsx",
+    "default.tsx",
+    "route.ts",
+    "middleware.ts",
+    "instrumentation.ts",
+    "sitemap.ts",
+    "robots.ts",
+    "icon.tsx",
+    "apple-icon.tsx",
+    "opengraph-image.tsx",
+    "twitter-image.tsx",
+]);
+const IGNORED_DIRS = new Set([
+    ".husky",
+    ".next",
+    ".vscode",
+    "node_modules",
+    "public",
+    "scripts",
+    "dist",
+    "build",
+]);
+let hasErrors = false;
+const walk = (dir) => {
+    const files = fs_1.default.readdirSync(dir);
+    for (const file of files) {
+        const fullPath = path_1.default.join(dir, file);
+        const stat = fs_1.default.statSync(fullPath);
+        if (stat.isDirectory()) {
+            if (!IGNORED_DIRS.has(file)) {
+                walk(fullPath);
+            }
+        }
+        else {
+            checkFile(fullPath);
+        }
+    }
+};
+const reportError = (filePath, message) => {
+    hasErrors = true;
+    console.log(`❌ ${filePath}`);
+    console.log(`   → ${message}\n`);
+};
+const checkFile = (filePath) => {
+    const fileName = path_1.default.basename(filePath);
+    //Skip non TS/TSX files, reserved Next.js files, and declaration files
+    if (!fileName.endsWith(".ts") && !fileName.endsWith(".tsx"))
+        return;
+    if (RESERVED_NEXT_FILES.has(fileName))
+        return;
+    if (fileName.endsWith(".d.ts"))
+        return;
+    // Check for uppercase letters
+    if (/[A-Z]/.test(fileName)) {
+        reportError(filePath, "File name should be lowercase");
+        return;
+    }
+    // Hooks (check hooks before UI components since hooks can also be in TSX files)
+    if (fileName.startsWith("use-") && (fileName.endsWith(".hook.ts") || fileName.endsWith(".hook.tsx")))
+        return;
+    // UI components
+    if (fileName.endsWith(".ui.tsx"))
+        return;
+    // Types
+    if (fileName.endsWith(".type.ts"))
+        return;
+    // Classes
+    if (fileName.endsWith(".class.ts"))
+        return;
+    // Utils
+    if (fileName.endsWith(".util.ts"))
+        return;
+    //Constants
+    if (fileName.endsWith(".const.ts"))
+        return;
+    // API
+    if (fileName.endsWith(".api.ts"))
+        return;
+    // Modals
+    if (fileName.endsWith(".modal.tsx"))
+        return;
+    reportError(filePath, "File name does not follow naming convention.");
+};
+if (!fs_1.default.existsSync(SRC_DIR)) {
+    console.error("❌ src folder not found in the project root");
+    process.exit(1);
+}
+walk(SRC_DIR);
+if (hasErrors) {
+    console.log("⛔ Found files that do not follow the naming convention. Please fix the above issues.");
+    process.exit(1);
+}
+else {
+    console.log("✅ All files follow the naming convention!");
+}

package/dist/constants.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MODALS_DIR = exports.TYPES_DIR = exports.UTILS_DIR = exports.HOOKS_DIR = exports.UI_DIR = exports.API_DIR = exports.ROOT_DIR = exports.SHARED_DIR = exports.FEATURE_DIR = void 0;
+exports.FEATURE_DIR = "features";
+exports.SHARED_DIR = "shared";
+exports.ROOT_DIR = "src";
+exports.API_DIR = "api";
+exports.UI_DIR = "ui";
+exports.HOOKS_DIR = "hooks";
+exports.UTILS_DIR = "utils";
+exports.TYPES_DIR = "types";
+exports.MODALS_DIR = "modals";
+// CLI api - name.api.ts, ui - name.ui.ts, hooks - name.hook.ts, utils - name.util.ts, types name.type.ts, classes - name.class.ts

package/dist/generate-feature.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+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");
+function toPascalCase(str) {
+    return str
+        .split("-")
+        .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+        .join("");
+}
+function toCamelCase(str) {
+    const pascalCase = toPascalCase(str);
+    return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
+}
+function ensureDir(dirPath) {
+    node_fs_1.default.mkdirSync(dirPath, { recursive: true });
+}
+async function main() {
+    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' }],
+    });
+    const name = await (0, prompts_1.input)({
+        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);
+    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)} = {}`);
+    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`)} = {}`);
+    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 { ${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)}`)} = () => {}`);
+    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`);
+    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 = {};`);
+    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 { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
+}
+main()
+    .catch((e) => {
+    console.error(e);
+    process.exit(1);
+});

package/dist/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const select_1 = __importDefault(require("@inquirer/select"));
+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' }],
+}).then((answer) => {
+    if (answer === 'check') {
+        require('./check-file-name-style-guide');
+    }
+    if (answer === 'feature') {
+        require('./generate-feature');
+    }
+});

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@devrune/cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
+  "bin": {
+    "devrune": "./dist/index.js"
+  },
   "scripts": {
     "generate-feature": "ts-node ./scripts/generate-feature.ts",
     "check-file-name": "ts-node ./scripts/check-file-name-style-guide.ts"

package/scripts/generate-feature.ts

@@ -46,7 +46,7 @@ async function main() {
   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`)} = {}`);
   ensureDir(path.join(ROOT_DIR_PATH, name, UI_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, UI_DIR, `${name}.ui.ts`), `import { ${toPascalCase(name)}Props } from '../types/${name}.type';\n\nexport const ${toPascalCase(name)} = ({}: ${toPascalCase(name)}Props) => { \n  return null;\n};`);
+  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};`);
   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)}`)} = () => {}`);
   ensureDir(path.join(ROOT_DIR_PATH, name, UTILS_DIR));
@@ -54,7 +54,7 @@ async function main() {
   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 = {};`);
   ensureDir(path.join(ROOT_DIR_PATH, name, MODALS_DIR));
-  fs.writeFileSync(path.join(ROOT_DIR_PATH, name, MODALS_DIR, `${name}.modal.ts`), `// import { ${toPascalCase(name)}ModalProps } from '../types/${name}.type';\n\n// export const ${toPascalCase(name)}Modal = ({}: ${toPascalCase(name)}ModalProps) => {\n//   return null;\n// };`);
+  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// };`);
 
 }
 

package/scripts/index.ts

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+import select from "@inquirer/select";
+
+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'}],
+    },
+  ).then((answer) => {
+    if (answer === 'check') {
+      require('./check-file-name-style-guide');
+    }
+
+    if (answer === 'feature') {
+      require('./generate-feature');
+    }
+  });
+