@mediatool/eslint-config-mediatool 0.2.1 → 1.0.0

package/.eslintrc.js

@@ -1,68 +1,147 @@
-module.exports = {
-  extends: 'airbnb',
-  plugins: [ 'mocha', 'react' ],
-  rules: {
-    'array-bracket-spacing': [ 'error', 'always' ],
-    'arrow-parens': [ 'error', 'always' ],
-    camelcase: [ 'error', {
-      allow: [
-        'UNSAFE_componentWillMount',
-        'UNSAFE_componentWillReceiveProps',
-        'UNSAFE_componentWillUpdate',
-        '^_mt_',
+const javascriptRules = {
+  'array-bracket-spacing': [ 'error', 'always' ],
+  'arrow-parens': [ 'error', 'always' ],
+  camelcase: [ 'error', {
+    allow: [
+      'UNSAFE_componentWillMount',
+      'UNSAFE_componentWillReceiveProps',
+      'UNSAFE_componentWillUpdate',
+      '^_mt_',
+    ],
+    ignoreDestructuring: true,
+  } ],
+  'comma-dangle': [ 'error', {
+    arrays: 'always-multiline',
+    objects: 'always-multiline',
+    imports: 'always-multiline',
+    exports: 'always-multiline',
+    functions: 'never',
+  } ],
+  'func-names': 0,
+  'function-paren-newline': 'off',
+  'global-require': 0,
+  'import/extensions': 0,
+  'import/no-extraneous-dependencies': [
+    'error',
+    {
+      devDependencies: [
+        '**/demo/**/*.*',
+        '**/features/**/*.*',
+        '**/test/**/*.*',
+        '**/lib/**/*-test.*',
+        '**/lib/**/*-stories.*',
+        '**/rollup.config.js',
       ],
-      ignoreDestructuring: true,
-    } ],
-    'comma-dangle': [ 'error', {
+    },
+  ],
+  'jsx-a11y/anchor-is-valid': 'off',
+  'jsx-a11y/click-events-have-key-events': 'off', // Consider enabling later
+  'jsx-a11y/interactive-supports-focus': 'off', // Consider enabling later
+  'jsx-a11y/label-has-for': 'off',
+  'jsx-a11y/no-autofocus': 'off',
+  'jsx-a11y/no-noninteractive-element-interactions': 'off',
+  'jsx-a11y/no-static-element-interactions': 'off', // Consider enabling later
+  'no-multiple-empty-lines': [ 'warn', { max: 1, maxBOF: 0, maxEOF: 0 } ],
+  'no-nested-ternary': 'off',
+  'no-underscore-dangle': 0,
+  'no-unused-vars': [ 'error', {
+    vars: 'all',
+    args: 'all',
+    argsIgnorePattern: '^_',
+    ignoreRestSiblings: false,
+  } ],
+  'react/jsx-boolean-value': [ 'error', 'always' ],
+  'react/jsx-curly-spacing': [ 2, { when: 'always', children: true } ],
+  'react/no-multi-comp': 0,
+  'react/no-unescaped-entities': 'off',
+  'react/prefer-es6-class': 0,
+  'react/prop-types': 0,
+  'react/react-in-jsx-scope': 0,
+  semi: [ 'error', 'never' ],
+  'sort-imports': [ 'warn', { ignoreDeclarationSort: true } ],
+  'space-before-function-paren': [ 'error', 'always' ],
+}
+
+const typescriptRules = {
+  ...javascriptRules,
+  '@typescript-eslint/semi': [ 'error', 'never' ],
+  '@typescript-eslint/comma-dangle': [
+    'error',
+    {
       arrays: 'always-multiline',
       objects: 'always-multiline',
       imports: 'always-multiline',
       exports: 'always-multiline',
       functions: 'never',
-    } ],
-    'func-names': 0,
-    'function-paren-newline': 'off',
-    'global-require': 0,
-    'import/extensions': 0,
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: [
-          '**/demo/**/*.*',
-          '**/features/**/*.*',
-          '**/test/**/*.*',
-          '**/rollup.config.js',
-        ],
+    },
+  ],
+  'import/prefer-default-export': 0,
+  '@typescript-eslint/space-before-function-paren': [ 'error', 'always' ],
+  '@typescript-eslint/no-use-before-define': [ 'error' ],
+  '@typescript-eslint/member-delimiter-style': [
+    'error', {
+      multiline: {
+        delimiter: 'none',
       },
-    ],
-    'jsx-a11y/anchor-is-valid': 'off',
-    'jsx-a11y/click-events-have-key-events': 'off', // Consider enabling later
-    'jsx-a11y/interactive-supports-focus': 'off', // Consider enabling later
-    'jsx-a11y/label-has-for': 'off',
-    'jsx-a11y/no-autofocus': 'off',
-    'jsx-a11y/no-noninteractive-element-interactions': 'off',
-    'jsx-a11y/no-static-element-interactions': 'off', // Consider enabling later
-    'no-multiple-empty-lines': [ 'warn', { max: 1, maxBOF: 0, maxEOF: 0 } ],
-    'no-nested-ternary': 'off',
-    'no-underscore-dangle': 0,
-    'no-unused-vars': [ 'error', {
-      vars: 'all',
-      args: 'all',
-      argsIgnorePattern: '^_',
-      ignoreRestSiblings: false,
+      singleline: {
+        delimiter: 'comma',
+        requireLast: false,
+      },
+      multilineDetection: 'brackets',
     } ],
-    'react/jsx-boolean-value': [ 'error', 'always' ],
-    'react/jsx-curly-spacing': [ 2, { when: 'always', children: true } ],
-    'react/no-multi-comp': 0,
-    'react/no-unescaped-entities': 'off',
-    'react/prefer-es6-class': 0,
-    'react/prop-types': 0,
-    'react/react-in-jsx-scope': 0,
-    semi: [ 'error', 'never' ],
-    'sort-imports': [ 'warn', { ignoreDeclarationSort: true } ],
-    'space-before-function-paren': [ 'error', 'always' ],
-  },
+  '@typescript-eslint/naming-convention': [
+    'error',
+    {
+      selector: 'interface',
+      format: [ 'PascalCase' ],
+      custom: {
+        regex: '^I[A-Z]',
+        match: false,
+      },
+    },
+  ],
+}
+
+module.exports = {
   overrides: [
+    {
+      files: [ '*.js', '*.jsx' ],
+      extends: 'airbnb',
+      plugins: [ 'mocha', 'react' ],
+      rules: javascriptRules,
+      env: {
+        mocha: true,
+        browser: true,
+      },
+      parserOptions: {
+        ecmaVersion: 2021,
+        ecmaFeatures: {
+          jsx: true,
+          modules: true,
+        },
+      },
+    },
+    {
+      files: [ '*.ts', '*.tsx' ],
+      extends: [ 'airbnb', 'airbnb-typescript' ],
+      plugins: [ '@typescript-eslint' ],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: './tsconfig.json',
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      rules: typescriptRules,
+    },
+    {
+      files: [ '*-stories.*' ],
+      rules: {
+        'no-console': 'off',
+      },
+    },
     {
       files: [ 'demo/*.*' ],
       rules: {
@@ -70,15 +149,4 @@ module.exports = {
       },
     },
   ],
-  env: {
-    mocha: true,
-    browser: true,
-  },
-  parserOptions: {
-    ecmaVersion: 2021,
-    ecmaFeatures: {
-      jsx: true,
-      modules: true,
-    },
-  },
 }

package/examples/plain.ts

@@ -0,0 +1,21 @@
+function hello (_: any, x: string) {
+  return x
+}
+
+function factory (
+  a: number,
+  b: number,
+  c: number,
+  d: (a: object) => void
+) {
+  const obj = {
+    a,
+    b,
+    c,
+    _mt_entry_type: 'planning',
+  }
+  return d(obj)
+}
+
+factory(1, 2, 3, () => {})
+hello(1, 'a')

package/examples/react-component.tsx

@@ -0,0 +1,10 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import React, { useState } from 'react'
+
+const ExampleComponent = () => {
+  const [ message ] = useState('Hey')
+
+  return <div>{ message }</div>
+}
+
+export default ExampleComponent

package/package.json

@@ -1,17 +1,26 @@
 {
   "name": "@mediatool/eslint-config-mediatool",
-  "version": "0.2.1",
+  "version": "1.0.0",
   "main": ".eslintrc.js",
   "scripts": {
     "pretest": "yarn",
-    "test": "eslint demo/*.* examples/*.* --max-warnings 0"
+    "lint": "eslint demo/*.* examples/*.* --max-warnings 0",
+    "test": "yarn lint"
   },
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
     "eslint": "^7.8.1",
     "eslint-config-airbnb": "^16.1.0",
+    "eslint-config-airbnb-typescript": "^14.0.0",
     "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-jsx-a11y": "^6.2.3",
     "eslint-plugin-mocha": "^6.1.0",
-    "eslint-plugin-react": "^7.14.3"
+    "eslint-plugin-react": "^7.14.3",
+    "typescript": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.24",
+    "react": "^17.0.2"
   }
 }

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "noUnusedLocals": true,
+    "noImplicitAny": true,
+    "declarationDir": "dist/types",
+    "declaration": true,
+    "target": "esnext",
+    "module": "esnext",
+    "strict": true,
+    "jsx": "react",
+    "typeRoots": [ "types" ],
+    "types": [ "mocha", "chai-spies" ],
+    "paths": {
+      "@lib/*": [ "./lib/*" ]
+    }
+  },
+  "include": [
+    "**/*",
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+  ]
+}