[TLAC-430] migrate from tslint to eslint, upgrade TypeScript (#105)

* migrate from tslint to eslint, upgrade TypeScript

* dirty merge

.apibuilder/.tracked_files

@@ -0,0 +1,5 @@
+---
+bryzek:
+  apidoc-spec:
+    ts_declarations_v2:
+    - generated/com.bryzek.apidoc.spec.v0.apidoc-spec.d.ts

.apibuilder/config

@@ -0,0 +1,8 @@
+settings:
+  code.cleanup.generated.files: true
+code:
+  bryzek:
+    apidoc-spec:
+      version: latest
+      generators:
+        ts_declarations_v2: "generated"

.eslintrc.js

@@ -0,0 +1,63 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  ignorePatterns: [
+    'dist/**/*',
+    'generated/**/*',
+    'user-generated/**/*',
+  ],
+  env: {
+    browser: true,
+    jest: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
+  ],
+  rules: {
+    'import/extensions': ['error', 'ignorePackages', {
+      ts: 'never',
+      js: 'never',
+      tsx: 'never',
+      jsx: 'never',
+    }],
+    'import/no-extraneous-dependencies': ['error', {
+      devDependencies: [
+        '.eslintrc.js',
+        'scripts/**/*',
+        'test/**/*',
+      ],
+    }],
+  },
+  overrides: [{
+    // TypeScript
+    files: ['*.ts', '*.tsx', '*.d.ts'],
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+      project: 'tsconfig.json',
+      sourceType: 'module',
+    },
+    extends: [
+      'airbnb-typescript-base',
+      'plugin:import/errors',
+      'plugin:import/warnings',
+      'plugin:import/typescript',
+    ],
+    rules: {
+      'no-undef': 'off',
+      'no-var': 'off',
+      'vars-on-top': 'off',
+      '@typescript-eslint/explicit-function-return-type': ['error', {
+        allowExpressions: true,
+      }],
+      'import/no-cycle': 'warn',
+      // To much JS intermingled with TS causing these issues. TODO, convert to TS.
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+    },
+  }],
+};

.gitignore

@@ -61,4 +61,6 @@ typings/
 dist
 
 # todo files for organization and tracking (https://github.com/fabiospampinato/vscode-todo-plus)
-*.todo
+*.todo
+
+user-generated/

generated/com.bryzek.apidoc.spec.v0.apidoc-spec.d.ts

