@salesforce/pwa-kit-dev 3.8.0-preview.0-basepath → 3.8.0-preview.2-basepath

package/configs/babel/babel-config.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const config = {
+  sourceType: 'unambiguous',
+  presets: [[require('@babel/preset-env'), {
+    targets: {
+      node: 18
+    }
+  }], require('@babel/preset-typescript'), require('@babel/preset-react')],
+  plugins: [require('@babel/plugin-transform-async-to-generator'), require('@babel/plugin-proposal-object-rest-spread'), require('@babel/plugin-transform-object-assign'), [require('@babel/plugin-transform-runtime'), {
+    regenerator: true
+  }], require('@babel/plugin-syntax-dynamic-import'), require('@loadable/babel-plugin'), require('@babel/plugin-proposal-optional-chaining'), [require('babel-plugin-formatjs'), {
+    idInterpolationPattern: '[sha512:contenthash:base64:6]',
+    ast: true
+  }], require('@babel/plugin-transform-async-generator-functions')],
+  env: {
+    test: {
+      presets: [require('@babel/preset-env'), require('@babel/preset-react')],
+      plugins: [require('babel-plugin-dynamic-import-node-babel-7')]
+    }
+  }
+};
+var _default = exports.default = config;

package/configs/eslint/README.md

@@ -0,0 +1,21 @@
+# `pwa-kit-dev` ESLint configuations
+
+## Configs
+
+There are three configurations available:
+
+* `recommended`: The default expectation for PWA Kit projects. Provides rules for JavaScript, TypeScript, React, and Jest.
+* `no-react`: The `recommended` configuration with React rules removed to avoid logging unnecessary warnings.
+* `safe-types`: The `recommended` configuration with stricter rules in TypeScript files regarding usage of the `any` type.
+
+## Usage
+
+Extending a `pwa-kit-dev` ESLint configuration is a little bit from the standard way to extend a file. Because the config is not from a package with a name starting with `eslint-config-`, you must provide the full path to the configuration file using `require.resolve()`. For example, a configuration file that simply extends the `recommended` configuration would look like this:
+
+```js
+module.exports = {
+  extends: [require.resolve('@salesforce/pwa-kit-dev/configs/eslint/recommended')]
+}
+```
+
+> **Note:** For convenience, `@salesforce/pwa-kit-dev/configs/eslint` is provided as an alias for the `recommended` configuration.

package/configs/eslint/eslint-config.js

@@ -0,0 +1,11 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/** This is an alias of the default/recommended config, provided for backwards compatibility with v2. */
+module.exports = require('./index');

package/configs/eslint/index.js

@@ -0,0 +1,11 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+// Default config is an alias for 'recommended'
+module.exports = require('./recommended');

package/configs/eslint/no-react.js

@@ -0,0 +1,18 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * Recommended configuration for PWA Kit projects that don't use React.
+ * Contains rules for JavaScript, TypeScript, and Jest.
+ */
+module.exports = {
+  extends: [require.resolve('./partials/base')],
+  // TypeScript and Jest rules only apply to specific file paths, so they are overrides.
+  overrides: [require('./partials/typescript-permit-any'), require('./partials/jest')]
+};

package/configs/eslint/partials/base.js

@@ -0,0 +1,38 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/** Base configuration used by all PWA Kit packages. */
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2017,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  env: {
+    es6: true,
+    node: true,
+    browser: true
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+  plugins: ['@typescript-eslint', 'prettier'],
+  reportUnusedDisableDirectives: true,
+  rules: {
+    // The goal of the no-empty-function rule is to minimize the contextual knowledge required
+    // by the reader. The suggested fix for empty functions is to add comments indicating that
+    // the empty function is intentional. However, in my opinion, it is clear from context that
+    // most of our empty arrow functions are intentional no-ops, so we don't want the rule to be
+    // enforced for those.
+    '@typescript-eslint/no-empty-function': ['error', {
+      allow: ['arrowFunctions']
+    }]
+  }
+};

package/configs/eslint/partials/jest.js

@@ -0,0 +1,24 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/** Override configuration for Jest files. */
+module.exports = {
+  // Jest (v29) default test match pattern
+  files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
+  plugins: ['jest'],
+  extends: ['plugin:jest/recommended', 'plugin:jest/style'],
+  rules: {
+    'jest/expect-expect': ['warn', {
+      // Anything starting with `expect` counts as an assertion
+      assertFunctionNames: ['expect*', '**.expect*']
+    }],
+    // This doesn't reliably report errors :(
+    'jest/no-standalone-expect': ['off']
+  }
+};

package/configs/eslint/partials/react.js

@@ -0,0 +1,29 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/** Extension of the base configuration for use in React projects. */
+module.exports = {
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  extends: ['plugin:react/recommended', 'plugin:jsx-a11y/recommended'],
+  plugins: ['jsx-a11y', 'react', 'react-hooks', 'use-effect-no-deps'],
+  settings: {
+    react: {
+      version: 'detect'
+    }
+  },
+  rules: {
+    'react-hooks/rules-of-hooks': 'error',
+    // react-hooks/exhaustive-deps has too many false positives; use-effect-no-deps is nicer
+    'use-effect-no-deps/use-effect-no-deps': 'warn'
+  }
+};

