Merge pull request #385 from ottofeller/add-eslint-rule-consistent-ty…

…pe-definitions

PLA-267 Add eslint rule consistent-type-definitions

.projenrc.ts

@@ -1,3 +1,4 @@
+import type {Linter} from 'eslint'
 import {readFileSync} from 'fs'
 import * as projen from 'projen'
 import {addHusky} from './src/common/git'
@@ -64,10 +65,15 @@ project.package.addField('version', version)
 project.package.addField('overrides', {'@types/babel__traverse': 'ts3.9'})
 
 // ANCHOR ESLint and prettier setup
+const rules: Linter.RulesRecord = {
+  'import/no-relative-parent-imports': ['off'], // Relative paths are required at runtime
+  '@typescript-eslint/consistent-type-definitions': ['error', 'interface'], // JSII requires interfaces to be exported
+}
+
 addLinters({
   project,
   lintPaths: ['.projenrc.ts', 'src'],
-  extraEslintConfigs: [{rules: {'import/no-relative-parent-imports': ['off']}}],
+  extraEslintConfigs: [{rules}],
 })
 
 // Solves the typescript > 4 problem

src/common/lint/add-linters.ts

@@ -10,7 +10,7 @@ import {prettierConfig} from './configs/prettier'
 const arrayEslintConfigProperties = ['extends', 'overrides', 'plugins'] as const
 type LinterConfigArrayProperties = Pick<Linter.Config, (typeof arrayEslintConfigProperties)[number]>
 
-type AddLintersProps = {
+interface AddLintersProps {
   readonly project: NodeProject
   readonly lintPaths: Array<string>
   readonly extraEslintConfigs?: Array<Linter.Config>

src/common/lint/configs/cspell.ts

@@ -1,9 +1,9 @@
-type DictionaryDefinition = {
+interface DictionaryDefinition {
   name: string
   path: string
 }
 
-type LanguageSettings = {
+interface LanguageSettings {
   /**
    * VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
    * will match against any file type.
@@ -30,7 +30,7 @@ type LanguageSettings = {
 }
 
 /** @see https://cspell.org/configuration/#cspelljson-sections */
-type CSpellConfig = {
+interface CSpellConfig {
   /** Currently always 0.2 - controls how the settings in the configuration file behave. */
   version: string
 

src/common/lint/configs/eslint-config-quality.ts

@@ -33,6 +33,7 @@ export const eslintConfigQuality: Linter.Config = {
       {'ts-expect-error': 'allow-with-description', 'ts-ignore': 'allow-with-description'},
     ],
     '@typescript-eslint/consistent-type-assertions': ['error', {assertionStyle: 'never'}],
+    '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
     '@typescript-eslint/no-shadow': ['error'],
     '@typescript-eslint/no-unused-expressions': ['error'],
     '@typescript-eslint/no-unused-vars': ['error', {argsIgnorePattern: '^_'}],