Add example (#346)

* Add @tsconfig/node18

* Create tsconfig.json

* Update `lint` script

* Add `parserOptions.project`

* Downgrade node to v18.0.0

* Add @types/node

* Create example.js

* Create example.ts

Author: munierujp

.eslintrc.js

@@ -8,6 +8,9 @@
  */
 const config = {
   extends: './index.js',
+  parserOptions: {
+    project: './tsconfig.json'
+  },
   overrides: [
     // https://typescript-eslint.io/troubleshooting/#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file
     {

.nvmrc

@@ -1 +1 @@
-18.20.2
+18.0.0

example/example.js

@@ -0,0 +1,14 @@
+// Try ESLint on this file
+
+/**
+ * @param {string} userName - user name
+ * @returns {void}
+ */
+// FIXME: https://github.com/mightyiam/eslint-config-love/issues/1525
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+const sayHello = (userName) => {
+  console.log(`Hello, ${userName}`)
+}
+
+const myName = 'Alice'
+sayHello(myName)

example/example.ts

@@ -0,0 +1,11 @@
+// Try ESLint on this file
+
+/**
+ * @param userName - user name
+ */
+const sayHello = (userName: string): void => {
+  console.log(`Hello, ${userName}`)
+}
+
+const myName = 'Alice'
+sayHello(myName)

package-lock.json

@@ -3,7 +3,7 @@
   "version": "46.0.0",
   "description": "Recommended ESLint Shareable Config for TypeScript",
   "scripts": {
-    "lint": "eslint '**/*.js'",
+    "lint": "eslint '**/*.{js,ts}'",
     "prepublishOnly": "npm run lint"
   },
   "files": [
@@ -24,6 +24,8 @@
   },
   "devDependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "4.3.0",
+    "@tsconfig/node18": "18.2.4",
+    "@types/node": "18.0.0",
     "eslint": "8.57.0",
     "eslint-config-love": "47.0.0",
     "eslint-plugin-jsdoc": "48.2.3",

package.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@tsconfig/node18/tsconfig.json"
+}