@storybook/addon-storyshots
Version:
Take a code snapshot of every story automatically with Jest
57 lines (56 loc) • 2.37 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
/* eslint-disable jest/no-export */
const fs_1 = __importDefault(require("fs"));
const glob_1 = require("glob");
const global_1 = require("@storybook/global");
const ts_dedent_1 = require("ts-dedent");
const { describe, it } = global_1.global;
expect.extend({
notToBeAbandoned(storyshots, stories2snapsConverter) {
const abandonedStoryshots = storyshots.filter((fileName) => {
const possibleStoriesFiles = stories2snapsConverter.getPossibleStoriesFiles(fileName);
return !possibleStoriesFiles.some(fs_1.default.existsSync);
});
if (abandonedStoryshots.length === 0) {
return { pass: true, message: () => '' };
}
const formattedList = abandonedStoryshots.join('\n ');
// See https://github.com/facebook/jest/issues/8732#issuecomment-516445064
// eslint-disable-next-line no-underscore-dangle
const isUpdate = expect.getState().snapshotState._updateSnapshot === 'all';
if (isUpdate) {
abandonedStoryshots.forEach((file) => fs_1.default.unlinkSync(file));
// eslint-disable-next-line no-console
console.log((0, ts_dedent_1.dedent) `
Removed abandoned storyshots:
${formattedList}
`);
return { pass: true, message: () => '' };
}
return {
pass: false,
message: () => (0, ts_dedent_1.dedent) `
Found abandoned storyshots. Run jest with -u to remove them:
${formattedList}
`,
};
},
});
function integrityTest(integrityOptions, stories2snapsConverter) {
if (integrityOptions === false) {
return;
}
describe('Storyshots Integrity', () => {
it('Abandoned Storyshots', () => {
const snapshotExtension = stories2snapsConverter.getSnapshotExtension();
const storyshots = (0, glob_1.globSync)(`**/*${snapshotExtension}`, integrityOptions);
// @ts-expect-error (ts doesn't 'get' the extension happening on line 9)
expect(storyshots).notToBeAbandoned(stories2snapsConverter);
});
});
}
exports.default = integrityTest;