feat(addons): Respect .gitignore in eslint addon

[ieedan]

Fixes #334

Searched the docs and tried the adapters out ended up also adding .wrangler and .netlify

[changeset-bot]

🦋 Changeset detected

Latest commit: 5a5e41c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
sv	Patch

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

[AdrianGonz97]

thank you! however I'm not sure if having to manually update the ignores property for every new entry is the best solution (also, TIL that eslint v9 no longer takes the .gitignore file into consideration, which is fun).

perhaps it would be nicer to have the .gitignore automatically included using the @eslint/compat package?

It can be implemented as so:

import { fileURLToPath } from "node:url";
import { includeIgnoreFile } from "@eslint/compat";

const gitignorePath = fileURLToPath(new URL("./.gitignore", import.meta.url));
export default {
 // ...
 includeIgnoreFile(gitignorePath)
}

thoughts? @manuel3108 @benmccann

[manuel3108]

Yeah, i think that approach would make sense, although we will have basically the same problem in the .gitignore file then. But personally, I don't think this should be implemented in a "hardcoded" way. I would prefer to see this implemented together with #248

[AdrianGonz97]

I don't think this should be implemented in a "hardcoded" way. I would prefer to see this implemented together with #248

the .gitignore already includes all of the different adapter output dirs anyway (or at least it should, in the case of netlify which needs to be fixed)

[manuel3108]

the .gitignore already includes all of the different adapter output dirs anyway (or at least it should, in the case of netlify which needs to be fixed)

At this point for me it doesn't look like it's including the vercel output. So that's also missing. But I wouldn't be in favor of adding that globally to the templates, as explained above.

[AdrianGonz97]

At this point for me it doesn't look like it's including the vercel output. So that's also missing.

here's the currently generated .gitignore:

node_modules

# Output
.output
.vercel
/.svelte-kit
/build

# OS
.DS_Store
Thumbs.db

# Env
.env
.env.*
!.env.example
!.env.test

# Vite
vite.config.js.timestamp-*
vite.config.ts.timestamp-*

the only one that's missing is .netlify (and maybe wrangler? i normally use @sveltejs/adapter-cloudflare which outputs into .svelte-kit/cloudflare instead, so idk).

But I wouldn't be in favor of adding that globally to the templates, as explained above.

yea but that would only be helpful for people who are changing adapters via add and not manually. why not just get them all in one go instead? we're already most of the way there anyway since we're only missing 1 or 2 entries.

[manuel3108]

here's the currently generated .gitignore:

I'm blind, as always!

yea but that would only be helpful for people who are changing adapters via add and not manually. why not just get them all in one go instead? we're already most of the way there anyway since we're only missing 1 or 2 entries.

Good point about the manual stuff, this should be the way.

[ieedan]

I just went through and ran all of the adapters to see what they output since I don't think any of those outputs are actually in the docs for the adapters at least that I could find.

[AdrianGonz97]

here are the generated dirs in the root:

@sveltejs/adapter-node - /build
@sveltejs/adapter-static - /build
@sveltejs/adapter-cloudflare - /.wrangler 
@sveltejs/adapter-cloudflare-workers /.wrangler
@sveltejs/adapter-netlify - /.netlify
@sveltejs/adapter-vercel - /.vercel

not sure what the .output dir that already exists in the .gitignore is supposed to be for, but we only need to add .wrangler and .netlify to the gitignore.

[ieedan]

Is there a reason there can't just be a exported constant somewhere that has all of these ignores to be used everywhere?

[AdrianGonz97]

Is there a reason there can't just be a exported constant somewhere that has all of these ignores to be used everywhere?

not exactly sure I follow - who should be exporting these? the individual adapter packages?

[ieedan]

Is there a reason there can't just be a exported constant somewhere that has all of these ignores to be used everywhere?

not exactly sure I follow - who should be exporting these? the individual adapter packages?

I don't think it being a separate package would be practical but it may be nice to have an internal package to use for it? Like a @sveltejs/constants or something idk.

Otherwise you'd have to depend on 10 packages just to figure out what to ignore lol

[AdrianGonz97]

eh, that would be pretty niche and not particularly helpful when it comes to the gitignore file since there's no way to 'import' those constants into it

anyway, I think we're in agreement that implementing #335 (comment) would be good, so feel free to add it to this PR!

[ieedan]

I meant more it could just be passed around to build whatever files need it.

Either way let me wrap a few things up and I can give it a shot!

[ieedan]

This should be it but I cannot seem to get it to build or run tests on my machine I am probably just doing something wrong.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/sveltejs/cli/sv@335

npm i https://pkg.pr.new/sveltejs/cli/svelte-migrate@335

commit: 5a5e41c

[manuel3108]

Thanks, so much! This seems to be working great!

The only thing im unsure about, is the placement of the includeIgnoreFile call. According to the readme I would understand that this should be placed first in the eslint array, but currently it's placed last. In my local testing though, this didn't make any difference at all.

[ieedan]

Thanks, so much! This seems to be working great!

The only thing im unsure about, is the placement of the includeIgnoreFile call. According to the readme I would understand that this should be placed first in the eslint array, but currently it's placed last. In my local testing though, this didn't make any difference at all.

Yeah if you would rather have it at the beginning I can move it no problem at all!

[ieedan]

Also should I update the template git ignores with the output files mentioned above?

[AdrianGonz97]

thank you!

[Rich-Harris]

preview: https://svelte-dev-git-preview-cli-335-svelte.vercel.app/

this is an automated message

[ieedan]

thank you!

I guess the whitespace issue at the top isn't solvable right?

// ...
import ts from 'typescript-eslint';
const gitignorePath = fileURLToPath(new URL("./.gitignore", import.meta.url));

//...

[AdrianGonz97]

Not at the moment, but we have plans on addressing issues similar to this in the future