first commit

Author: ioncakephper

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "commonjs": true,
+    "es2021": true,
+    "node": true,
+    "jest/globals": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:jest/recommended",
+    "prettier"
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "plugins": [
+    "jest"
+  ],
+  "rules": {}
+}

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - name: Lint code
+      run: npm run lint
+    - name: Check formatting
+      run: npm run format
+    - name: Run tests
+      run: npm test

.gitignore

@@ -0,0 +1,28 @@
+# Dependencies
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Test coverage
+/coverage
+
+# Build output
+/dist
+/build
+
+# Misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+coverage
+dist
+node_modules

.prettierrc.json

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

README.md

@@ -0,0 +1,61 @@
+# js-quality-starter
+
+A starter repository for JavaScript projects with pre-configured linting, formatting, testing, and CI using GitHub Actions.
+
+This template provides a solid foundation for any new JavaScript project, ensuring code quality and consistency from the start.
+
+## Features
+
+-   **Linting** with [ESLint](https://eslint.org/) to find and fix problems in your JavaScript code.
+-   **Formatting** with [Prettier](https://prettier.io/) for a consistent code style.
+-   **Testing** with [Jest](https://jestjs.io/) as the testing framework.
+-   **CI/CD** with [GitHub Actions](https://github.com/features/actions) to automate linting, formatting checks, and testing on every push and pull request.
+-   **Pre-commit Hooks** with [Husky](https://typicode.github.io/husky/) and [lint-staged](https://github.com/okonet/lint-staged) to lint and format your code before you even commit it.
+
+## Getting Started
+
+### Using as a Template
+
+Click the "Use this template" button on the GitHub repository page to create a new repository with the same directory structure and files.
+
+### Manual Setup
+
+1.  Clone the repository:
+    ```bash
+    git clone https://github.com/your-username/js-quality-starter.git
+    cd js-quality-starter
+    ```
+
+2.  Install dependencies:
+    ```bash
+    npm install
+    ```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+-   `npm test`: Runs the tests using Jest.
+-   `npm run lint`: Lints all `.js` files in the project.
+-   `npm run lint:fix`: Lints and automatically fixes fixable issues.
+-   `npm run format`: Checks for formatting issues with Prettier.
+-   `npm run format:fix`: Formats all supported files with Prettier.
+
+## How It Works
+
+### Pre-commit Hook
+
+This project uses `husky` and `lint-staged` to run `eslint --fix` and `prettier --write` on staged `.js` files every time you make a commit. This ensures that no code that violates the style guide gets into the codebase.
+
+After running `npm install`, the `prepare` script sets up the husky hooks.
+
+### CI Pipeline
+
+The `.github/workflows/ci.yml` file defines a GitHub Actions workflow that runs on every push and pull request to the `main` branch. It performs the following checks on Node.js 18.x and 20.x:
+
+1.  Installs dependencies.
+2.  Runs `npm run lint` to check for linting errors.
+3.  Runs `npm run format` to check for formatting errors.
+4.  Runs `npm test` to execute the test suite.
+
+This ensures that all code in the `main` branch is high quality and passes all checks.

jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('jest').Config} */
+const config = {
+  verbose: true,
+  testEnvironment: 'node',
+  coverageProvider: 'v8',
+};
+
+module.exports = config;

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "js-quality-starter",
+  "version": "1.0.0",
+  "description": "A starter repository for JavaScript projects with pre-configured linting, formatting, testing, and CI using GitHub Actions.",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "prepare": "husky install"
+  },
+  "keywords": [
+    "javascript",
+    "template",
+    "eslint",
+    "prettier",
+    "jest",
+    "ci",
+    "starter"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^28.2.0",
+    "husky": "^8.0.0",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

src/index.js

@@ -0,0 +1,5 @@
+function add(a, b) {
+  return a + b;
+}
+
+module.exports = add;

src/index.test.js

@@ -0,0 +1,11 @@
+const add = require('./index');
+
+describe('add function', () => {
+  test('should add two numbers correctly', () => {
+    expect(add(1, 2)).toBe(3);
+  });
+
+  test('should handle negative numbers', () => {
+    expect(add(-1, -1)).toBe(-2);
+  });
+});