Introducing, glob-sort: a better way to custom sort test file execution order.

[bvandercar-vt]

Do you want to set a custom test execution order, but want a better way than prefixing all your test files with numbers (i.e. 01-setup.spec.ts, 02-form.spec.ts), or using the default minimatch in Cypress specPattern config (which doesn't always order things correctly)?

Introducing my new package, glob-sort. It sorts by any prefixed numbers, then by passed custom keywords or regex patterns, then finally, alphabetically.

Example usage in cypress.config:

import { defineConfig } from 'cypress'
import { sortedGlob } from 'glob-sort'

export default defineConfig({
  e2e: {
    specPattern: await sortedGlob('cypress/tests/**/*.spec*', {
        sortOrder: [
            // run in this order (anything not matching will come after, alphabetically)
            'setup',
            /new(?!-special)/i, // i.e. "new.spec" before "new-special.spec"
            'new',
            'edit',
            /^delete.*/i,        // starts with
            /^(?!.*history)/i,   // does not contain (place these last, in each folder)
            'view',
        ],
      })
    ...
  },
})

Results:

Before (File System Order, Alphabetical)	After (Custom Sort)
01-widget-cards/ booking-calendar.spec.ts entrees.spec.ts setup.spec.ts upcoming-bookings.spec.tsx 02-table-pages/ 01-entree-dinner/ entree-dinner-table.spec.ts entree-flavors-table.spec.tsx 02-booking/ bookings-history-table.spec.ts bookings-table.spec.tsx customers-table.spec.ts entree-lunch-table.spec.ts users-table.spec.ts 03-view-pages/ print-booking.spec.ts print-entree-dinner.spec.ts setup.spec.ts view-appetizer-count.spec.ts view-appetizer-supplier.spec.ts view-booking.spec.ts view-entree-dinner.spec.ts view-entree-lunch.spec.ts view-user.spec.ts 04-forms/ booking-form/ clone-booking.spec.ts edit-booking.spec.ts new-booking.spec.ts new-special-booking.spec.ts setup.spec.ts entree-dinner/ edit-entree-dinner.spec.ts new-entree-dinner.spec.ts entree-lunch/ edit-entree-lunch.spec.ts new-entree-lunch.spec.ts user/ edit-user.spec.ts cake-frosting-input.spec.ts cake-order-input.spec.ts misc-components/ booking-status.spec.ts layout.spec.ts site-info-button.spec.ts user-info-button.spec.ts	01-widget-cards/ +- setup.spec.tsx +- booking-calendar.spec.ts +- upcoming-bookings.spec.tsx +- entrees.spec.ts 02-table-pages/ 01-entree-dinner/ entree-dinner-table.spec.ts entree-flavors-table.spec.tsx 02-booking/ +- bookings-table.spec.tsx +- bookings-history-table.spec.ts +- entree-lunch-table.spec.ts +- users-table.spec.ts +- customers-table.spec.ts 03-view-pages/ +- setup.spec.tsx +- view-booking.spec.ts +- print-booking.spec.ts +- view-entree-dinner.spec.ts +- view-entree-lunch.spec.ts +- print-entree-dinner.spec.ts +- view-appetizer-count.spec.ts +- view-appetizer-supplier.spec.ts view-user.spec.ts 04-forms/ booking-form/ +- setup.spec.tsx +- new-booking.spec.ts +- new-special-booking.spec.ts +- edit-booking.spec.ts +- clone-booking.spec.ts entree-dinner/ +- new-entree-dinner.spec.ts +- edit-entree-dinner.spec.ts entree-lunch/ +- new-entree-lunch.spec.ts +- edit-entree-lunch.spec.ts user/ edit-user.spec.ts cake-frosting-input.spec.ts cake-order-input.spec.ts misc-components/ booking-status.spec.ts +- user-info-button.spec.ts +- layout.spec.ts +- site-info-button.spec.ts
Actual output of the function to pass to Cypress config
01-widget-cards/setup.spec.ts 01-widget-cards/booking-calendar.spec.ts 01-widget-cards/upcoming-bookings.spec.tsx 01-widget-cards/entrees.spec.ts 02-table-pages/01-entree-dinner/entree-dinner-table.spec.ts 02-table-pages/01-entree-dinner/entree-flavors-table.spec.tsx 02-table-pages/02-booking/bookings-table.spec.tsx 02-table-pages/02-booking/bookings-history-table.spec.ts 02-table-pages/entree-lunch-table.spec.ts 02-table-pages/users-table.spec.ts 02-table-pages/customers-table.spec.ts 03-view-pages/setup.spec.ts 03-view-pages/view-booking.spec.ts 03-view-pages/print-booking.spec.ts 03-view-pages/view-entree-dinner.spec.ts 03-view-pages/view-entree-lunch.spec.ts 03-view-pages/print-entree-dinner.spec.ts 03-view-pages/view-appetizer-count.spec.ts 03-view-pages/view-appetizer-supplier.spec.ts 03-view-pages/view-user.spec.ts 04-forms/booking-form/setup.spec.ts 04-forms/booking-form/new-booking.spec.ts 04-forms/booking-form/new-special-booking.spec.ts 04-forms/booking-form/edit-booking.spec.ts 04-forms/booking-form/clone-booking.spec.ts 04-forms/entree-dinner/new-entree-dinner.spec.ts 04-forms/entree-dinner/edit-entree-dinner.spec.ts 04-forms/entree-lunch/new-entree-lunch.spec.ts 04-forms/entree-lunch/edit-entree-lunch.spec.ts 04-forms/user/edit-user.spec.ts 04-forms/cake-frosting-input.spec.ts 04-forms/cake-order-input.spec.ts misc-components/booking-status.spec.ts misc-components/user-info-button.spec.ts misc-components/layout.spec.ts misc-components/site-info-button.spec.ts