Merge pull request #115 from vtex/feat/rule-consistent-props-type

feat(eslint-plugin): support to ts on the codebase + new consistent-props-type rule

.github/workflows/ci.yml

@@ -1,6 +1,12 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
 
 jobs:
   Lint:
@@ -9,10 +15,13 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '14'
+          node-version: '18'
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
+      - name: Run build
+        run: yarn build
+
       - name: Run lint
         run: yarn lint
 
@@ -27,12 +36,10 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '14'
+          node-version: '18'
 
       - name: Install dependencies
-        run: |
-          yarn install --frozen-lockfile
-          yarn --cwd fixtures/app install --no-lockfile
+        run: yarn install --frozen-lockfile
 
       - name: Verdaccio login
         run: |
@@ -63,6 +70,13 @@ jobs:
             --no-push \
             --yes
 
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14'
+
+      - name: Install dependencies
+        run: yarn --cwd fixtures/app install --no-lockfile
+
       - name: Install packages and run test
         if: steps.changed-packages.outputs.PACKAGES
         run: |

packages/eslint-config-vtex-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-vtex-react",
-  "version": "9.0.3",
+  "version": "9.0.8-alpha.0",
   "description": "VTEX's eslint config for React",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,7 @@
     "directory": "packages/eslint-config-vtex-react"
   },
   "dependencies": {
-    "eslint-config-vtex": "^15.0.2",
+    "eslint-config-vtex": "^15.0.7-alpha.0",
     "eslint-plugin-jsx-a11y": "^6.3.1",
     "eslint-plugin-react": "^7.20.6",
     "eslint-plugin-react-hooks": "^4.1.0"

packages/eslint-config-vtex/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-vtex",
-  "version": "15.0.2",
+  "version": "15.0.7-alpha.0",
   "description": "VTEX's eslint config",
   "main": "index.js",
   "scripts": {
@@ -42,7 +42,7 @@
     "eslint-plugin-jest": "^26.1.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-vtex": "^2.2.1"
+    "eslint-plugin-vtex": "^2.2.6-alpha.0"
   },
   "peerDependencies": {
     "eslint": "^8",

packages/eslint-plugin-vtex/.gitignore

@@ -0,0 +1,2 @@
+# package build
+dist

packages/eslint-plugin-vtex/CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `vtex/consistent-props-type` rule
 
 ## [2.2.1] - 2022-05-30
 ### Added

packages/eslint-plugin-vtex/docs/rules/consistent-props-type.md

@@ -0,0 +1,51 @@
+# Enforce the consistent way to define the props type (`vtex/consistent-props-type`)
+
+Examples of **incorrect** code for this rule:
+
+- Invalid props type name. Must be: DividerProps
+
+```tsx
+type Props = {}
+
+const Divider = (props: Props) => {
+  return <hr {...props} />
+}
+```
+
+- Invalid inline props type. DividerProps must define all the props.
+
+```tsx
+type DividerProps = {}
+
+const Divider = (props: DividerProps & { inline: true }) => {
+  return <hr {...props} />
+}
+```
+
+- Invalid generics props type name. Must be: Props
+
+```tsx
+type DividerProps = {}
+
+const Divider = <T extends DividerProps>(props: T) => {
+  return <hr />
+}
+```
+
+Examples of **correct** code for this rule:
+
+```tsx
+type DividerProps = {}
+
+const Divider = (props: DividerProps) => {
+  return <hr {...props} />
+}
+```
+
+```tsx
+type DividerProps = {}
+
+const Divider = <Props extends DividerProps>(props: Props) => {
+  return <hr />
+}
+```