@justeattakeaway/pie-components-config 0.8.0 → 0.10.0

package/index.js

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

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@justeattakeaway/pie-components-config",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "main": "index.js",
   "type": "module",
   "author": "Just Eat Takeaway.com - Design System Team",
   "description": "Shared configuration files for PIE components",
   "files": [
-    "custom-elements-manifest.config.js"
+    "custom-elements-manifest.config.js",
+    "vite.config.js",
+    "tsconfig.json",
+    "playwright-lit-config.js",
+    "playwright-lit-visual-config.js"
   ],
   "dependencies": {
     "deepmerge-ts": "5.1.0"

package/playwright-lit-config.js

@@ -0,0 +1,54 @@
+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,
+        /* 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',
+        },
+
+        /* Configure projects for major browsers */
+        projects: [
+            {
+                name: 'component:chrome',
+                use: {
+                    ...devices['Desktop Chrome'],
+                },
+                testMatch: ['**/test/component/*.spec.ts'],
+            },
+            {
+                name: 'a11y:chrome',
+                use: {
+                    ...devices['Desktop Chrome'],
+                },
+                testMatch: ['**/test/accessibility/*.spec.ts'],
+            },
+        ],
+    };
+}

package/playwright-lit-visual-config.js

@@ -0,0 +1,54 @@
+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',
+        },
+
+        /* 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['Pixel 5'],
+                },
+                testMatch: ['**/test/visual/*.spec.ts'],
+            },
+        ],
+    };
+}

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "ES2022",
+    "lib": ["es2020", "DOM", "DOM.Iterable"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "outDir": "./compiled",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+  },
+  "exclude": []
+}

package/vite.config.js

@@ -0,0 +1,47 @@
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+
+import { deepmerge } from 'deepmerge-ts';
+
+const bundledJetDeps = [
+    '@justeattakeaway/pie-components-config',
+    '@justeattakeaway/pie-css',
+    '@justeattakeaway/pie-webc-testing',
+];
+
+// https://vitejs.dev/config/
+const sharedConfig = ({ build = {}, plugins = [], ...rest }) => defineConfig({
+    build: deepmerge({
+        lib: {
+            entry: {
+                index: 'src/index.ts',
+                react: 'src/react.ts',
+            },
+            formats: ['es'],
+        },
+        rollupOptions: {
+            external: (id) => {
+                if (['react', '@lit/react'].includes(id) || /^lit/.test(id)) {
+                    return true;
+                }
+
+                if (id.startsWith('@justeattakeaway/pie-') && !bundledJetDeps.includes(id)) {
+                    console.info(`Excluding ${id} from the bundle`);
+                    return true;
+                }
+
+                return false;
+            },
+        },
+    }, build),
+
+    plugins: deepmerge([dts({
+        insertTypesEntry: true,
+        outputDir: 'dist',
+        rollupTypes: true,
+    })], plugins),
+
+    ...rest,
+});
+
+export default sharedConfig;