[Integration] Typescript

.buildkite/basic/electron-pipeline.yml

@@ -27,7 +27,7 @@ steps:
       - echo "Running on Node `node -v`"
       - npm install electron@${ELECTRON_VERSION} --no-audit --progress=false --no-save
       - npm ci --no-audit --progress=false
-      - npm run build:electron
+      - npm run build
       - defaults write com.apple.CrashReporter DialogType none
       - npm run test:unit:electron-runner
       - npm run test:electron

.github/workflows/test-electron.yml

@@ -43,7 +43,7 @@ jobs:
     - run: npm ci --no-audit --progress=false
       env:
         PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
-    - run: npm run build:electron
+    - run: npm run build
       shell: bash
     - run: sudo apt-get install cppcheck --assume-yes
       name: Install cppcheck

.rollup/index.mjs

@@ -0,0 +1,68 @@
+import typescript from '@rollup/plugin-typescript'
+import replace from '@rollup/plugin-replace'
+import fs from 'fs'
+
+const defaultOptions = () => ({
+  // additional variables to define with '@rollup/plugin-replace'
+  // e.g. '{ ABC: 123 }' is equivalent to running 'globalThis.ABC = 123'
+  additionalReplacements: {},
+  // additional external dependencies, such as '@bugsnag/browser'
+  external: [],
+  // the entry point for the bundle
+  input: undefined,
+  // output directory for the bundle
+  output: undefined
+})
+
+export const sharedOutput = {
+  dir: 'dist',
+  generatedCode: {
+    preset: 'es2015',
+  }
+}
+
+function createRollupConfig (options = defaultOptions()) {
+  const packageJson = JSON.parse(fs.readFileSync(`${process.cwd()}/package.json`))
+
+  return {
+    input: options.input || 'src/index.ts',
+    output: options.output || [
+      {
+        ...sharedOutput,
+        entryFileNames: '[name].js',
+        format: 'cjs'
+      },
+      {
+        ...sharedOutput,
+        preserveModules: true,
+        entryFileNames: '[name].mjs',
+        format: 'esm'
+      }
+    ],
+    external: ['@bugsnag/core'].concat(options.external),
+    plugins: [
+      replace({
+        preventAssignment: true,
+        values: {
+          __VERSION__: packageJson.version,
+          ...options.additionalReplacements,
+        }
+      }),
+      typescript({
+        removeComments: true,
+        // don't output anything if there's a TS error
+        noEmitOnError: true,
+        // turn on declaration files and declaration maps
+        compilerOptions: {
+          declaration: true,
+          declarationMap: true,
+          emitDeclarationOnly: true,
+          declarationDir: 'dist/types',
+        }
+      }),
+      ...(options.plugins ?? [])
+    ]
+  }
+}
+
+export default createRollupConfig

.tool-versions

@@ -0,0 +1 @@
+nodejs 18.20.5

TESTING.md

@@ -39,7 +39,7 @@ npm run test:types
 
 ## Linting
 
