Skip to content

Commit

Permalink
chore: migrate to jest
Browse files Browse the repository at this point in the history
  • Loading branch information
mscharley committed Oct 13, 2024
1 parent ed09851 commit 77b7768
Show file tree
Hide file tree
Showing 22 changed files with 2,466 additions and 803 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ dist/
.turbo/
reports/
.nyc_output/
coverage/
.vscode/settings.json
/temp
/generic-type-guard.*
Expand Down
6 changes: 0 additions & 6 deletions .mocharc.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ type Foo = tg.GuardedType<typeof isFoo>;
[gh-contrib]: https://github.com/mscharley/generic-type-guard/graphs/contributors
[gh-issues]: https://github.com/mscharley/generic-type-guard/issues
[license]: https://github.com/mscharley/generic-type-guard/blob/master/LICENSE
[example-usage]: https://github.com/mscharley/generic-type-guard/blob/main/src/examples.spec.ts
[example-usage]: https://github.com/mscharley/generic-type-guard/blob/main/src/__tests__/examples.ts
220 changes: 220 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
/*
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/configuration
*/

/** @type {import('jest').Config} */
export default {
// A preset that is used as a base for Jest's configuration
// preset: 'ts-jest',

// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/tmp/jest_rs",

// Automatically clear mock calls, instances, contexts and results before every test
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: 'reports/coverage',

// An array of regexp pattern strings used to skip coverage collection
coveragePathIgnorePatterns: [
'/node_modules/',
'/__utils__/',
// This file is only re-exports
'/src/index.ts',
// This file is only types and will never actually be imported
'/src/guards.ts',
],

// Indicates which provider should be used to instrument code for coverage
coverageProvider: 'v8',

// A list of reporter names that Jest uses when writing coverage reports
coverageReporters: ['json', 'text', 'lcov', 'clover'],

// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: { branches: 100, functions: 100, lines: 100, statements: 100 },
},

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": 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",
// "mjs",
// "cjs",
// "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: {
'^(\\.{1,2}/.*)\\.js$': '$1',
},

// 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",

// Use an explicit null path to prettier to disable it.
prettierPath: null,

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: ['summary'],

// Automatically reset mock state before every test
resetMocks: true,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state and implementation before every test
// restoreMocks: false,

// 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: [
// "<rootDir>"
// ],

// 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: '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/', '/dist/', '/__utils__/', '/examples/'],

// 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",

// A map from regular expressions to paths to transformers
transform: {
'^.+\\.m?[tj]sx?$': [
'@swc/jest',
{
$schema: 'https://swc.rs/schema.json',
jsc: {
parser: {
syntax: 'typescript',
},
target: 'es2022',
experimental: {
keepImportAssertions: true,
},
},
},
],
},

// Extensions that Jest should treat as ESM modules
extensionsToTreatAsEsm: ['.ts'],

// 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,
};
11 changes: 4 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
"lint": "eslint",
"lint-fix": "eslint",
"lint-watch": "nodemon -e ts,json --exec eslint",
"mocha": "c8 mocha 'src/**/*.spec.ts'",
"mocha-watch": "nodemon -e ts,json --exec turbo mocha",
"jest": "DECORATOR_TYPE=experimental NODE_OPTIONS='--experimental-vm-modules' jest",
"stryker": "stryker run",
"stryker-watch": "nodemon -e ts,json --exec stryker run",
"cs-version": "turbo build && changeset version",
Expand Down Expand Up @@ -88,20 +87,18 @@
},
"devDependencies": {
"@changesets/cli": "2.27.9",
"@jest/globals": "^29.7.0",
"@microsoft/api-extractor": "7.47.9",
"@mscharley/eslint-config": "4.0.4",
"@mscharley/prettier-config": "3.0.7",
"@stryker-mutator/core": "8.6.0",
"@stryker-mutator/mocha-runner": "8.6.0",
"@stryker-mutator/typescript-checker": "8.6.0",
"@types/chai": "5.0.0",
"@types/mocha": "10.0.9",
"@swc/jest": "^0.2.36",
"@types/node": "20.16.11",
"c8": "10.1.2",
"chai": "5.1.1",
"esbuild": "0.24.0",
"eslint-plugin-notice": "1.0.0",
"mocha": "10.7.3",
"jest": "^29.7.0",
"nodemon": "3.1.7",
"rimraf": "6.0.1",
"source-map-support": "0.5.21",
Expand Down
Loading

0 comments on commit 77b7768

Please sign in to comment.