Adapter API to parse ignore files to warn of suggested ignores
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 20.8k
- Forks
- 2.3k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 156
Description
Describe the problem
Different adapters require different ignore settings.
The current proposed soln that is in use today is for all adapter output to be under .svelte-kit/<somedir> though this may change in future per adapter.
The proposed solution would provide adapter authors with an alternative.
Describe the proposed solution
Use gitignore-parser to let Adapters to loudly warn users. From this exchange:
Should we expect to see
gitignore-parserprovided via the Adapter API in the near future?
Yes, I think we should — we could have an API like
utils.warn_if_unignored([opts.output])
Alternatives considered
Writing this in my documentation
Importance
would make my life easier
Additional Information
raising the issues:
- #1832
- #1581
initial proposition:
- #1924
revert of initial proposition
- #2055
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Adapter API and review the related proposals in #1924 and #2055, along with the referenced issues #1832 and #1581. Determine how gitignore-parser could be exposed so adapters can warn when their output is not ignored; done means the API behavior and warning conditions are defined and covered by appropriate tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100