-Lints the entire repo with ESLint. On JavaScript files this uses the [standard](https://github.com/standard/eslint-config-standard) ruleset and on TypeScript files this uses the [@typescript/eslint](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin) recommended set of rules.
+Lints the entire repo with ESLint.
 
 ```sh
 npm run test:lint

dockerfiles/Dockerfile.browser

@@ -6,9 +6,10 @@ RUN apk add --update bash python3 make gcc g++ musl-dev xvfb-run curl
 WORKDIR /app
 
 COPY package*.json ./
-COPY babel.config.js lerna.json .eslintignore .eslintrc.js jest.config.js tsconfig.json ./
+COPY babel.config.js lerna.json eslint.config.mjs jest.config.js tsconfig.json ./
 COPY jest ./jest
 ADD min_packages.tar .
+COPY .rollup ./.rollup
 COPY bin ./bin
 COPY packages ./packages
 

dockerfiles/Dockerfile.ci

@@ -6,9 +6,10 @@ RUN apk add --update bash python3 make gcc g++ musl-dev xvfb-run curl
 WORKDIR /app
 
 COPY package*.json ./
-COPY babel.config.js lerna.json .eslintignore .eslintrc.js jest.config.js tsconfig.json ./
+COPY babel.config.js lerna.json eslint.config.mjs jest.config.js tsconfig.json ./
 COPY jest ./jest
 ADD min_packages.tar .
+COPY .rollup ./.rollup
 COPY bin ./bin
 COPY scripts ./scripts
 COPY test ./test

dockerfiles/Dockerfile.node

@@ -6,9 +6,10 @@ RUN apk add --update bash python3 make gcc g++ musl-dev xvfb-run curl
 WORKDIR /app
 
 COPY package*.json ./
-COPY babel.config.js lerna.json .eslintignore .eslintrc.js jest.config.js tsconfig.json ./
+COPY babel.config.js lerna.json eslint.config.mjs jest.config.js tsconfig.json ./
 COPY jest ./jest
 ADD min_packages.tar .
+COPY .rollup ./.rollup
 COPY bin ./bin
 COPY packages ./packages
 

eslint.config.mjs

@@ -0,0 +1,143 @@
+import { fileURLToPath } from 'node:url';
+
+import eslint from '@eslint/js';
+import eslintPluginImport from 'eslint-plugin-import';
+import eslintPluginJest from 'eslint-plugin-jest';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+const __filename = fileURLToPath(import.meta.url);
+
+const c = tseslint.config(
+  // Files to ignore
+  {
+    ignores: [
+      '**/dist',
+      'examples',
+      'scratch',
+      'coverage',
+      'packages/core/types/test/*.js',
+      'packages/react-native/android/build/reports',
+      'packages/**/features',
+      'packages/**/fixtures',
+      'test/browser',
+      'test/node',
+      'test/react-native-cli/features/fixtures',
+      'packages/react-native/ios/vendor'
+    ],
+  },
+  eslint.configs.recommended,
+  {
+    rules: {
+      'no-undef': 'warn',
+      'no-unused-vars': 'warn',
+      'no-empty': 'warn',
+      'no-redeclare': 'warn',
+      'no-func-assign': 'warn',
+      'no-prototype-builtins': 'warn',
+      'require-yield': 'warn',
+    },
+  },
+  {
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+      import: eslintPluginImport,
+    },
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        /**
+         * This config also targets files not included in tsconfig so this must be false
+         * and rules requiring type information cannot be used
+         */
+        project: false,
+      },
+    },
+  },
+  // Base linting config
+  {
+    files: ['**/*.json', '**/*.[tj]s?(x)', '**/*.cjs', '**/*.mjs'],
+  },
+  // Linting config for TypeScript
+  {
+    files: [
+      '**/*.ts?(x)'
+    ],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: false, // Allows use of rules which require type information
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+    },
+    rules: {
+      ...tseslint.configs.recommended[1].rules,
+      ...tseslint.configs.recommended[2].rules,
+      ...tseslint.configs.strict[2].rules,
+
+      // Let TypeScript inference work without being verbose
+      '@typescript-eslint/explicit-function-return-type': 'off',
+
+      // (Explicit) any has its valid use cases
+      '@typescript-eslint/no-explicit-any': 'off',
+
+      // We use noop functions liberally (() => {})
+      '@typescript-eslint/no-empty-function': 'off',
+
+      // This incorrectly fails on TypeScript method override signatures
+      'no-dupe-class-members': 'off',
+
+      // Optional chaining compiles to a lot more code
+      '@typescript-eslint/prefer-optional-chain': 'off',
+
+      // Support TypeScript 3.8 by disallowing import { type Module } from 'module'
+      'import/consistent-type-specifier-style': ['warn', 'prefer-top-level'],
+
+      '@typescript-eslint/ban-ts-comment': 'warn',
+      '@typescript-eslint/no-unused-vars': 'warn',
+      '@typescript-eslint/no-require-imports': 'warn',
+      'prefer-rest-params': 'warn',
+      'prefer-spread': 'warn',
+      '@typescript-eslint/no-unsafe-function-type': 'warn',
+      '@typescript-eslint/no-wrapper-object-types': 'warn',
+      '@typescript-eslint/no-empty-object-type': 'warn',
+      '@typescript-eslint/no-unsafe-declaration-merging': 'warn',
+      '@typescript-eslint/no-invalid-void-type': 'warn',
+    },
+  },
+  // Jest tests
+  {
+    files: [
+      '**/*.test.ts?(x)'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+        ...globals.node,
+        ...globals.browser,
+        process: 'readonly', // require to access process.env values
+      },
+    },
+    plugins: {
+      jest: eslintPluginJest,
+    },
+    rules: {
+      ...eslintPluginJest.configs['flat/recommended'].rules,
+
+      // Disable preferring Promise-based async tests
+      'jest/no-test-callback': 'off',
+
+      'jest/no-done-callback': 'warn',
+      'jest/no-alias-methods': 'warn',
+      'jest/no-conditional-expect': 'warn',
+      'jest/valid-title': 'warn',
+      'jest/no-standalone-expect': 'warn',
+      'jest/no-deprecated-functions': 'warn',
+      'no-var': 'warn',
+    },
+  },
+);
+
+export default c;