@typeform/eslint-config 3.0.2 → 6.0.2-alpha.2

package/.eslintignore

@@ -0,0 +1 @@
+/test-cases/**

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "./index.js"
+}

package/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+[JIRA ticket](url)
+
+[Link to changed rule/plugin documentation](url)
+
+Short summary
+---
+
+## Things to include:
+
+- [ ] Description of what's changed and why it will help
+- [ ] Updated test pass case
+- [ ] Added test fail case

package/.github/workflows/ci-standard-checks.yml

@@ -0,0 +1,24 @@
+name: CI Standard Checks
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+    branches:
+      - main
+
+jobs:
+  ci-standard-checks:
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Check Out Source Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: CI Standard Checks
+        uses: Typeform/ci-standard-checks@v1
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+      - next
+      - alpha
+      - beta
+
+jobs:
+  main:
+    name: Run checks and deploy
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+
+      - name: Set GitHub packages registry
+        run: |
+          npm config set '//npm.pkg.github.com/:_authToken' ${{ secrets.GH_TOKEN }}
+          npm config set @typeform:registry https://npm.pkg.github.com/
+
+      - name: Get yarn cache
+        uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('.github/workflows/**.yml') }}
+
+      - name: Install Node.js dependencies
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+        run: yarn install --frozen-lockfile
+
+      - name: Run linting
+        run: yarn lint
+
+      - name: Release main
+        run: yarn semantic-release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+    branches:
+      - main
+
+jobs:
+  tests:
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Check Out Source Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up
+        run: yarn
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test

package/index.js

@@ -1,19 +1,12 @@
 module.exports = {
-  extends: [
-    'react-app',
-    'plugin:jsx-a11y/recommended',
-    'prettier',
-    'prettier/@typescript-eslint',
-    'prettier/babel',
-    'prettier/react',
-  ],
+  extends: ['react-app', 'plugin:jsx-a11y/recommended', 'prettier'],
   plugins: ['jest'],
   env: {
-    browser: true,
-    commonjs: true,
-    es6: true,
-    jest: true,
-    node: true,
+    'browser': true,
+    'commonjs': true,
+    'es6': true,
+    'jest': true,
+    'node': true,
     'jest/globals': true,
   },
   parserOptions: {
@@ -22,6 +15,10 @@ module.exports = {
     },
   },
   rules: {
+    'no-var': 'warn',
+    'curly': 'warn',
+    'prefer-destructuring': 'warn',
+    '@typescript-eslint/no-extra-semi': 'off',
     'import/order': [
       'warn',
       {
@@ -31,9 +28,24 @@ module.exports = {
     'import/export': 'warn',
     'jest/no-focused-tests': 'error',
     'no-console': 'warn',
+    'no-debugger': 'error',
     'prefer-template': 'warn',
     'react/prop-types': 'error',
     'react-hooks/exhaustive-deps': 'error',
+    'react/jsx-key': ['warn', { checkFragmentShorthand: true }],
+    '@typescript-eslint/no-explicit-any': 'warn',
+    'no-restricted-imports': [
+      'warn',
+      {
+        patterns: [
+          {
+            group: ['@typeform/kitt/lib/*'],
+            message:
+              "🙈 The lib notation is deprecated. Refer to the Kitt's doc, and ping the FEAR team if you have a doubt",
+          },
+        ],
+      },
+    ],
   },
   settings: {
     react: {

package/index.test.js

@@ -0,0 +1,85 @@
+const child_process = require('child_process')
+
+describe('eslint config', () => {
+  // #region Pass
+  it('should pass if there are no errors', () => {
+    const output = child_process
+      .execSync('yarn eslint -f "json" --no-ignore test-cases/pass.js')
+      .toString()
+    expect(output.includes('"errorCount":0')).toBeTruthy()
+    expect(output.includes('"fatalErrorCount":0')).toBeTruthy()
+    expect(output.includes('"warningCount":0')).toBeTruthy()
+    expect(output.includes('"fixableErrorCount":0')).toBeTruthy()
+    expect(output.includes('"fixableWarningCount":0')).toBeTruthy()
+  })
+  // #endregion
+
+  // #region Warn
+  it('should warn if console is used', () => {
+    const output = child_process
+      .execSync(
+        'yarn eslint -f "json" --no-ignore test-cases/warn-no-console.js'
+      )
+      .toString()
+
+    expect(output.includes('"ruleId":"no-console"')).toBeTruthy()
+    expect(output.includes('"errorCount":0')).toBeTruthy()
+    expect(output.includes('"warningCount":1')).toBeTruthy()
+  })
+
+  it('should warn if var is used', () => {
+    const output = child_process
+      .execSync('yarn eslint -f "json" --no-ignore test-cases/warn-no-var.js')
+      .toString()
+
+    expect(output.includes('"ruleId":"no-var"')).toBeTruthy()
+    expect(output.includes('"errorCount":0')).toBeTruthy()
+    expect(output.includes('"warningCount":1')).toBeTruthy()
+  })
+
+  it('should warn if braces are not used', () => {
+    const output = child_process
+      .execSync('yarn eslint -f "json" --no-ignore test-cases/warn-curly.js')
+      .toString()
+
+    expect(output.includes('"ruleId":"curly"')).toBeTruthy()
+    expect(output.includes('"errorCount":0')).toBeTruthy()
+    expect(output.includes('"warningCount":2')).toBeTruthy()
+  })
+
+  it('should warn if destructuring is not used', () => {
+    const output = child_process
+      .execSync(
+        'yarn eslint -f "json" --no-ignore test-cases/warn-prefer-destructuring.js'
+      )
+      .toString()
+
+    expect(output.includes('"ruleId":"prefer-destructuring"')).toBeTruthy()
+    expect(output.includes('"errorCount":0')).toBeTruthy()
+    expect(output.includes('"warningCount":1')).toBeTruthy()
+  })
+  // #endregion
+
+  // #region Fail
+  it('should fail if debugger is used', () => {
+    const call = () =>
+      child_process.execSync(
+        'yarn eslint -f "json" --no-ignore test-cases/error-no-debugger.js'
+      )
+
+    expect(call).toThrow()
+
+    let output = null
+
+    try {
+      call()
+    } catch (err) {
+      output = err.stdout.toString()
+      expect(output.includes('"ruleId":"no-debugger"')).toBeTruthy()
+      expect(output.includes('"errorCount":1')).toBeTruthy()
+      expect(output.includes('"warningCount":0')).toBeTruthy()
+    }
+  })
+
+  // #endregion
+})

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typeform/eslint-config",
-  "version": "3.0.2",
+  "version": "6.0.2-alpha.2",
   "description": "ESLint configuration for Typeform front-end projects",
   "main": "index.js",
   "repository": "git@github.com:Typeform/eslint-config-typeform.git",
@@ -10,10 +10,10 @@
     "node": ">=10"
   },
   "scripts": {
-    "test": "echo 'no tests' && exit 0",
-    "eslint": "eslint -c ./index.js",
+    "test": "jest",
+    "eslint": "eslint",
     "lint": "yarn run eslint .",
-    "publish:github": "npm config set '//npm.pkg.github.com/:_authToken' $GH_TOKEN && npm publish --registry https://npm.pkg.github.com"
+    "publish:npm": "npm config set @typeform:registry https://registry.npmjs.org/ && npm config set '//registry.npmjs.org/:_authToken' $NPM_TOKEN && npm publish"
   },
   "husky": {
     "hooks": {
@@ -29,40 +29,43 @@
   },
   "prettier": "./prettier",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.9.0",
-    "@typescript-eslint/parser": "^4.9.0",
+    "@typescript-eslint/eslint-plugin": "^5.44.0",
+    "@typescript-eslint/parser": "^5.44.0",
     "babel-eslint": "^10.1.0",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-config-react-app": "^6.0.0",
-    "eslint-config-standard": "^16.0.2",
-    "eslint-config-standard-jsx": "^10.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-react-app": "^7.0.1",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-config-standard-jsx": "^11.0.0",
     "eslint-plugin-filenames": "^1.3.2",
-    "eslint-plugin-flowtype": "^5.2.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.1.3",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-flowtype": "^8.0.3",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.5",
+    "eslint-plugin-jsx-a11y": "^6.6.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-react": "^7.21.5",
-    "eslint-plugin-react-hooks": "^4.2.0"
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.31.11",
+    "eslint-plugin-react-hooks": "^4.6.0"
   },
   "peerDependencies": {
     "@babel/core": "7.x",
-    "eslint": "7.x"
+    "eslint": ">=7.27.x",
+    "typescript": ">=4"
   },
   "devDependencies": {
     "@babel/core": "^7.12.9",
-    "@semantic-release/exec": "^5.0.0",
-    "eslint": "^7.14.0",
-    "husky": "^4.3.0",
-    "lint-staged": "^10.5.2",
-    "prettier": "^2.2.1",
-    "semantic-release": "^17.3.0"
+    "@semantic-release/exec": "^6.0.3",
+    "eslint": "^7.27.0",
+    "husky": "^8.0.2",
+    "jest": "^29.3.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "semantic-release": "^19.0.5",
+    "typescript": "^4.7.2"
   },
   "release": {
     "branches": [
       "+([0-9])?(.{+([0-9]),x}).x",
-      "master",
+      "main",
       "next",
       "next-major",
       {
@@ -82,7 +85,7 @@
       [
         "@semantic-release/exec",
         {
-          "successCmd": "yarn run publish:github"
+          "successCmd": "yarn run publish:npm"
         }
       ]
     ]

package/test-cases/error-no-debugger.js

@@ -0,0 +1,4 @@
+const myVariable = 34
+const newValue = myVariable + 5
+debugger
+export default newValue

package/test-cases/pass.js

@@ -0,0 +1,8 @@
+const myConstant = 34
+let myVariable = myConstant + 5
+const data = { a: 5, b: 1 }
+if (true) {
+  const { a } = data
+  myVariable += a + data.b
+}
+export default myVariable

package/test-cases/warn-curly.js

@@ -0,0 +1,7 @@
+let condition1 = true
+let condition2 = false
+let myVariable = 34
+if (condition1) myVariable += 5
+if (condition2)
+  myVariable = myVariable * myVariable + 5 - myVariable - 2 * myVariable
+export default myVariable

package/test-cases/warn-no-console.js

@@ -0,0 +1,4 @@
+const myVariable = 34
+const newValue = myVariable + 5
+console.log(newValue)
+export default newValue

package/test-cases/warn-no-var.js

@@ -0,0 +1,3 @@
+const myVariable = 34
+var newValue = myVariable + 5
+export default newValue

package/test-cases/warn-prefer-destructuring.js

@@ -0,0 +1,4 @@
+const data = { a: 5, b: 1 }
+const a = data.a
+const myVariable = 34 + a + data.b
+export default myVariable

package/.travis.yml

@@ -1,18 +0,0 @@
-language: node_js
-node_js:
-  - '12'
-
-# Travis runs on PUSH events ONLY in the following branches. This does not affect to Travis running on PULL REQUEST event
-branches:
-  only:
-    - master
-    - next
-
-cache: yarn
-
-script:
-  - yarn lint
-  - yarn semantic-release
-
-notifications:
-  email: false