@justeattakeaway/pie-components-config 0.18.0 → 0.19.0

package/README.md

@@ -11,8 +11,11 @@ To use the shared config, all you need to do is import and re-export it in your
 
 ```js
 import viteConfig from '@justeattakeaway/pie-components-config/vite.config';
+import getPackageVersion from '@justeattakeaway/pie-monorepo-utils/utils/get-package-version.js';
 
-export default viteConfig;
+export default viteConfig({
+    version: getPackageVersion(__dirname),
+});
 ```
 
 You can also override any values by passing in an object which will be merged deeply with the default values.

package/index.js

@@ -1,4 +1,6 @@
-export * from './playwright-lit-config.js';
-export * from './playwright-lit-visual-config.js';
+// @playwright/test config
+export * from './playwright-native-config.js';
+export * from './playwright-native-visual-config.js';
+
 export * from './vite.config.js';
 export * from './custom-elements-manifest.config.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-components-config",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "main": "index.js",
   "type": "module",
   "author": "Just Eat Takeaway.com - Design System Team",

package/vite.config.js

@@ -5,7 +5,16 @@ import { visualizer } from 'rollup-plugin-visualizer';
 import { deepmerge } from 'deepmerge-ts';
 
 // https://vitejs.dev/config/
-const sharedConfig = ({ build = {}, plugins = [], ...rest }) => defineConfig({
+const sharedConfig = ({
+    build = {},
+    plugins = [],
+    dtsConfig = {},
+    version = 'missing',
+    ...rest
+}) => defineConfig({
+    define: {
+        __PACKAGE_VERSION__: JSON.stringify(version),
+    },
     build: deepmerge({
         lib: {
             entry: {
@@ -20,7 +29,9 @@ const sharedConfig = ({ build = {}, plugins = [], ...rest }) => defineConfig({
                     return true;
                 }
 
-                if (id.startsWith('@justeattakeaway/pie-')) {
+                // Any imports from pie-webc-core/src/internals are to be included in component bundles.
+                // Any imports outside of the internals folder must be externalised.
+                if (id.startsWith('@justeattakeaway/pie-') && !id.startsWith('@justeattakeaway/pie-webc-core/src/internals')) {
                     console.info(`Excluding ${id} from the bundle`);
                     return true;
                 }
@@ -29,6 +40,7 @@ const sharedConfig = ({ build = {}, plugins = [], ...rest }) => defineConfig({
             },
         },
     }, build),
+
     test: {
         dir: '.',
         environment: 'jsdom',
@@ -39,15 +51,22 @@ const sharedConfig = ({ build = {}, plugins = [], ...rest }) => defineConfig({
         ],
         exclude: ['**/node_modules/**'],
     },
-    plugins: deepmerge([dts({
-        insertTypesEntry: true,
-        outputDir: 'dist',
-        rollupTypes: true,
-    }),
-    visualizer({
-        gzipSize: true,
-        brotliSize: true,
-    })], plugins),
+
+    plugins: deepmerge(
+        [
+            dts({
+                insertTypesEntry: true,
+                outputDir: 'dist',
+                rollupTypes: true,
+                ...dtsConfig,
+            }),
+            visualizer({
+                gzipSize: true,
+                brotliSize: true,
+            }),
+        ],
+        plugins,
+    ),
 
     ...rest,
 });

package/playwright-lit-config.js

@@ -1,62 +0,0 @@
-import { devices } from '@sand4rt/experimental-ct-web';
-import path from 'path';
-
-/**
- * See https://playwright.dev/docs/test-configuration
- */
-export function getPlaywrightConfig () {
-    return {
-        /* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
-        snapshotDir: './__snapshots__',
-        /* Maximum time one test can run for. */
-        timeout: 10 * 1000,
-        testIgnore: '*-react.spec.js',
-        /* Run tests in files in parallel */
-        fullyParallel: true,
-        /* Fail the build on CI if you accidentally left test.only in the source code. */
-        forbidOnly: !!process.env.CI,
-        /* Retry on CI only */
-        retries: process.env.CI ? 2 : 0,
-        /* Opt out of parallel tests on CI. */
-        workers: '50%',
-        /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-        reporter: [['html', { outputFolder: 'lit-browsers-report' }]],
-        /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-        use: {
-            ctViteConfig: {
-                resolve: {
-                    alias: {
-                        '@': path.resolve('./src'),
-                    },
-                },
-            },
-            /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-            trace: 'on',
-            testIdAttribute: 'data-test-id',
-        },
-
-        /* Configure projects for major browsers */
-        projects: [
-            {
-                name: 'component:chrome',
-                use: {
-                    ...devices['Desktop Chrome'],
-                },
-                testMatch: ['**/test/component/*.spec.{js,ts}'],
-            },
-            {
-                name: 'a11y:chrome',
-                use: {
-                    ...devices['Desktop Chrome'],
-                },
-                testMatch: ['**/test/accessibility/*.spec.{js,ts}'],
-            },
-        ],
-        webServer: !process.env.CI ? {
-            command: 'npx turbo dev --filter=pie-storybook',
-            url: 'http://localhost:6006',
-            timeout: 120 * 10000,
-            reuseExistingServer: !process.env.CI,
-        } : undefined,
-    };
-}

package/playwright-lit-visual-config.js

@@ -1,60 +0,0 @@
-import { devices } from '@sand4rt/experimental-ct-web';
-import path from 'path';
-
-/**
- * See https://playwright.dev/docs/test-configuration
- */
-export function getPlaywrightVisualConfig () {
-    return {
-        /* Maximum time one test can run for. */
-        timeout: 10 * 1000,
-        /* Run tests in files in parallel */
-        fullyParallel: true,
-        /* Fail the build on CI if you accidentally left test.only in the source code. */
-        forbidOnly: !!process.env.CI,
-        /* Retry on CI only */
-        retries: process.env.CI ? 2 : 0,
-        /* Opt out of parallel tests on CI. */
-        workers: '50%',
-        /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-        reporter: [['html', { outputFolder: 'lit-visual-report' }]],
-        /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-        use: {
-            ctViteConfig: {
-                resolve: {
-                    alias: {
-                        '@': path.resolve('./src'),
-                    },
-                },
-            },
-            /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-            trace: 'on',
-            testIdAttribute: 'data-test-id',
-            discovery: {
-                disallowedHostnames: [
-                    'unpkg.com'
-                ],
-            },
-        },
-
-        /* Configure projects for major browsers */
-        projects: [
-            {
-                name: 'visual:desktop',
-                grepInvert: /@mobile/,
-                use: {
-                    ...devices['Desktop Chrome'],
-                },
-                testMatch: ['**/test/visual/*.spec.ts'],
-            },
-            {
-                name: 'visual:mobile',
-                grep: /@mobile/,
-                use: {
-                    ...devices['Galaxy S8'],
-                },
-                testMatch: ['**/test/visual/*.spec.ts'],
-            },
-        ],
-    };
-}