@@ -0,0 +1,201 @@
+declare namespace com.bryzek.apidoc.spec.v0.enums {
+  type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'TRACE';
+  type ParameterLocation = 'Path' | 'Query' | 'Form' | 'Header';
+  type ResponseCodeOption = 'Default';
+}
+
+declare namespace com.bryzek.apidoc.spec.v0.models {
+  interface Apidoc {
+    readonly 'version': string;
+  }
+
+  interface Application {
+    readonly 'key': string;
+  }
+
+  interface Attribute {
+    readonly 'name': string;
+    readonly 'value': any/* object */;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+  }
+
+  interface Body {
+    readonly 'type': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Contact {
+    readonly 'name'?: string;
+    readonly 'url'?: string;
+    readonly 'email'?: string;
+  }
+
+  interface Deprecation {
+    readonly 'description'?: string;
+  }
+
+  interface Enum {
+    readonly 'name': string;
+    readonly 'plural': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'values': com.bryzek.apidoc.spec.v0.models.EnumValue[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface EnumValue {
+    readonly 'name': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Field {
+    readonly 'name': string;
+    readonly 'type': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'default'?: string;
+    readonly 'required': boolean;
+    readonly 'minimum'?: number;
+    readonly 'maximum'?: number;
+    readonly 'example'?: string;
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Header {
+    readonly 'name': string;
+    readonly 'type': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'required': boolean;
+    readonly 'default'?: string;
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Import {
+    readonly 'uri': string;
+    readonly 'namespace': string;
+    readonly 'organization': com.bryzek.apidoc.spec.v0.models.Organization;
+    readonly 'application': com.bryzek.apidoc.spec.v0.models.Application;
+    readonly 'version': string;
+    readonly 'enums': string[];
+    readonly 'unions': string[];
+    readonly 'models': string[];
+  }
+
+  interface Info {
+    readonly 'license'?: com.bryzek.apidoc.spec.v0.models.License;
+    readonly 'contact'?: com.bryzek.apidoc.spec.v0.models.Contact;
+  }
+
+  interface License {
+    readonly 'name': string;
+    readonly 'url'?: string;
+  }
+
+  interface Model {
+    readonly 'name': string;
+    readonly 'plural': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'fields': com.bryzek.apidoc.spec.v0.models.Field[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Operation {
+    readonly 'method': com.bryzek.apidoc.spec.v0.enums.Method;
+    readonly 'path': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'body'?: com.bryzek.apidoc.spec.v0.models.Body;
+    readonly 'parameters': com.bryzek.apidoc.spec.v0.models.Parameter[];
+    readonly 'responses': com.bryzek.apidoc.spec.v0.models.Response[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Organization {
+    readonly 'key': string;
+  }
+
+  interface Parameter {
+    readonly 'name': string;
+    readonly 'type': string;
+    readonly 'location': com.bryzek.apidoc.spec.v0.enums.ParameterLocation;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'required': boolean;
+    readonly 'default'?: string;
+    readonly 'minimum'?: number;
+    readonly 'maximum'?: number;
+    readonly 'example'?: string;
+  }
+
+  interface Resource {
+    readonly 'type': string;
+    readonly 'plural': string;
+    readonly 'path'?: string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'operations': com.bryzek.apidoc.spec.v0.models.Operation[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Response {
+    readonly 'code': com.bryzek.apidoc.spec.v0.unions.ResponseCode;
+    readonly 'type': string;
+    readonly 'headers'?: com.bryzek.apidoc.spec.v0.models.Header[];
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+  }
+
+  interface Service {
+    readonly 'apidoc': com.bryzek.apidoc.spec.v0.models.Apidoc;
+    readonly 'name': string;
+    readonly 'organization': com.bryzek.apidoc.spec.v0.models.Organization;
+    readonly 'application': com.bryzek.apidoc.spec.v0.models.Application;
+    readonly 'namespace': string;
+    readonly 'version': string;
+    readonly 'base_url'?: string;
+    readonly 'description'?: string;
+    readonly 'info': com.bryzek.apidoc.spec.v0.models.Info;
+    readonly 'headers': com.bryzek.apidoc.spec.v0.models.Header[];
+    readonly 'imports': com.bryzek.apidoc.spec.v0.models.Import[];
+    readonly 'enums': com.bryzek.apidoc.spec.v0.models.Enum[];
+    readonly 'unions': com.bryzek.apidoc.spec.v0.models.Union[];
+    readonly 'models': com.bryzek.apidoc.spec.v0.models.Model[];
+    readonly 'resources': com.bryzek.apidoc.spec.v0.models.Resource[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface Union {
+    readonly 'name': string;
+    readonly 'plural': string;
+    readonly 'discriminator'?: string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'types': com.bryzek.apidoc.spec.v0.models.UnionType[];
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+  }
+
+  interface UnionType {
+    readonly 'type': string;
+    readonly 'description'?: string;
+    readonly 'deprecation'?: com.bryzek.apidoc.spec.v0.models.Deprecation;
+    readonly 'attributes': com.bryzek.apidoc.spec.v0.models.Attribute[];
+    readonly 'default'?: boolean;
+  }
+}
+
+declare namespace com.bryzek.apidoc.spec.v0.unions {
+  type ResponseCode = ({
+    discriminator: 'integer',
+    value: number
+  } | {
+    discriminator: 'response_code_option',
+    value: com.bryzek.apidoc.spec.v0.enums.ResponseCodeOption
+  });
+}

jest.config.js

@@ -3,19 +3,19 @@ module.exports = {
     'ts-jest': {
       diagnostics: {
         ignoreCodes: [7006, 2732],
-      }
-    }
+      },
+    },
   },
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
   transform: {
-    '^.+\\.tsx?$': 'ts-jest'
+    '^.+\\.tsx?$': 'ts-jest',
   },
   moduleFileExtensions: [
     'ts',
     'tsx',
     'js',
     'jsx',
     'json',
-    'node'
+    'node',
   ],
-}
+};