Merge pull request #15 from route06/issue-14-lint-format

Introduce linter and formatter to the project

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,10 +1,9 @@
 ---
-name: "🐛 Bug Report"
+name: '🐛 Bug Report'
 about: Report a reproducible bug or regression.
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
 ## Current Behavior
@@ -17,4 +16,4 @@ assignees: ''
 
 ## Debug log
 
-<!-- Re-run the command and paste the output here -->
+<!-- Re-run the command and paste the output here -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,18 +4,20 @@ about: Suggest a new feature for this project
 title: ''
 labels: enhancement
 assignees: ''
-
 ---
 
 ## Feature Request
 
 **Is your feature request related to a problem? Please describe.**
+
 <!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
 
 **Describe the solution you'd like**
+
 <!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
 
 **Describe alternatives you've considered**
+
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 ## Are you willing to resolve this issue by submitting a Pull Request?
@@ -31,4 +33,4 @@ assignees: ''
 
 <!--
   👋 Have a great day and thank you for the feature request!
--->
+-->

.github/workflows/check.yaml

@@ -22,7 +22,10 @@ jobs:
           cache: 'pnpm'
 
       - name: Install dependencies
-        run: pnpm install
+        run: make install
+
+      - name: Lint & format
+        run: make lint
 
       - name: Run tests
-        run: pnpm test
+        run: make test

.prettierignore

@@ -0,0 +1,3 @@
+pnpm-lock.yaml
+CHANGELOG.md
+eslint.config.js

Makefile

@@ -0,0 +1,11 @@
+install:
+	pnpm install
+
+test:
+	pnpm test
+
+lint:
+	pnpm lint
+
+format:
+	pnpm format

eslint.config.js

@@ -0,0 +1,13 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: [
+      '**/dist/**',
+      'jest.config.cjs',
+    ],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);

jest.config.cjs

@@ -1,27 +1,27 @@
 var esmModules = [
-  "chalk",
-  "ora",
-  "cli-cursor",
-  "restore-cursor",
-  "log-symbols",
-  "is-unicode-supported",
-  "strip-ansi",
-  "ansi-regex",
-  "is-interactive",
-  "stdin-discarder",
+  'chalk',
+  'ora',
+  'cli-cursor',
+  'restore-cursor',
+  'log-symbols',
+  'is-unicode-supported',
+  'strip-ansi',
+  'ansi-regex',
+  'is-interactive',
+  'stdin-discarder',
 ];
 
 module.exports = {
-  preset: "ts-jest/presets/js-with-babel",
-  testEnvironment: "node",
+  preset: 'ts-jest/presets/js-with-babel',
+  testEnvironment: 'node',
   transform: {
-    "^.+\\.[tj]sx?$": "babel-jest",
+    '^.+\\.[tj]sx?$': 'babel-jest',
   },
   moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1",
+    '^(\\.{1,2}/.*)\\.js$': '$1',
   },
   transformIgnorePatterns: [
-  `node_modules/(?!(?:.pnpm/)?(${esmModules.join('|')}))`,
+    `node_modules/(?!(?:.pnpm/)?(${esmModules.join('|')}))`,
   ],
-  testMatch: ["**/?(*.)+(test).[tj]s?(x)"],
+  testMatch: ['**/?(*.)+(test).[tj]s?(x)'],
 };

package.json

@@ -19,6 +19,9 @@
   },
   "scripts": {
     "build": "tsup",
+    "format": "prettier --write .",
+    "format-check": "prettier --check .",
+    "lint": "eslint . && pnpm format-check",
     "dev": "tsup --watch",
     "prebuild": "run-s clean",
     "predev": "run-s clean",
@@ -62,15 +65,22 @@
     "@babel/core": "^7.24.6",
     "@babel/preset-env": "^7.24.6",
     "@babel/preset-typescript": "^7.24.6",
+    "@eslint/js": "^9.4.0",
+    "@types/eslint__js": "^8.42.3",
     "@types/jest": "^29.5.12",
     "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^7.11.0",
+    "@typescript-eslint/parser": "^7.11.0",
     "babel-jest": "^29.7.0",
+    "eslint": "^9.4.0",
     "jest": "^29.7.0",
     "js-with-babel": "link:ts-jest/presets/js-with-babel",
     "npm-run-all": "^4.1.5",
+    "prettier": "3.2.5",
     "ts-jest": "^29.1.4",
     "ts-node": "^10.9.1",
     "tsup": "^6.5.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5",
+    "typescript-eslint": "^7.11.0"
   }
 }