Use this file to discover all available pages before exploring further.
When a test suite grows large, re-running every test after a small change can be slow — especially in an ExtendScript environment where there is no native watch mode. KT Testing Suite Core lets you pass a filter string that limits execution to tests whose full name contains the filter as a substring, so you can focus on just the area you are working on without commenting out any code.
The runner builds a full test name for each it() by joining the suite description path with the test name, separated by spaces. For example, a test named 'deep match' inside describe('Nested Suite') which is itself inside describe('Root Suite') gets the full name:
Root Suite Nested Suite deep match
When a filter is active, the runner calls shouldSkip() on each full test name:
private shouldSkip(fullName: string): boolean { if (!this.filter) return false; // Simple case-insensitive substring match return fullName.toLowerCase().indexOf(this.filter.toLowerCase()) === -1;}
A test is skipped (silently, with no output) if its full name does not contain the filter string. A test is run if it does. Matching is case-insensitive and uses plain substring search — no glob syntax or regular expressions.
runTests() accepts an optional third argument for the filter string. This is the quickest way to filter without instantiating a TestRunner directly.
import { runTests } from 'kt-testing-suite-core';import './math.test';import './stringUtils.test';// Run only tests whose full name contains "addition"runTests(undefined, undefined, 'addition');
The first two arguments are the suites array and the reporter. Passing undefined for both uses the defaults (getSuites() and ConsoleReporter).
When you need finer control — for example to combine filtering with a custom reporter — pass the filter as the second argument to the TestRunner constructor:
import { getSuites, TestRunner, ConsoleReporter } from 'kt-testing-suite-core';import './math.test';import './stringUtils.test';const reporter = new ConsoleReporter();const runner = new TestRunner(reporter, 'addition');runner.run(getSuites());
The filter parameter is optional on both runTests() and new TestRunner(). Omitting it (or passing undefined) runs all registered tests.
When no filter is provided, every test in the tree executes.
it('should run all tests when no filter is provided', () => { const suite = createMockSuite(); const reporter = new MockReporter(); const runner = new TestRunner(reporter); // No filter runner.run([suite]); expect(reporter.stats).toBeDefined(); if (reporter.stats) { expect(reporter.stats.total).toBe(4); expect(reporter.runTests).toHaveLength(4); }});
A filter of 'match' matches any full test name containing the word “match”. Both 'Root Suite match' and 'Root Suite Nested Suite deep match' qualify; 'ignore' variants do not.
it('should run only tests matching the filter (simple match)', () => { const suite = createMockSuite(); const reporter = new MockReporter(); const runner = new TestRunner(reporter, 'match'); runner.run([suite]); expect(reporter.stats).toBeDefined(); if (reporter.stats) { expect(reporter.runTests).toInclude('match'); expect(reporter.runTests).toInclude('deep match'); expect(reporter.runTests).not().toInclude('ignore'); expect(reporter.runTests).not().toInclude('deep ignore'); expect(reporter.stats.total).toBe(2); }});
Because the runner prefixes every test’s full name with all of its ancestor suite descriptions, filtering on a suite description string matches all tests inside that suite. A filter of 'Nested' matches 'Root Suite Nested Suite deep match' and 'Root Suite Nested Suite deep ignore', but not the root-level tests whose full names contain only 'Root Suite'.
it('should run only tests matching the filter (nested suite description match)', () => { const suite = createMockSuite(); const reporter = new MockReporter(); const runner = new TestRunner(reporter, 'Nested'); // Matches all tests in Nested Suite runner.run([suite]); expect(reporter.stats).toBeDefined(); if (reporter.stats) { expect(reporter.runTests).toInclude('deep match'); expect(reporter.runTests).toInclude('deep ignore'); expect(reporter.runTests).not().toInclude('match'); // Root tests don't have "Nested" expect(reporter.stats.total).toBe(2); }});
If the filter string does not appear in any full test name, the runner executes zero tests and the final totals are all 0. No error or warning is produced.
it('should run no tests if filter matches nothing', () => { const suite = createMockSuite(); const reporter = new MockReporter(); const runner = new TestRunner(reporter, 'NonExistent'); runner.run([suite]); if (reporter.stats) { expect(reporter.stats.total).toBe(0); }});
Skipped tests produce no output at all — they are not counted in passed, failed, or total, and the reporter never receives an onTestStart call for them. If you want to confirm which tests actually ran, inspect the reporter’s recorded test names rather than the totals.
