Develop @eslint-recommended/eslint-config-typescript (#1)

* Create .nvmrc

* Create package.json

* Create package-lock.json

* Create index.js

* Create .eslintrc.js

* Create eslint.yml

* Create release.yml

* Create renovate.json

* Update README

Author: munierujp

.eslintrc.js

@@ -0,0 +1,13 @@
+// @ts-check
+
+/** @typedef {import("eslint").Linter.BaseConfig } BaseConfig */
+
+/** @type {BaseConfig} */
+const config = {
+  extends: './index.js',
+  rules: {
+    'unicorn/prefer-module': 'off'
+  }
+}
+
+module.exports = config

.github/release.yml

@@ -0,0 +1,21 @@
+changelog:
+  categories:
+    - title: "Breaking changes"
+      labels:
+        - "breaking change"
+    - title: "New features"
+      labels:
+        - "enhancement"
+    - title: "Bug fixes"
+      labels:
+        - "bug"
+    - title: "Dependency updates"
+      labels:
+        - "dependencies"
+        - "renovate"
+    - title: "Documentation"
+      labels:
+        - "documentation"
+    - title: "Other changes"
+      labels:
+        - "*"

.github/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "github>eslint-recommended/renovate-config"
+  ]
+}

.github/workflows/eslint.yml

@@ -0,0 +1,14 @@
+name: eslint
+on:
+  pull_request:
+    branches: [ main ]
+jobs:
+  eslint:
+    name: runner / eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: eslint
+        uses: reviewdog/action-eslint@v1
+        with:
+          reporter: github-pr-check

.nvmrc

@@ -0,0 +1 @@
+14.18.3

README.md

@@ -1,2 +1,58 @@
-# eslint-config-typescript
+[![npm version](https://badge.fury.io/js/%40eslint-recommended%2Feslint-config-typescript.svg)](https://badge.fury.io/js/%40eslint-recommended%2Feslint-config-typescript)
+[![eslint](https://github.com/eslint-recommended/eslint-config-typescript/actions/workflows/eslint.yml/badge.svg)](https://github.com/eslint-recommended/eslint-config-typescript/actions/workflows/eslint.yml)
+
+# @eslint-recommended/eslint-config-typescript
+
 Recommended ESLint Shareable Config for TypeScript
+
+## Peer dependencies
+
+- [eslint](https://www.npmjs.com/package/eslint)
+- [eslint-config-standard-with-typescript](https://www.npmjs.com/package/eslint-config-standard-with-typescript)
+- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)
+- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
+- [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n)
+- [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise)
+- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)
+- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
+
+## Usage
+
+### Install packages
+
+#### npm@>=7
+
+Install `@eslint-recommended/eslint-config-typescript`.
+
+```sh
+npm i -D @eslint-recommended/eslint-config-typescript
+```
+
+#### npm@<7
+
+Install `@eslint-recommended/eslint-config-typescript` and its peer dependencies.
+
+```sh
+npm i -D \
+  eslint \
+  eslint-config-standard-with-typescript \
+  eslint-plugin-eslint-comments \
+  eslint-plugin-import \
+  eslint-plugin-n \
+  eslint-plugin-promise \
+  eslint-plugin-unicorn \
+  @typescript-eslint/eslint-plugin \
+  @eslint-recommended/eslint-config-typescript
+```
+
+### Use in ESLint config
+
+Add `@eslint-recommended/eslint-config-typescript` to `extends` of your ESLint config.
+
+```json
+{
+  "extends": [
+    "@eslint-recommended/eslint-config-typescript"
+  ]
+}
+```

index.js

@@ -0,0 +1,14 @@
+// @ts-check
+
+/** @typedef {import("eslint").Linter.BaseConfig} BaseConfig */
+
+/** @type {BaseConfig} */
+const config = {
+  extends: [
+    'standard-with-typescript',
+    'plugin:unicorn/recommended',
+    'plugin:eslint-comments/recommended'
+  ]
+}
+
+module.exports = config