From 8be9c1ea5f09658bb5aad3cd4832e35b2ff63e23 Mon Sep 17 00:00:00 2001 From: Kanthesha Devaramane Date: Fri, 20 Oct 2023 16:48:38 +0100 Subject: [PATCH 1/4] Updated tsconfig*.json, typedoc.json, jest.config.js to align with core monorepo --- .../json-rpc-engine/jest.config.js | 194 +----------------- merged-packages/json-rpc-engine/package.json | 1 + .../json-rpc-engine/tsconfig.build.json | 14 +- merged-packages/json-rpc-engine/tsconfig.json | 16 +- merged-packages/json-rpc-engine/typedoc.json | 3 +- 5 files changed, 20 insertions(+), 208 deletions(-) diff --git a/merged-packages/json-rpc-engine/jest.config.js b/merged-packages/json-rpc-engine/jest.config.js index 83e15048b1..ca08413339 100644 --- a/merged-packages/json-rpc-engine/jest.config.js +++ b/merged-packages/json-rpc-engine/jest.config.js @@ -3,40 +3,16 @@ * https://jestjs.io/docs/configuration */ -module.exports = { - // All imported modules in your tests should be mocked automatically - // automock: false, +const merge = require('deepmerge'); +const path = require('path'); - // Stop running tests after `n` failures - // bail: 0, +const baseConfig = require('../../jest.config.packages'); - // The directory where Jest should store its cached dependency information - // cacheDirectory: "/private/var/folders/fk/c3y07g0576j8_2s9m01pk4qw0000gn/T/jest_dx", +const displayName = path.basename(__dirname); - // Automatically clear mock calls, instances and results before every test. - // This does not remove any mock implementation that may have been provided, - // so we disable it. - // clearMocks: true, - - // Indicates whether the coverage information should be collected while executing the test - collectCoverage: true, - - // An array of glob patterns indicating a set of files for which coverage information should be collected - collectCoverageFrom: ['./src/**/*.ts'], - - // The directory where Jest should output its coverage files - coverageDirectory: 'coverage', - - // An array of regexp pattern strings used to skip coverage collection - // coveragePathIgnorePatterns: [ - // "/node_modules/" - // ], - - // Indicates which provider should be used to instrument code for coverage - coverageProvider: 'babel', - - // A list of reporter names that Jest uses when writing coverage reports - coverageReporters: ['html', 'json-summary', 'text'], +module.exports = merge(baseConfig, { + // The display name when running multiple projects + displayName, // An object that configures minimum threshold enforcement for coverage results coverageThreshold: { @@ -47,158 +23,4 @@ module.exports = { statements: 100, }, }, - - // A path to a custom dependency extractor - // dependencyExtractor: undefined, - - // Make calling deprecated APIs throw helpful error messages - // errorOnDeprecated: false, - - // Force coverage collection from ignored files using an array of glob patterns - // forceCoverageMatch: [], - - // A path to a module which exports an async function that is triggered once before all test suites - // globalSetup: undefined, - - // A path to a module which exports an async function that is triggered once after all test suites - // globalTeardown: undefined, - - // A set of global variables that need to be available in all test environments - // globals: {}, - - // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers. - // maxWorkers: "50%", - - // An array of directory names to be searched recursively up from the requiring module's location - // moduleDirectories: [ - // "node_modules" - // ], - - // An array of file extensions your modules use - // moduleFileExtensions: [ - // "js", - // "jsx", - // "ts", - // "tsx", - // "json", - // "node" - // ], - - // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module - // moduleNameMapper: {}, - - // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader - // modulePathIgnorePatterns: [], - - // Activates notifications for test results - // notify: false, - - // An enum that specifies notification mode. Requires { notify: true } - // notifyMode: "failure-change", - - // A preset that is used as a base for Jest's configuration - preset: 'ts-jest', - - // Run tests from one or more projects - // projects: undefined, - - // Use this configuration option to add custom reporters to Jest - // reporters: undefined, - - // "resetMocks" resets all mocks, including mocked modules, to jest.fn(), - // between each test case. - resetMocks: true, - - // Reset the module registry before running each individual test - // resetModules: false, - - // A path to a custom resolver - // resolver: undefined, - - // "restoreMocks" restores all mocks created using jest.spyOn to their - // original implementations, between each test. It does not affect mocked - // modules. - restoreMocks: true, - - // The root directory that Jest should scan for tests and modules within - // rootDir: undefined, - - // A list of paths to directories that Jest should use to search for files in - // roots: [ - // "" - // ], - - // Allows you to use a custom runner instead of Jest's default test runner - // runner: "jest-runner", - - // The paths to modules that run some code to configure or set up the testing environment before each test - // setupFiles: [], - - // A list of paths to modules that run some code to configure or set up the testing framework before each test - // setupFilesAfterEnv: [], - - // The number of seconds after which a test is considered as slow and reported as such in the results. - // slowTestThreshold: 5, - - // A list of paths to snapshot serializer modules Jest should use for snapshot testing - // snapshotSerializers: [], - - // The test environment that will be used for testing - // testEnvironment: "jest-environment-node", - - // Options that will be passed to the testEnvironment - // testEnvironmentOptions: {}, - - // Adds a location field to test results - // testLocationInResults: false, - - // The glob patterns Jest uses to detect test files - // testMatch: [ - // "**/__tests__/**/*.[jt]s?(x)", - // "**/?(*.)+(spec|test).[tj]s?(x)" - // ], - - // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped - // testPathIgnorePatterns: [ - // "/node_modules/" - // ], - - // The regexp pattern or array of patterns that Jest uses to detect test files - // testRegex: [], - - // This option allows the use of a custom results processor - // testResultsProcessor: undefined, - - // This option allows use of a custom test runner - // testRunner: "jest-circus/runner", - - // Reduce the default test timeout from 5s to 2.5s - testTimeout: 2500, - - // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href - // testURL: "http://localhost", - - // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout" - // timers: "real", - - // A map from regular expressions to paths to transformers - // transform: undefined, - - // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation - // transformIgnorePatterns: [ - // "/node_modules/", - // "\\.pnp\\.[^\\/]+$" - // ], - - // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them - // unmockedModulePathPatterns: undefined, - - // Indicates whether each individual test should be reported during the run - // verbose: undefined, - - // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode - // watchPathIgnorePatterns: [], - - // Whether to use watchman for file crawling - // watchman: true, -}; +}); diff --git a/merged-packages/json-rpc-engine/package.json b/merged-packages/json-rpc-engine/package.json index b6fddbe8b4..55f34ce452 100644 --- a/merged-packages/json-rpc-engine/package.json +++ b/merged-packages/json-rpc-engine/package.json @@ -49,6 +49,7 @@ "@types/node": "^18.15.11", "@typescript-eslint/eslint-plugin": "^5.43.0", "@typescript-eslint/parser": "^5.43.0", + "deepmerge": "^4.2.2", "depcheck": "^1.4.3", "eslint": "^8.27.0", "eslint-config-prettier": "^8.5.0", diff --git a/merged-packages/json-rpc-engine/tsconfig.build.json b/merged-packages/json-rpc-engine/tsconfig.build.json index c6e00d654a..0df910b215 100644 --- a/merged-packages/json-rpc-engine/tsconfig.build.json +++ b/merged-packages/json-rpc-engine/tsconfig.build.json @@ -1,13 +1,9 @@ { - "extends": "./tsconfig.json", + "extends": "../../tsconfig.packages.build.json", "compilerOptions": { - "declaration": true, - "inlineSources": true, - "noEmit": false, - "outDir": "dist", - "rootDir": "src", - "sourceMap": true + "baseUrl": "./", + "outDir": "./dist", + "rootDir": "./src" }, - "include": ["./src/**/*.ts"], - "exclude": ["./src/**/*.test.ts"] + "include": ["../../types", "./src"] } diff --git a/merged-packages/json-rpc-engine/tsconfig.json b/merged-packages/json-rpc-engine/tsconfig.json index 23c8ceb7a6..b62964da64 100644 --- a/merged-packages/json-rpc-engine/tsconfig.json +++ b/merged-packages/json-rpc-engine/tsconfig.json @@ -1,16 +1,8 @@ { + "extends": "../../tsconfig.packages.json", "compilerOptions": { - "esModuleInterop": true, - "exactOptionalPropertyTypes": true, - "forceConsistentCasingInFileNames": true, - "lib": ["ES2020"], - "module": "CommonJS", - "moduleResolution": "node", - "noEmit": true, - "noErrorTruncation": true, - "noUncheckedIndexedAccess": true, - "strict": true, - "target": "es2020" + "baseUrl": "./", + "rootDir": "../..", }, - "exclude": ["./dist/**/*"] + "include": ["../../types", "../../tests", "./src", "./tests"] } diff --git a/merged-packages/json-rpc-engine/typedoc.json b/merged-packages/json-rpc-engine/typedoc.json index b527b62572..c9da015dbf 100644 --- a/merged-packages/json-rpc-engine/typedoc.json +++ b/merged-packages/json-rpc-engine/typedoc.json @@ -2,5 +2,6 @@ "entryPoints": ["./src/index.ts"], "excludePrivate": true, "hideGenerator": true, - "out": "docs" + "out": "docs", + "tsconfig": "./tsconfig.build.json" } From 320867c4d102483e94e7b70fc6ebc0f5b61bdd7b Mon Sep 17 00:00:00 2001 From: Jongsun Suh <34228073+MajorLift@users.noreply.github.com> Date: Fri, 20 Oct 2023 13:24:03 -0700 Subject: [PATCH 2/4] preserve typescript compiler flags and target --- merged-packages/json-rpc-engine/tsconfig.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/merged-packages/json-rpc-engine/tsconfig.json b/merged-packages/json-rpc-engine/tsconfig.json index b62964da64..4e929aca4e 100644 --- a/merged-packages/json-rpc-engine/tsconfig.json +++ b/merged-packages/json-rpc-engine/tsconfig.json @@ -3,6 +3,11 @@ "compilerOptions": { "baseUrl": "./", "rootDir": "../..", + "exactOptionalPropertyTypes": true, + "forceConsistentCasingInFileNames": true, + "noErrorTruncation": true, + "noUncheckedIndexedAccess": true, + "target": "es2020" }, "include": ["../../types", "../../tests", "./src", "./tests"] } From fb81f3b25575dbf3bdeb2a48b386bf5f7cd01a8b Mon Sep 17 00:00:00 2001 From: Kanthesha Devaramane Date: Mon, 23 Oct 2023 09:47:12 +0100 Subject: [PATCH 3/4] preserve typescript compiler flags from source repo Co-authored-by: Jongsun Suh <34228073+MajorLift@users.noreply.github.com> --- merged-packages/json-rpc-engine/tsconfig.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/merged-packages/json-rpc-engine/tsconfig.json b/merged-packages/json-rpc-engine/tsconfig.json index 4e929aca4e..4f916a19b4 100644 --- a/merged-packages/json-rpc-engine/tsconfig.json +++ b/merged-packages/json-rpc-engine/tsconfig.json @@ -8,6 +8,11 @@ "noErrorTruncation": true, "noUncheckedIndexedAccess": true, "target": "es2020" + "exactOptionalPropertyTypes": true, + "forceConsistentCasingInFileNames": true, + "noErrorTruncation": true, + "noUncheckedIndexedAccess": true, + "target": "es2020" }, "include": ["../../types", "../../tests", "./src", "./tests"] } From 2f29b30b58c95a42a9b84362bb5495229a785495 Mon Sep 17 00:00:00 2001 From: Kanthesha Devaramane Date: Mon, 23 Oct 2023 15:57:40 +0100 Subject: [PATCH 4/4] remove duplication in tsconfig --- merged-packages/json-rpc-engine/tsconfig.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/merged-packages/json-rpc-engine/tsconfig.json b/merged-packages/json-rpc-engine/tsconfig.json index 4f916a19b4..4e929aca4e 100644 --- a/merged-packages/json-rpc-engine/tsconfig.json +++ b/merged-packages/json-rpc-engine/tsconfig.json @@ -8,11 +8,6 @@ "noErrorTruncation": true, "noUncheckedIndexedAccess": true, "target": "es2020" - "exactOptionalPropertyTypes": true, - "forceConsistentCasingInFileNames": true, - "noErrorTruncation": true, - "noUncheckedIndexedAccess": true, - "target": "es2020" }, "include": ["../../types", "../../tests", "./src", "./tests"] }