Merge pull request #8 from n8bird-oss/feature/lint-format

Added lint and format to the main codebase

Author: abdullah4tech

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+        cache: 'npm'
+        
+    - name: Install dependencies
+      run: npm ci
+      
+    - name: Run linting
+      run: npm run lint
+      
+    - name: Run formatting check
+      run: npm run format -- --check

.gitignore

@@ -3,9 +3,13 @@ node_modules/
 npm-debug.log
 yarn-debug.log
 yarn-error.log
-package-lock.json
 .pnpm-debug.log
 
+# Package manager lockfiles (keep package-lock.json, ignore others)
+yarn.lock
+pnpm-lock.yaml
+.pnpm-store/
+
 # Bun
 .pnpm/
 bun.lockb

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "printWidth": 80
+}

CONTRIBUTING.md

@@ -5,18 +5,15 @@ We welcome contributions to the Backend-Starter-CLI project! Whether it's fixing
 ## How to Contribute
 
 1. **Fork the Repository**
-
    - Navigate to the [Backend-Starter-CLI repository](https://github.com/abdullah4tech/backend-starter-cli) and click the "Fork" button.
 
 2. **Clone Your Fork**
-
    - Clone your forked repository to your local machine:
      ```bash
      git clone https://github.com/<your-username>/backend-starter-cli.git
      ```
 
 3. **Set Up the Project**
-
    - Install dependencies:
      ```bash
      npm install
@@ -27,26 +24,22 @@ We welcome contributions to the Backend-Starter-CLI project! Whether it's fixing
      ```
 
 4. **Create a Branch**
-
    - Create a new branch for your contribution:
      ```bash
      git checkout -b feature/your-feature-name
      ```
 
 5. **Make Changes**
-
    - Implement your changes, adhering to the project's coding standards.
    - If you're fixing a bug or adding a feature, write tests to ensure your changes work as expected.
 
 6. **Run Tests**
-
    - Verify your changes by running the test suite:
      ```bash
      npm test
      ```
 
 7. **Commit Your Changes**
-
    - Write clear and concise commit messages following the format:
      ```bash
      feat: add feature description
@@ -59,14 +52,12 @@ We welcome contributions to the Backend-Starter-CLI project! Whether it's fixing
      ```
 
 8. **Push Your Branch**
-
    - Push your changes to your forked repository:
      ```bash
      git push origin feature/your-feature-name
      ```
 
 9. **Submit a Pull Request**
-
    - Navigate to the original [Backend-Starter-CLI repository](https://github.com/abdullah4tech/backend-starter-cli) and click on "New Pull Request."
    - Provide a detailed description of your changes and link to any relevant issues.
 
@@ -89,7 +80,6 @@ If you encounter a bug or have a feature request, please [open an issue](https:/
 Feel free to reach out for help or discussions:
 
 - Email: abdullahmu4life@gmail.com
-- Twitter: [abdullah4tech_](https://twitter.com/Abdullah's) X account handle
+- Twitter: [abdullah4tech\_](https://twitter.com/Abdullah's) X account handle
 
 Thank you for contributing to Backend-Starter-CLI! Your efforts help make this project better for everyone.
-

README.md

@@ -28,18 +28,21 @@ To use the `backend-starter` CLI, first ensure you have [Node.js](https://nodejs
 ### Global Installation
 
 Install the package globally using npm:
+
 ```bash
 npm install -g backend-starter-cli
 ```
 
 Now you can use the CLI anywhere with:
+
 ```bash
 backend-starter-cli
 ```
 
 ### One-Time Use with NPX
 
 Alternatively, you can use it without installation via npx:
+
 ```bash
 npx backend-starter-cli
 ```
@@ -51,11 +54,13 @@ npx backend-starter-cli
 ### Starting a New Project
 
 Run the CLI and follow the interactive prompts:
+
 ```bash
 backend-starter-cli
 ```
 
 You will be asked to provide the following details:
+
 - **Project Name**: The name of your new project.
 - **Initialize Git**: Whether to initialize a Git repository.
 - **Framework**: Select your preferred backend framework.
@@ -64,10 +69,13 @@ You will be asked to provide the following details:
 ### Example Workflow
 
 #### 1. Scaffold a Project
+
 ```bash
 backend-starter-cli
 ```
-*Example prompt interaction:*
+
+_Example prompt interaction:_
+
 ```
 ? Enter your project name: my-awesome-backend
 ? Do you want to Initialize git? (Y/n) Yes
@@ -79,24 +87,39 @@ backend-starter-cli
 ```
 
 #### 2. Navigate to Your New Project
+
 ```bash
 cd my-awesome-backend
 ```
 
 #### 3. Install Dependencies
-If you didn't install dependencies during setup, you can do so manually:
+
+Install dependencies using your preferred package manager:
+
 ```bash
+# Using npm
 npm install
+
+# Using yarn
+yarn install
+
+# Using pnpm
+pnpm install
+
+# Using bun
+bun install
 ```
 
 #### 4. Start Building 🚀
+
 Start coding with your generated boilerplate!
 
 ---
 
 ## Project Structure
 
 Below is an example structure of a project generated with the **Express** framework:
+
 ```
 my-awesome-backend/
 ├── .env                 # Environment variables
@@ -109,8 +132,8 @@ my-awesome-backend/
 
 ## Requirements
 
-- Node.js >= 20.0.0
-- npm >= 10.0.0 or higher
+- Node.js >= 16.0.0
+- Any package manager (npm, yarn, pnpm, or bun)
 
 ---
 

bin/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+'use strict';
 
 import inquirer from 'inquirer';
 import chalk from 'chalk';
@@ -51,7 +51,8 @@ async function setupProject() {
         {
           type: 'confirm',
           name: 'createEnvFile',
-          message: 'Do you want to create an .env file for your database configuration?',
+          message:
+            'Do you want to create an .env file for your database configuration?',
           default: true,
         },
       ]);
@@ -62,7 +63,9 @@ async function setupProject() {
 
     // Create project directory
     if (fs.existsSync(projectPath)) {
-      console.log(chalk.red(`Directory "${projectName}" already exists! Exiting.`));
+      console.log(
+        chalk.red(`Directory "${projectName}" already exists! Exiting.`)
+      );
       process.exit(1);
     }
     fs.mkdirSync(projectPath);
@@ -84,22 +87,22 @@ async function setupProject() {
         dev: 'node index.js',
         start: 'node index.js',
         format: 'prettier --write *.js',
-        lint: 'eslint *.js --fix'
+        lint: 'eslint *.js --fix',
       },
       dependencies: {},
       devDependencies: {
-        "prettier": "latest",
-        "eslint": "latest"
+        prettier: 'latest',
+        eslint: 'latest',
       },
       type: 'module',
       keywords: [],
-      author: "",
-      license: "ISC",
+      author: '',
+      license: 'ISC',
       description: '',
     };
 
-    dependencies[framework].forEach(dep => {
-      packageJson.dependencies[dep] = "latest"; // Add framework dependencies
+    dependencies[framework].forEach((dep) => {
+      packageJson.dependencies[dep] = 'latest'; // Add framework dependencies
     });
 
     fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
@@ -137,7 +140,10 @@ app.listen(3000, () => {
 });
 `,
     };
-    fs.writeFileSync(path.join(projectPath, 'index.js'), boilerplate[framework]);
+    fs.writeFileSync(
+      path.join(projectPath, 'index.js'),
+      boilerplate[framework]
+    );
 
     if (addDatabase) {
       const envContent = `
@@ -153,8 +159,11 @@ DB_NAME=database_name
 
     // Git initialization
     if (versionControl) {
-      execSync(`git init ${projectName} > /dev/null 2>&1`)
-      fs.writeFileSync(path.join(projectPath, '.gitignore'), 'node_modules\n.env\n');
+      execSync(`git init ${projectName} > /dev/null 2>&1`);
+      fs.writeFileSync(
+        path.join(projectPath, '.gitignore'),
+        'node_modules\n.env\n'
+      );
     }
 
     // Write Prettier configuration
@@ -184,7 +193,7 @@ DB_NAME=database_name
         semi: ['error', 'always'],
       },
     };
-    
+
     fs.writeFileSync(
       path.join(projectPath, '.prettierrc.json'),
       JSON.stringify(prettierConfig, null, 2)
@@ -195,7 +204,7 @@ DB_NAME=database_name
       JSON.stringify(eslintConfig, null, 2)
     );
 
-    console.log(chalk.white(`\nScaffolding project in ${projectPath}`))
+    console.log(chalk.white(`\nScaffolding project in ${projectPath}`));
 
     console.log(`
 Done. Now run:

eslint.config.js

@@ -0,0 +1,28 @@
+import js from '@eslint/js';
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.js', '**/*.mjs'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+      },
+    },
+    rules: {
+      'no-unused-vars': 'warn',
+      'no-console': 'off',
+      'prefer-const': 'error',
+      'no-var': 'error',
+    },
+  },
+  {
+    ignores: ['node_modules/**', 'dist/**', 'build/**'],
+  },
+];