package/configs/eslint/partials/typescript-permit-any.js

@@ -0,0 +1,31 @@
+"use strict";
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const base = require('./typescript');
+
+/**
+ * Override configuration for TypeScript files. Adds rules that require type checking, but allows
+ * the use of implicit or explicit `any`.
+ */
+module.exports = _objectSpread(_objectSpread({}, base), {}, {
+  rules: _objectSpread(_objectSpread({}, base.rules), {}, {
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off'
+  })
+});

package/configs/eslint/partials/typescript.js

@@ -0,0 +1,17 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/** Override configuration for TypeScript files. Adds rules that require type checking. */
+module.exports = {
+  files: ['**/*.ts', '**/*.tsx'],
+  extends: ['plugin:@typescript-eslint/recommended-requiring-type-checking'],
+  parserOptions: {
+    project: true
+  }
+};

package/configs/eslint/recommended.js

@@ -0,0 +1,20 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * Recommended configuration for PWA Kit projects.
+ * Contains rules for JavaScript, TypeScript, React, and Jest.
+ */
+module.exports = {
+  extends: [require.resolve('./partials/base'),
+  // React rules live in `extends`, rather than `overrides`, because any file can have React code.
+  require.resolve('./partials/react')],
+  // TypeScript and Jest rules only apply to specific file paths, so they are overrides.
+  overrides: [require('./partials/typescript-permit-any'), require('./partials/jest')]
+};

package/configs/eslint/safe-types.js

@@ -0,0 +1,20 @@
+"use strict";
+
+/*
+ * Copyright (c) 2023, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * Configuration for PWA Kit projects. Extends the recommended configuration with stricter rules
+ * that restrict usage of the `any` type.
+ */
+module.exports = {
+  extends: [require.resolve('./partials/base'),
+  // React rules live in `extends`, rather than `overrides`, because any file can have React code.
+  require.resolve('./partials/react')],
+  // TypeScript and Jest rules only apply to specific file paths, so they are overrides.
+  overrides: [require('./partials/typescript'), require('./partials/jest')]
+};

package/configs/jest/jest-babel-transform.js

@@ -0,0 +1,19 @@
+"use strict";
+
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+// Allows us to use a single babel config at the root to be shared across
+// packages. See: https://babeljs.io/docs/en/config-files#jest
+
+/* eslint-env node */
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const babelJest = require('babel-jest');
+module.exports = babelJest.createTransformer({
+  rootMode: 'upward'
+});

package/configs/jest/jest.config.js

@@ -0,0 +1,40 @@
+"use strict";
+
+var _path = _interopRequireDefault(require("path"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+module.exports = {
+  testURL: 'http://localhost/',
+  verbose: true,
+  collectCoverage: true,
+  // We need access to jsdom globally in tests.
+  // jsdom isn't accessible so we need to use this
+  // 3rd party test environment wrapper. When we
+  // upgrade to jest 28, we can revert back to jsdom.
+  testEnvironment: 'jest-environment-jsdom-global',
+  testPathIgnorePatterns: ['node_modules', 'build'],
+  moduleNameMapper: {
+    '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': _path.default.join(__dirname, 'mocks', 'fileMock.js'),
+    '\\.(svg)$': _path.default.join(__dirname, 'mocks', 'svgMock.js'),
+    '\\.(css|less)$': _path.default.join(__dirname, 'mocks', 'styleMock.js')
+  },
+  globals: {
+    DEBUG: true,
+    NODE_ENV: 'test',
+    Progressive: {
+      // BuildOrigin can be any non-empty string. It does not have to be /mobify/xyz
+      // This is used by tests that call getAssetUrl in pwa-kit-react-sdk to simulate
+      // asset urls.
+      buildOrigin: '/mobify/bundle/development/'
+    }
+  },
+  transform: {
+    '^.+\\.(js|jsx|ts|tsx)$': _path.default.join(__dirname, 'jest-babel-transform.js')
+  }
+};

package/configs/jest/mocks/fileMock.js

@@ -0,0 +1,9 @@
+"use strict";
+
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = 'test-file-stub';

package/configs/jest/mocks/styleMock.js

@@ -0,0 +1,9 @@
+"use strict";
+
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {};

package/configs/jest/mocks/svgMock.js

@@ -0,0 +1,11 @@
+"use strict";
+
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+  viewBox: '0 0 24 24'
+};

package/configs/webpack/config-names.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SSR = exports.SERVER = exports.REQUEST_PROCESSOR = exports.CLIENT_OPTIONAL = exports.CLIENT = void 0;
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+// Must be named "client" and "server". See - https://www.npmjs.com/package/webpack-hot-server-middleware#usage
+const CLIENT = exports.CLIENT = 'client';
+const SERVER = exports.SERVER = 'server';
+const CLIENT_OPTIONAL = exports.CLIENT_OPTIONAL = 'client-optional';
+const SSR = exports.SSR = 'ssr';
+const REQUEST_PROCESSOR = exports.REQUEST_PROCESSOR = 'request-processor';