Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: integrate vi and vitest for addons #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import type { StorybookConfig } from '@storybook/react-vite';
import path from 'path';

const addonName = path.basename(process.cwd()); // Get the addon name dynamically

const config: StorybookConfig = {
stories: ['../**/*.mdx', `../**/*.stories.@(js|jsx|mjs|ts|tsx)`],
addons: [
'@chromatic-com/storybook',
'@storybook/addon-a11y',
'@storybook/addon-docs',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
'@storybook/addon-links',
'@storybook/addon-onboarding',
'storybook-react-intl',
],
framework: {
name: '@storybook/react-vite',
options: {},
},
staticDirs: [`../../../public`],
viteFinal: async (config) => {
// Adjust paths as needed for the dynamically named addon
config.resolve = {
...config.resolve,
alias: {
...config.resolve?.alias,
[`@${addonName}`]: path.resolve(
__dirname,
`../../../packages/${addonName}/src/`,
),
},
};

// Markdown support (if needed)
config.plugins?.push({
name: 'vite-plugin-markdown',
transform(src, id) {
if (id.endsWith('.md')) {
return `export default ${JSON.stringify(src)}`;
}
},
});
return config;
},
};

export default config;
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import React from 'react';
import path from 'path';
import '@kitconcept/volto-light-theme/customizations/@root/theme';
import '../../../core/packages/volto/test-setup-config';

import {
Title,
Subtitle,
Description,
Controls,
Stories,
} from '@storybook/blocks';
import { Decorator, Preview } from '@storybook/react';
import { deMessages, enMessages, frMessages } from './localesWrapper';
import Wrapper from '../../../core/packages/volto/src/storybook';

// Dynamically resolve the addon’s name and paths
const addonName = path.basename(process.cwd());
const messagesMap = {
de: deMessages,
en: enMessages,
fr: frMessages,
};

const getMessages = (locale: string) =>
messagesMap[locale as keyof typeof messagesMap];

const decorators: Decorator[] = [
(Story, context) => {
return (
<Wrapper
customStore={{
intl: {
locale: context.globals.locale,
messages: getMessages(context.globals.locale),
},
}}
>
<Story locale={context.globals.locale} />
</Wrapper>
);
},
];

const parameters = {
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
docs: {
page: () => (
<>
<Title />
<Subtitle />
<Description />
<Stories />
<Controls />
</>
),
},
};

const reactIntl = {
defaultLocale: 'de',
locales: ['en', 'de', 'fr'],
};

const preview: Preview = {
globals: {
locale: reactIntl.defaultLocale,
locales: {
en: { icon: '🇺🇸', title: 'English', right: 'EN' },
de: { icon: '🇩🇪', title: 'Deutsch', right: 'DE' },
fr: { icon: '🇫🇷', title: 'Français', right: 'FR' },
},
},
parameters: {
reactIntl,
...parameters,
},
decorators,
};

export default preview;
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@
"dry-release": "release-it --dry-run",
"release": "release-it",
"release-major-alpha": "release-it major --preRelease=alpha",
"release-alpha": "release-it --preRelease=alpha"
"release-alpha": "release-it --preRelease=alpha",
"test": "vitest",
"storybook": "storybook dev -p 6006",
"storybook-build": "storybook build"
},
"dependencies": {},
"peerDependencies": {
Expand All @@ -33,6 +36,25 @@
},
"devDependencies": {
"@plone/scripts": "{{ cookiecutter.__version_plone_scripts }}",
"release-it": "{{ cookiecutter.__version_release_it }}"
"@vitejs/plugin-react": "^4.3.1",
"release-it": "{{ cookiecutter.__version_release_it }}",
"vite": "^5.3.1",
"vite-plugin-markdown": "^2.2.0",
"vite-tsconfig-paths": "^4.3.2",
"vitest": "^1.6.0",
"@testing-library/react": "^16.0.0",
"@testing-library/jest-dom": "^6.4.6",
"@storybook/react": "^8.1.10",
"@storybook/react-vite": "^8.1.10",
"@storybook/addon-a11y": "^8.1.10",
"@storybook/addon-actions": "^8.1.10",
"@storybook/addon-controls": "^8.1.10",
"@storybook/addon-docs": "^8.1.10",
"@storybook/addon-essentials": "^8.1.10",
"@storybook/addon-interactions": "^8.1.10",
"@storybook/addon-links": "^8.1.10",
"@storybook/addon-onboarding": "^8.1.10",
"@storybook/blocks": "^8.1.10",
"storybook-react-intl": "^3.0.1"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import '@testing-library/jest-dom';
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { defineConfig } from 'vite';
import tsconfigPaths from 'vite-tsconfig-paths';
import react from '@vitejs/plugin-react';
import path from 'path';
import fixReactVirtualized from 'esbuild-plugin-react-virtualized';

// Dynamically get the name of the generated addon
const addonName = path.basename(process.cwd());
const projectRootPath = path.resolve('../..');

// Vite configuration with dynamic addon name
export default defineConfig({
plugins: [react(), tsconfigPaths()],
optimizeDeps: {
esbuildOptions: {
plugins: [fixReactVirtualized as any],
},
include: ['@plone/volto/constants/Languages.cjs'],
},
resolve: {
alias: [
{ find: /^~@root/, replacement: projectRootPath },
{
find: `@${addonName}`,
replacement: `${projectRootPath}/packages/${addonName}/src/`,
},
{ find: /^~/, replacement: '' },
],
},
logLevel: 'error',
test: {
globals: true,
environment: 'jsdom',
setupFiles: './src/setupTests.ts',
include: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
},
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { defineConfig } from 'vitest/config';

export default defineConfig({
test: {
include: ['**/*.vitest.tsx'],
globals: true,
reporters: 'verbose',
environment: 'jsdom',
},
});
Loading