-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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] Ignore adapter build files #1924
Conversation
🦋 Changeset detectedLatest commit: 445b992 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, but I think it could be simplified
The ideal in my mind would be to, on first run, present a prompt to the user that says something like "Going to add update your files. Continue? Yes / Later / Never" and then if "Yes" or "Never" then write to some file somewhere to let the adapter know it doesn't need to do the update anymore. Biggest question in my mind is if we did that, where would it write to? We could create new Svelte projects with a file named |
Maybe, but idk if its necessary since the function checks if there are patterns missing, and if they are they are added. It also takes in account commented lines to let the users comment out some patterns |
It can also be a problem if someone happens to change their adapter |
packages/kit/src/core/adapt/utils.js
Outdated
|
||
/** @param {{patterns: string[], log?: boolean}} options */ | ||
update_ignores({ patterns, log = true }) { | ||
const targets = ['.gitignore', '.prettierignore', '.eslintignore']; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than update all three files, can we update just .gitignore
and use it as input to prettier and eslint in the new project template? That's what this repo does if you want an example:
Line 57 in b18a45c
"lint": "eslint --ignore-path .gitignore --ignore-pattern \"src/core/make_package/test/**\" \"src/**/*.{ts,mjs,js,svelte}\" && npm run check-format", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure
|
||
/** @param {{patterns: string[], log?: boolean}} options */ | ||
update_ignores({ patterns, log = true }) { | ||
const target = '.gitignore'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should also update the templates to use .gitignore
. It looks like eslint
might already, but not prettier
. https://github.com/sveltejs/kit/tree/master/packages/create-svelte/shared
The current implementation makes the test apps have their |
I'd say go ahead and update the test files. This is looking pretty good to me. Thanks for going through a few iterations on it! |
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Since |
I think the name's fine |
…ePath * 'master' of https://github.com/sveltejs/kit: (85 commits) [chore] minor simplification of `parse_body` (sveltejs#2043) Version Packages (next) (sveltejs#2026) [chore] deduplicate config types (sveltejs#2030) [chore] remove invalid css declaration (sveltejs#2038) [fix] correctly pass Vite options in preview mode (sveltejs#2036) [feat] Ignore adapter build files (sveltejs#1924) [chore] Upgrade Rollup Don't check external links on prerender (sveltejs#1679) Version Packages (next) (sveltejs#2017) [chore] convert remaining type aliases (sveltejs#2018) [feat] explicitly set compilerOptions.hydratable to config.kit.hydrate (sveltejs#2024) [feat] More powerful and configurable rendering options (sveltejs#2008) [chore] typecheck example (sveltejs#2019) Change config `prerender.force` to `prerender.onError` (sveltejs#2007) [chore] prefer interfaces to types (sveltejs#2010) [docs] minor wording improvement in migration guide (sveltejs#2006) [chore] test debugging improvements [docs] fix typo (sveltejs#2003) [chore] use @ts-expect-error instead of @ts-ignore (sveltejs#1999) Version Packages (next) (sveltejs#1996) ...
Before submitting the PR, please make sure you do the following
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpx changeset
and following the prompts. All changesets should bepatch
until SvelteKit 1.0Closes #1832 by adding a function to the
utils
parameter that lets adapters update a list of targeted files that use the same syntax as.gitignore
Closes #1581 as well