From 0e19350e62742ad49a7665ce3a81a5c5e229faae Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Tue, 30 May 2023 09:16:48 -0700 Subject: [PATCH 1/5] docs: update changelog with required version of vite-plugin-svelte (#8654) --- packages/svelte/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/svelte/CHANGELOG.md b/packages/svelte/CHANGELOG.md index c8aa5b1bd8..44ab723460 100644 --- a/packages/svelte/CHANGELOG.md +++ b/packages/svelte/CHANGELOG.md @@ -5,7 +5,7 @@ * **breaking** Minimum supported Node version is now Node 16 ([#8566](https://github.com/sveltejs/svelte/pull/8566)) * **breaking** Minimum supported webpack version is now webpack 5 ([#8515](https://github.com/sveltejs/svelte/pull/8515)) * **breaking** Bundlers must specify the `browser` condition when building a frontend bundle for the browser ([#8516](https://github.com/sveltejs/svelte/pull/8516)) -* **breaking** Minimum supported vite-plugin-svelte version is now 2.1.1. SvelteKit users can upgrade to 1.15.9 or newer to ensure a compatible version ([#8516](https://github.com/sveltejs/svelte/pull/8516)) +* **breaking** Minimum supported vite-plugin-svelte version is now 2.4.1. SvelteKit users can upgrade to 1.20.0 or newer to ensure a compatible version ([#8516](https://github.com/sveltejs/svelte/pull/8516)) * **breaking** Minimum supported TypeScript version is now TypeScript 5 (it will likely work with lower versions, but we make no guarantees about that) ([#8488](https://github.com/sveltejs/svelte/pull/8488)) * **breaking** Remove `svelte/register` hook, CJS runtime version and CJS compiler output ([#8613](https://github.com/sveltejs/svelte/pull/8613)) * **breaking** Stricter types for `createEventDispatcher` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) From b41c4407c2fdc7566253a47c5faa9f5fa01ed630 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Tue, 30 May 2023 12:06:28 -0700 Subject: [PATCH 2/5] docs: update changelog to follow changesets format (#8642) --- packages/svelte/CHANGELOG.md | 56 ++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 24 deletions(-) diff --git a/packages/svelte/CHANGELOG.md b/packages/svelte/CHANGELOG.md index 44ab723460..4aea672109 100644 --- a/packages/svelte/CHANGELOG.md +++ b/packages/svelte/CHANGELOG.md @@ -1,38 +1,46 @@ -# Svelte changelog - -## Unreleased (4.0) - -* **breaking** Minimum supported Node version is now Node 16 ([#8566](https://github.com/sveltejs/svelte/pull/8566)) -* **breaking** Minimum supported webpack version is now webpack 5 ([#8515](https://github.com/sveltejs/svelte/pull/8515)) -* **breaking** Bundlers must specify the `browser` condition when building a frontend bundle for the browser ([#8516](https://github.com/sveltejs/svelte/pull/8516)) -* **breaking** Minimum supported vite-plugin-svelte version is now 2.4.1. SvelteKit users can upgrade to 1.20.0 or newer to ensure a compatible version ([#8516](https://github.com/sveltejs/svelte/pull/8516)) -* **breaking** Minimum supported TypeScript version is now TypeScript 5 (it will likely work with lower versions, but we make no guarantees about that) ([#8488](https://github.com/sveltejs/svelte/pull/8488)) -* **breaking** Remove `svelte/register` hook, CJS runtime version and CJS compiler output ([#8613](https://github.com/sveltejs/svelte/pull/8613)) -* **breaking** Stricter types for `createEventDispatcher` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) -* **breaking** Stricter types for `Action` and `ActionReturn` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) -* **breaking** Stricter types for `onMount` - now throws a type error when returning a function asynchronously to catch potential mistakes around callback functions (see PR for migration instructions) ([#8136](https://github.com/sveltejs/svelte/pull/8136)) -* **breaking** Overhaul and drastically improve creating custom elements with Svelte (see PR for list of changes and migration instructions) ([#8457](https://github.com/sveltejs/svelte/pull/8457)) -* **breaking** Deprecate `SvelteComponentTyped`, use `SvelteComponent` instead ([#8512](https://github.com/sveltejs/svelte/pull/8512)) -* **breaking** Make transitions local by default to prevent confusion around page navigations ([#6686](https://github.com/sveltejs/svelte/issues/6686)) -* **breaking** Error on falsy values instead of stores passed to `derived` ([#7947](https://github.com/sveltejs/svelte/pull/7947)) -* **breaking** Custom store implementers now need to pass an `update` function additionally to the `set` function ([#6750](https://github.com/sveltejs/svelte/pull/6750)) -* **breaking** Do not expose default slot bindings to named slots and vice versa ([#6049](https://github.com/sveltejs/svelte/pull/6049)) -* **breaking** Change order in which preprocessors are applied ([#8618](https://github.com/sveltejs/svelte/pull/8618)) -* **breaking** The runtime now makes use of `classList.toggle(name, boolean)` which does not work in very old browsers ([#8629](https://github.com/sveltejs/svelte/pull/8629)) -* **breaking** apply `inert` to outroing elements ([#8627](https://github.com/sveltejs/svelte/pull/8627)) +# svelte + +## 4.0.0-next.0 + +### Major Changes + +* breaking: Minimum supported Node version is now Node 16 ([#8566](https://github.com/sveltejs/svelte/pull/8566)) +* breaking: Minimum supported webpack version is now webpack 5 ([#8515](https://github.com/sveltejs/svelte/pull/8515)) +* breaking: Bundlers must specify the `browser` condition when building a frontend bundle for the browser ([#8516](https://github.com/sveltejs/svelte/pull/8516)) +* breaking: Minimum supported vite-plugin-svelte version is now 2.4.1. SvelteKit users can upgrade to 1.20.0 or newer to ensure a compatible version ([#8516](https://github.com/sveltejs/svelte/pull/8516)) +* breaking: Minimum supported TypeScript version is now TypeScript 5 (it will likely work with lower versions, but we make no guarantees about that) ([#8488](https://github.com/sveltejs/svelte/pull/8488)) +* breaking: Remove `svelte/register` hook, CJS runtime version and CJS compiler output ([#8613](https://github.com/sveltejs/svelte/pull/8613)) +* breaking: Stricter types for `createEventDispatcher` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) +* breaking: Stricter types for `Action` and `ActionReturn` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) +* breaking: Stricter types for `onMount` - now throws a type error when returning a function asynchronously to catch potential mistakes around callback functions (see PR for migration instructions) ([#8136](https://github.com/sveltejs/svelte/pull/8136)) +* breaking: Overhaul and drastically improve creating custom elements with Svelte (see PR for list of changes and migration instructions) ([#8457](https://github.com/sveltejs/svelte/pull/8457)) +* breaking: Deprecate `SvelteComponentTyped`, use `SvelteComponent` instead ([#8512](https://github.com/sveltejs/svelte/pull/8512)) +* breaking: Make transitions local by default to prevent confusion around page navigations ([#6686](https://github.com/sveltejs/svelte/issues/6686)) +* breaking: Error on falsy values instead of stores passed to `derived` ([#7947](https://github.com/sveltejs/svelte/pull/7947)) +* breaking: Custom store implementers now need to pass an `update` function additionally to the `set` function ([#6750](https://github.com/sveltejs/svelte/pull/6750)) +* breaking: Do not expose default slot bindings to named slots and vice versa ([#6049](https://github.com/sveltejs/svelte/pull/6049)) +* breaking: Change order in which preprocessors are applied ([#8618](https://github.com/sveltejs/svelte/pull/8618)) +* breaking: The runtime now makes use of `classList.toggle(name, boolean)` which does not work in very old browsers ([#8629](https://github.com/sveltejs/svelte/pull/8629)) +* breaking: apply `inert` to outroing elements ([#8627](https://github.com/sveltejs/svelte/pull/8627)) + +### Minor Changes + * Add a way to modify attributes for script/style preprocessors ([#8618](https://github.com/sveltejs/svelte/pull/8618)) * Improve hydration speed by adding `data-svelte-h` attribute to detect unchanged HTML elements ([#7426](https://github.com/sveltejs/svelte/pull/7426)) * Add `a11y no-noninteractive-element-interactions` rule ([#8391](https://github.com/sveltejs/svelte/pull/8391)) * Add `a11y-no-static-element-interactions`rule ([#8251](https://github.com/sveltejs/svelte/pull/8251)) +* Allow `#each` to iterate over iterables like `Set`, `Map` etc ([#7425](https://github.com/sveltejs/svelte/issues/7425)) * Improve duplicate key error for keyed `each` blocks ([#8411](https://github.com/sveltejs/svelte/pull/8411)) +* Warn about `:` in attributes and props to prevent ambiguity with Svelte directives ([#6823](https://github.com/sveltejs/svelte/issues/6823)) + +### Patch Changes + * Bind `null` option and input values consistently ([#8312](https://github.com/sveltejs/svelte/issues/8312)) * Allow `$store` to be used with changing values including nullish values ([#7555](https://github.com/sveltejs/svelte/issues/7555)) * Initialize stylesheet with `/* empty */` to enable setting CSP directive that also works in Safari ([#7800](https://github.com/sveltejs/svelte/pull/7800)) * Treat slots as if they don't exist when using CSS adjacent and general sibling combinators ([#8284](https://github.com/sveltejs/svelte/issues/8284)) * Fix transitions so that they don't require a `style-src 'unsafe-inline'` Content Security Policy (CSP) ([#6662](https://github.com/sveltejs/svelte/issues/6662)). * Explicitly disallow `var` declarations extending the reactive statement scope ([#6800](https://github.com/sveltejs/svelte/pull/6800)) -* Allow `#each` to iterate over iterables like `Set`, `Map` etc ([#7425](https://github.com/sveltejs/svelte/issues/7425)) -* Warn about `:` in attributes and props to prevent ambiguity with Svelte directives ([#6823](https://github.com/sveltejs/svelte/issues/6823)) * Improve error message when trying to use `animate:` directives on inline components ([#8641](https://github.com/sveltejs/svelte/issues/8641)) ## 3.59.1 From b0619377b1300965403c038030b323e88f3fbfd2 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Tue, 30 May 2023 12:07:54 -0700 Subject: [PATCH 3/5] docs: update changelog with minimum `rollup-plugin-svelte` and `svelte-loader` versions (#8666) --- packages/svelte/CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/svelte/CHANGELOG.md b/packages/svelte/CHANGELOG.md index 4aea672109..8ca73bb115 100644 --- a/packages/svelte/CHANGELOG.md +++ b/packages/svelte/CHANGELOG.md @@ -8,13 +8,15 @@ * breaking: Minimum supported webpack version is now webpack 5 ([#8515](https://github.com/sveltejs/svelte/pull/8515)) * breaking: Bundlers must specify the `browser` condition when building a frontend bundle for the browser ([#8516](https://github.com/sveltejs/svelte/pull/8516)) * breaking: Minimum supported vite-plugin-svelte version is now 2.4.1. SvelteKit users can upgrade to 1.20.0 or newer to ensure a compatible version ([#8516](https://github.com/sveltejs/svelte/pull/8516)) +* breaking: Minimum supported `rollup-plugin-svelte` version is now 7.1.5 ([198dbcf](https://github.com/sveltejs/svelte/commit/198dbcf)) +* breaking: Minimum supported `svelte-loader` is now 3.1.8 ([198dbcf](https://github.com/sveltejs/svelte/commit/198dbcf)) * breaking: Minimum supported TypeScript version is now TypeScript 5 (it will likely work with lower versions, but we make no guarantees about that) ([#8488](https://github.com/sveltejs/svelte/pull/8488)) * breaking: Remove `svelte/register` hook, CJS runtime version and CJS compiler output ([#8613](https://github.com/sveltejs/svelte/pull/8613)) * breaking: Stricter types for `createEventDispatcher` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) * breaking: Stricter types for `Action` and `ActionReturn` (see PR for migration instructions) ([#7224](https://github.com/sveltejs/svelte/pull/7224)) * breaking: Stricter types for `onMount` - now throws a type error when returning a function asynchronously to catch potential mistakes around callback functions (see PR for migration instructions) ([#8136](https://github.com/sveltejs/svelte/pull/8136)) * breaking: Overhaul and drastically improve creating custom elements with Svelte (see PR for list of changes and migration instructions) ([#8457](https://github.com/sveltejs/svelte/pull/8457)) -* breaking: Deprecate `SvelteComponentTyped`, use `SvelteComponent` instead ([#8512](https://github.com/sveltejs/svelte/pull/8512)) +* breaking: Deprecate `SvelteComponentTyped` in favor of `SvelteComponent` ([#8512](https://github.com/sveltejs/svelte/pull/8512)) * breaking: Make transitions local by default to prevent confusion around page navigations ([#6686](https://github.com/sveltejs/svelte/issues/6686)) * breaking: Error on falsy values instead of stores passed to `derived` ([#7947](https://github.com/sveltejs/svelte/pull/7947)) * breaking: Custom store implementers now need to pass an `update` function additionally to the `set` function ([#6750](https://github.com/sveltejs/svelte/pull/6750)) From fe06a39229ce3e298f80b6e2a4b3fa48fcafbaf3 Mon Sep 17 00:00:00 2001 From: gtmnayan <50981692+gtm-nayan@users.noreply.github.com> Date: Wed, 31 May 2023 01:02:38 +0545 Subject: [PATCH 4/5] fix: store types and some other internal types that got lost in the conversion (#8658) --- .../compiler/compile/render_dom/invalidate.js | 2 +- .../svelte/src/compiler/preprocess/index.js | 2 +- .../svelte/src/runtime/internal/Component.js | 4 ++++ packages/svelte/src/runtime/internal/dev.js | 20 +++++++++---------- packages/svelte/src/runtime/internal/dom.js | 4 +++- .../src/runtime/internal/transitions.js | 3 ++- packages/svelte/src/runtime/motion/tweened.js | 2 +- packages/svelte/src/runtime/store/index.js | 14 +++++++------ packages/svelte/src/runtime/store/public.d.ts | 2 +- 9 files changed, 31 insertions(+), 22 deletions(-) diff --git a/packages/svelte/src/compiler/compile/render_dom/invalidate.js b/packages/svelte/src/compiler/compile/render_dom/invalidate.js index 69934a11e0..83423e952b 100644 --- a/packages/svelte/src/compiler/compile/render_dom/invalidate.js +++ b/packages/svelte/src/compiler/compile/render_dom/invalidate.js @@ -91,7 +91,7 @@ export function invalidate(renderer, scope, node, names, main_execution_context * @param {import('./Renderer.js').default} renderer * @param {string} name * @param {any} [value] - * @param {boolean} main_execution_context + * @param {boolean} [main_execution_context] * @returns {import('estree').Node} */ export function renderer_invalidate(renderer, name, value, main_execution_context = false) { diff --git a/packages/svelte/src/compiler/preprocess/index.js b/packages/svelte/src/compiler/preprocess/index.js index 6d03caae3b..2523686b5c 100644 --- a/packages/svelte/src/compiler/preprocess/index.js +++ b/packages/svelte/src/compiler/preprocess/index.js @@ -329,7 +329,7 @@ async function process_markup(process, source) { /** * @param {string} source * @param {import('./public.js').PreprocessorGroup | import('./public.js').PreprocessorGroup[]} preprocessor - * @param {{ filename?: string }} options + * @param {{ filename?: string }} [options] * @returns {Promise} */ export default async function preprocess(source, preprocessor, options) { diff --git a/packages/svelte/src/runtime/internal/Component.js b/packages/svelte/src/runtime/internal/Component.js index b7c4bed714..4512b3ab35 100644 --- a/packages/svelte/src/runtime/internal/Component.js +++ b/packages/svelte/src/runtime/internal/Component.js @@ -221,6 +221,10 @@ if (typeof HTMLElement === 'function') { node.setAttribute('name', name); } }, + /** + * @param {HTMLElement} target + * @param {HTMLElement} [anchor] + */ m: function mount(target, anchor) { insert(target, node, anchor); }, diff --git a/packages/svelte/src/runtime/internal/dev.js b/packages/svelte/src/runtime/internal/dev.js index 494c276260..8069141015 100644 --- a/packages/svelte/src/runtime/internal/dev.js +++ b/packages/svelte/src/runtime/internal/dev.js @@ -17,7 +17,7 @@ import { ensure_array_like } from './each.js'; /** * @template T * @param {string} type - * @param {T} detail + * @param {T} [detail] * @returns {void} */ export function dispatch_dev(type, detail) { @@ -47,7 +47,7 @@ export function append_hydration_dev(target, node) { /** * @param {Node} target * @param {Node} node - * @param {Node} anchor + * @param {Node} [anchor] * @returns {void} */ export function insert_dev(target, node, anchor) { @@ -57,7 +57,7 @@ export function insert_dev(target, node, anchor) { /** @param {Node} target * @param {Node} node - * @param {Node} anchor + * @param {Node} [anchor] * @returns {void} */ export function insert_hydration_dev(target, node, anchor) { @@ -109,10 +109,10 @@ export function detach_after_dev(before) { * @param {Node} node * @param {string} event * @param {EventListenerOrEventListenerObject} handler - * @param {boolean | AddEventListenerOptions | EventListenerOptions} options - * @param {boolean} has_prevent_default - * @param {boolean} has_stop_propagation - * @param {boolean} has_stop_immediate_propagation + * @param {boolean | AddEventListenerOptions | EventListenerOptions} [options] + * @param {boolean} [has_prevent_default] + * @param {boolean} [has_stop_propagation] + * @param {boolean} [has_stop_immediate_propagation] * @returns {() => void} */ export function listen_dev( @@ -140,7 +140,7 @@ export function listen_dev( /** * @param {Element} node * @param {string} attribute - * @param {string} value + * @param {string} [value] * @returns {void} */ export function attr_dev(node, attribute, value) { @@ -152,7 +152,7 @@ export function attr_dev(node, attribute, value) { /** * @param {Element} node * @param {string} property - * @param {any} value + * @param {any} [value] * @returns {void} */ export function prop_dev(node, property, value) { @@ -163,7 +163,7 @@ export function prop_dev(node, property, value) { /** * @param {HTMLElement} node * @param {string} property - * @param {any} value + * @param {any} [value] * @returns {void} */ export function dataset_dev(node, property, value) { diff --git a/packages/svelte/src/runtime/internal/dom.js b/packages/svelte/src/runtime/internal/dom.js index aced965a67..f456e9abd7 100644 --- a/packages/svelte/src/runtime/internal/dom.js +++ b/packages/svelte/src/runtime/internal/dom.js @@ -1001,11 +1001,13 @@ export function toggle_class(element, name, toggle) { * @template T * @param {string} type * @param {T} [detail] + * @param {{ bubbles?: boolean, cancelable?: boolean }} [options] * @returns {CustomEvent} */ export function custom_event(type, detail, { bubbles = false, cancelable = false } = {}) { /** - * @type {CustomEvent} */ + * @type {CustomEvent} + */ const e = document.createEvent('CustomEvent'); e.initCustomEvent(type, bubbles, cancelable, detail); return e; diff --git a/packages/svelte/src/runtime/internal/transitions.js b/packages/svelte/src/runtime/internal/transitions.js index 925316d75e..4575e184ac 100644 --- a/packages/svelte/src/runtime/internal/transitions.js +++ b/packages/svelte/src/runtime/internal/transitions.js @@ -74,7 +74,8 @@ export function transition_in(block, local) { /** * @param {import('./private.js').Fragment} block * @param {0 | 1} local - * @param {0 | 1} detach + * @param {0 | 1} [detach] + * @param {() => void} [callback] * @returns {void} */ export function transition_out(block, local, detach, callback) { diff --git a/packages/svelte/src/runtime/motion/tweened.js b/packages/svelte/src/runtime/motion/tweened.js index 1e0eb8b282..8e2d8f3d26 100644 --- a/packages/svelte/src/runtime/motion/tweened.js +++ b/packages/svelte/src/runtime/motion/tweened.js @@ -57,7 +57,7 @@ export function tweened(value, defaults = {}) { let target_value = value; /** * @param {T} new_value - * @param {import('./private.js').TweenedOptions} opts + * @param {import('./private.js').TweenedOptions} [opts] */ function set(new_value, opts) { if (value == null) { diff --git a/packages/svelte/src/runtime/store/index.js b/packages/svelte/src/runtime/store/index.js index 1c35cca40a..c0c20a885b 100644 --- a/packages/svelte/src/runtime/store/index.js +++ b/packages/svelte/src/runtime/store/index.js @@ -12,8 +12,8 @@ const subscriber_queue = []; /** * Creates a `Readable` store that allows reading by subscription. * @template T - * @param {T} value initial value - * @param {import('./public.js').StartStopNotifier} start + * @param {T} [value] initial value + * @param {import('./public.js').StartStopNotifier} [start] * @returns {import('./public.js').Readable} */ export function readable(value, start) { @@ -25,8 +25,8 @@ export function readable(value, start) { /** * Create a `Writable` store that allows both updating and reading by subscription. * @template T - * @param {T} value initial value - * @param {import('./public.js').StartStopNotifier} start + * @param {T} [value] initial value + * @param {import('./public.js').StartStopNotifier} [start] * @returns {import('./public.js').Writable} */ export function writable(value, start = noop) { @@ -56,6 +56,7 @@ export function writable(value, start = noop) { } } } + /** * @param {import('./public.js').Updater} fn * @returns {void} @@ -63,9 +64,10 @@ export function writable(value, start = noop) { function update(fn) { set(fn(value)); } + /** * @param {import('./public.js').Subscriber} run - * @param {import('./private.js').Invalidator} invalidate + * @param {import('./private.js').Invalidator} [invalidate] * @returns {import('./public.js').Unsubscriber} */ function subscribe(run, invalidate = noop) { @@ -95,7 +97,7 @@ export function writable(value, start = noop) { * @template T * @overload * @param {S} stores - input stores - * @param {(values: import('./public.js').StoresValues, set: import('./public.js').Subscriber, update: (fn: import('./public.js').Updater) => void) => import('./public.js').Unsubscriber | void} fn - function callback that aggregates the values + * @param {(values: import('./public.js').StoresValues, set: (value: T) => void, update: (fn: import('./public.js').Updater) => void) => import('./public.js').Unsubscriber | void} fn - function callback that aggregates the values * @param {T} [initial_value] - initial value * @returns {import('./public.js').Readable} */ diff --git a/packages/svelte/src/runtime/store/public.d.ts b/packages/svelte/src/runtime/store/public.d.ts index 567730d406..b7368137ac 100644 --- a/packages/svelte/src/runtime/store/public.d.ts +++ b/packages/svelte/src/runtime/store/public.d.ts @@ -14,7 +14,7 @@ export type Updater = (value: T) => T; * This function is called when the first subscriber subscribes. * * @param {(value: T) => void} set Function that sets the value of the store. - * @param {(value: Updater) => void} set Function that sets the value of the store after passing the current value to the update function. + * @param {(value: Updater) => void} update Function that sets the value of the store after passing the current value to the update function. * @returns {void | (() => void)} Optionally, a cleanup function that is called when the last remaining * subscriber unsubscribes. */ From 0ce41875f01de8248e8040519c11c28f68e67d3e Mon Sep 17 00:00:00 2001 From: Nguyen Tran <88808276+ngtr6788@users.noreply.github.com> Date: Tue, 30 May 2023 15:19:51 -0400 Subject: [PATCH 5/5] docs: use pnpm and new commands to check the code base (#8667) Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 28234b69df..34f35c5a70 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ # HEADS UP: BIG RESTRUCTURING UNDERWAY -The Svelte repo is currently in the process of heavy restructuring for Svelte 4. After that, work on Svelte 5 will likely change a lot on the compiler aswell. For that reason, please don't open PRs that are large in scope, touch more than a couple of files etc. In other words, bug fixes are fine, but feature PRs will likely not be merged. +The Svelte repo is currently in the process of heavy restructuring for Svelte 4. After that, work on Svelte 5 will likely change a lot in the compiler as well. For that reason, please don't open PRs that are large in scope, touch more than a couple of files, etc. In other words, bug fixes are fine, but feature PRs will likely not be merged. ### Before submitting the PR, please make sure you do the following - [ ] It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs @@ -8,5 +8,5 @@ The Svelte repo is currently in the process of heavy restructuring for Svelte 4. - [ ] This message body should clearly illustrate what problems it solves. - [ ] Ideally, include a test that fails without this PR but passes with it. -### Tests -- [ ] Run the tests with `npm test` and lint the project with `npm run lint` +### Tests and linting +- [ ] Run the tests with `pnpm test` and lint the project with `pnpm lint`