Initial version of the template

Author: Beniamin Dudek

.eslintrc

@@ -0,0 +1,13 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "indent": ["error", 2],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "no-empty": "off",
+    "no-cond-assign": ["error", "always"]
+  }
+}

.github/workflows/build-check.yml

@@ -0,0 +1,44 @@
+name: Test and Build
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  checks: write
+  contents: write
+
+jobs:
+  run-tests:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18.x'
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm test
+
+      - name: Build project
+        run: pnpm build

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

LICENSE

@@ -1,2 +1,22 @@
-# clean-node-package-typescript
-A simple and clean template for creating Node packages using TypeScript, Vite, ESLint, Vitest
+# Clean Node Package with TypeScript Template
+
+This template provides a concise and efficient foundation for crafting a Node.js package. It seamlessly integrates:
+- **TypeScript** for robust type safety
+- **Vite 4** for optimal bundling
+- **Vitest** for comprehensive testing
+- **ESLint** for consistent code quality
+
+Furthermore, a built-in GitHub Actions workflow ensures quality control for every pull request targeting the `main` branch. While this workflow doesn't publish or store any artifacts, it serves as a robust foundation for pull request validation.
+
+## Usage
+
+Though this project has been initialized using [pnpm](https://pnpm.io/), you're welcome to utilize your preferred package manager.
+
+| Pnpm command      | Npm command       | Description               |
+| ------------------------------------- | ------------------------- |
+| `pnpm install`    | `npm install`     | Install dependencies      |
+| `pnpm test`       | `npm test`        | Execute tests             |
+| `pnpm test:watch` | `npm test:watch`  | Run tests in watch mode   |
+| `pnpm build`      | `npm build`       | Build the package         |
+
+By default, the package is configured to build to the `dist` folder. If you wish to modify this, adjustments can be made in the `vite.config.ts` file. Additionally, type definitions are included in the build, ensuring compatibility with other TypeScript projects.

README.md

@@ -0,0 +1,52 @@
+{
+  "name": "clean-node-package-typescript",
+  "private": false,
+  "version": "1.0.0",
+  "description": "A simple template for creating a Node.js package with TypeScript, Vite, Vitest and ESLint",
+  "homepage": "https://github.com/Xkonti/clean-node-package-typescript#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Xkonti/clean-node-package-typescript.git"
+  },
+  "keywords": [
+    "typescript",
+    "vite",
+    "vitest",
+    "eslint",
+    "template"
+  ],
+  "author": "Beniamin (Xkonti) Dudek <[email protected]>",
+  "bugs": {
+    "url": "https://github.com/Xkonti/clean-node-package-typescript/issues"
+  },
+  "type": "module",
+  "main": "./dist/clean-node-package-typescript.umd.cjs",
+  "module": "./dist/clean-node-package-typescript.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/clean-node-package-typescript.js",
+      "require": "./dist/clean-node-package-typescript.umd.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "coverage": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "@types/node": "^20.4.5",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
+    "eslint": "^8.46.0",
+    "typescript": "^5.1.6",
+    "vite": "^4.4.7",
+    "vite-plugin-dts": "^3.4.0",
+    "vite-plugin-eslint": "^1.8.1",
+    "vitest": "^0.33.0"
+  }
+}