it begins #5782
Merged
it begins #5782
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
arxpoetica
reviewed
Aug 1, 2022
| const segments = filepath.split('/'); | ||
| const file = /** @type {string} */ (segments.pop()); | ||
|
|
||
| if (file[0] !== '+') return; // not a route file |
There was a problem hiding this comment.
Not sure if this was discussed in that locked thread, but any way we could make those pluses optional for the people that really hate them? I'm not putting random junk in my route folders, so this would be a heck of a lot nicer:
/routes /routes/foo /routes/foo/page.svelte /routes/foo/layout.svelte
Feels like that would defeat the purpose a bit :p
There was a problem hiding this comment.
I am struggling to see why any prefix is needed though. Wouldn't analyzeing every file in the directory and skipping irrelevant ones be pretty much the same as skipping all non-plus-prefixed ones?
There was a problem hiding this comment.
This has been discussed ad nauseam on #5748. See in particular the 'Prefixes' section of #5748 (comment)
There was a problem hiding this comment.
For the folks following along like myself...
The best rationale I've heard from anyone about the need for prefixes is that the maintainers want a future proof way to identify files of special significance. Without a prefix, they risk breaking ppl's codebases in the future if they introduce a new special/reserved file name.
There was a problem hiding this comment.
That's one reason, yes — being able to add new features without forcing an otherwise unwarranted semver major is an important design consideration (the "integers are free!!!!" crowd disagrees with that statement, because they don't understand human psychology).
But there are also very good DX reasons:
-
you see a
+file, you immediately know that it's a route file (and if you're unfamiliar with that concept, searching for+pageetc in the docs will immediately clue you in, without you needing to know any jargon) -
your files are lexically sorted in a very predictable way — child routes, route files, then colocated files. For example if you have a bunch of colocated files,
index.sveltegets buried...src/routes ├ Foo.svelte ├ constants.js ├ index.svelte └ utils.js...whereas
+page.sveltesits apart:src/routes ├ +page.svelte ├ Foo.svelte ├ constants.js └ utils.js -
you can find all your route files in your editor very quickly — if you're using VSCode,
Cmd-Pthen just type+, or start typing the parts of a route followed by+. If you start typingpaorinthen you'll get a bunch of false positives, forcing you to type a lot more in order to filter the list. On a large codebase, details like that start to matter.
|
Going to merge this into #5778, as the separate branches have served their purpose |
Rich-Harris
added a commit
that referenced
this pull request
Aug 15, 2022
* skeleton
* add moved info to files to be able to rewrite imports later
* add magic-string, start load extraction and manipulation logic
* move migration logic into new svelte-migrate package
* remove commented code
* lockfile
* move components, extract load
* +page.server.js and +server.js
* remove unused code
* uncomment prompt
* add some errors
* fix detection
* consistent casing
* not sure if typescript will ever fail to parse, but in any case its handled now
* handle error with module context
* add some comments
* update demo app
* update skeleton app
* migrate kit.svelte.dev
* fix dynamic import on windows, fix js/ts file ending, handle index.json.js endpoint case
* extract imports into Svelte migration task for QOL, don't adjust imports in standalone index edge case
* migrate amp app
* show message either way, could be other things gone wrong
* windooows
* more sophisticated auto migrations
- unpack props/body
- redirect/error in load
- standalone endpoint
* migrate test/apps/basics
* fix regex, dont show props message on error page, more sophisticated error/redirect checks, set-cookie suggestion
* pretend to make this more readable
* adjust import location for error and redirect
* update tests
* only show short automigration message on success, only migrate where we are confident it works, annotate non-migrated return statements, handle export { X } case
* shorten redirect/error if no second argument given
* use git mv if available
* update options tests
* update options-2 tests
* update writes tests
* migrate (most) prerendering/basics tests
* migrate more tests
* update adapter-static tests
* it begins (#5782)
* it begins
* update some more test fixtures
* update more tests
* more
* more
* more
* more
* last one
* need to add dot: true to catch routes inside .well-known
* fixes, update tests
* fix more tests
* fix various things
* all create_manifest_data unit tests passing
* update write_manifest
* fix
* remove config.kit.routes
* update RequestHandler type
* simplify endpoint code
* simplify some more stuff
* move respond code into render_page, where it belongs
* purge all references to stuff
* simplify
* vite build completes, albeit with a broken build
* vite dev now starts
* now rendering a blank page
* rendering an error page
* it renders html!
* tidy up
* get error page rendering correctly
* add placeholder setHeaders function
* replace CSRComponent with CSRPageNode
* fix build
* amp tests passing! now for the client
* fix create_manifest_data unit tests
* add error/redirect helpers
* rename @sveltejs/kit/data -> @sveltejs/kit
* add error/redirect to @sveltejs/kit types
* fixes
* fix a slew of typescript errors
* data loading belongs in load_node
* holy shit the tests are starting to pass
* update some tests
* start working on write_types
* science experiment
* typo
* i think it basically works
* expose ServerData as Data when no load is specified
* replace magic number
* handle missing GET separately from failure
* oops i think i did a bad git
* remove typings tests, these are no longer useful
* tidy
* use server data if no load is provided
* temporarily disable non-SSR tests
* apply headers
* update test
* allow load to return void
* remove some tests that no longer make sense
* remove some more unused tests
* this is fun. delete delete delete
* fix test
* handle accept:json requests
* fix test
* small tidy up
* tidy
* simplify
* simplify, improve efficiency
* simplify
* rename to disambiguate with client
* tweaks
* tidy up
* load data in parallel
* throw error pointing to migration if router folder exists but no routes are found
* load nodes on client in parallel
* handle redirect
* fix parent usage bug, avoid waterfall when awaiting parents, remove try-catch which would make subsequent catch never getting called
* error handling
* construct redirect URL properly
* fix redirects
* handle POST requests etc
* oof this took an embarrassingly long time to find
* add types
* update/remove some tests as appropriate
* implement $page.data on the server
* fix test
* handle invalid redirect statuses
* update test, fix off-by-one error
* fix a bunch more tests
* tweak tests
* include dynamically imported styles from +page.js in dev
* same but for build
* track cookies
* apply tracked cookies
* down to three failing SSR tests
* render errors
* all SSR tests in test/apps/basics passing
* fix write tests
* all SSR tests passing
* remove a couple of unused deps
* tidy up
* dont use instanceof checks
* fix off-by-one error in client
* client-side fetching, start of redirect/error handling
* re-add missing dist file
* for now, duplicate route.path logic where needed. in future, rethink manifest for this purpose
* fix parent data retrieval, add $page.data to client
* fix most prerendering tests
* add cache http-equiv
* test
* get prerender tests passing
Co-authored-by: Simon Holthausen <[email protected]>
* Docs for the new API (#5810)
* Update routing
- add overview of special files at the beginning (TODO: make this its own page?)
- update special file names
- shuffle endpoints and standalone endpoints to make it more clear what separates them (TODO: move each into its own page?)
* update layouts/error
* remove obsolete option
* updates to file names in various places
* update loading docs
* update sapper migration
* missed some
* clarify depends API
* Update documentation/docs/03-routing.md
Co-authored-by: Rich Harris <[email protected]>
* enable all tests
* Unbundling (#5853)
* tweak bundling strategy
* unbundle
* remove some unused deps
* simplify
* simplify further
* fix export map
* fix adapter-static tests
* format
* replace some TODOs
* only add param tag if param exists
* fix some type stuff
* fix some type stuff
* more type fixes
* reuse load_data
* fix imports. damn you vscode, you dont have to be like this
* fix some stuff
* remove unused import
* fix prefetchRoutes
* fix a handful more tests
* comment out likely obsolete setHeaders in test
* fix write_client_manifest
* fix off-by-one error for client error page rendering
* update page store when only data changed
* handle page endpoint without get
* reenable tests
* fix windows/vite path issue
* pass serialized server data to client
* fix uses tracking for page endpoints in client
* unfix the buggy drive letter fix
* set headers/etag for page endpoints
* add HttpError identifier to serialized version and make connection visible through types
* call handle_error in json request
* fix test
* omit json-data when ssr but no hydration
* remove obsolete caching logic from client, adjust test
* add migration link
* make typescript non-required again by lazy-loading it, fix package.files
* only create proxy if something was modified
* update pnpm lock
* always bundle @sveltejs/kit
* fix some write_types stuff
* this took waaaay too long to figure out
* prettier
* fix a bunch of typescript stuff
* shrug
* probably no point generating types if no ts?
* refactor write_types to support addition of layout types
* rename Data to PageData and LayoutData
* fix manifest generation with named layouts
* update tests
* generate LayoutLoad and LayoutData types
* windows fix, deduplicate, use AwaitedProperties
* write Errors type
* fix AwaitedProperties type, add AwaitedErrors type
* fix test
* fix test
* trying an env fix, not sure if that works on linux
* mhm
* temporary run only env test on CI
* fix type reference in create-svelte
* getting desperate
* even more scoped test execution
* check why posixify doesnt work
* Data -> PageData
* wtf, does this work now or not?
* remove unnecessary migration warnings, add error for props -> data
* omg works, reenable all tests
* some docs progress
* fix file ending issue in write_types
* fix path resolution in write_types
* fix type error in generated d.ts file
* updates
* ooh it works
* sprinkle some types
* add checkJs
* get some pages building
* .ts -> .js
* simplify write_types
* more docs types stuff
* rename node.module to node.shared, which is more descriptive
* rename route.page to route.leaf
* return all route data with __data.json, not just the leaf
* load all server data in one go on the client. this should probably have a bunch of tests
* update types on file edit
* only write types that have changed
* debounce updates to manifest
* add parent data type inference. introduce a breaking change to the Load typing (another generic which is placed before an existing one)
* rename/tidy up some stuff
* fix
* fix some stuff
* set cookies on __data.json requests
* fix some stuff
* only load data from server if we have some
* remove obsolete todo
* update test
* lint
* fix prerendered __data.json
* add json helper
* use json helper in migration
* fixes
* center routing documentation on + files
* get docs building again
* update example
* tidy up
* update load docs
* document promise unwrapping
* typo
* remove obsolete logic which is now handled elsewhere
* implement invalidate()
* invalidate() should also loads without dependencies
* Update documentation/docs/05-load.md
Co-authored-by: Simon H <[email protected]>
* Update documentation/docs/03-routing.md
* inject $types.d.ts files into code snippets where possible
* add a note about shared state. not 100% sure this is the best place for it but will do for now
* Update documentation/docs/05-load.md
* document set-cookie exception
* tweaks
* tweaks
* more tweaks
* cheat
* GET->load
* more tweaks
* fix create-svelte
* more tweaks
* Update documentation/docs/05-load.md
Co-authored-by: Simon H <[email protected]>
* fixes
* remove outdated Get reference
* actions
* rewrite type names
* rename Load to PageLoad or LayoutLoad etc
* include filename in migration scripts
* updates
* fix search
* mention export let errors
* changesets
* fix types in create-svelte template
Co-authored-by: Simon Holthausen <[email protected]>
Co-authored-by: Simon H <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will track the implementation of #5748. It may become multiple PRs, we'll see.
So far, it represents a tiny but important milestone — the first unit test of
create_manifest_datapassing with the new filesystem structure.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. All changesets should bepatchuntil SvelteKit 1.0