-
-
Notifications
You must be signed in to change notification settings - Fork 265
Expand file tree
/
Copy pathframeworks.yaml
More file actions
867 lines (811 loc) · 30.3 KB
/
Copy pathframeworks.yaml
File metadata and controls
867 lines (811 loc) · 30.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
# Frameworks basta recognises, and what each one starts without an import.
#
# A framework is a second program that runs the project: it reads a directory,
# turns file names into routes, calls a handler by convention. None of that is
# written down as an `import`, so without this table a working application
# reads as unreachable.
#
# This file is compiled into the binary. A project adds to it or overrides it
# with a file of the same shape — `basta.frameworks.yaml` (or `.yml`, `.json`)
# in the working directory, or `--frameworks-config <file>`. A definition with
# the name of a built-in one replaces it whole.
#
# One definition:
#
# name How the framework is named in output and in `--framework`.
# detect Any one signal is enough, looked for in every directory that
# holds a scanned file:
# configFiles a file of this name exists (`{a,b}` alternatives)
# dependencies package.json depends on this package, in any of its
# dependency tables (a trailing `*` matches a prefix)
# packageJsonKeys package.json has this top-level section
# variables Settings read out of the matched config file, with the value
# to assume when the file does not set one. Written `${name}`
# wherever a path is expected. The name is the config key.
# bases Directories, relative to the one the framework was detected
# in, that `entry` and `directories` are relative to. Default
# `["."]`.
# entry Globs of files the framework loads by name. `*` stays inside
# one path segment; `**` crosses them.
# directories Directories the framework loads whole.
# autoImports More such directories, which one config key can switch off
# (`imports: false`).
# globals Names the framework reads out of the project's code: an
# export it calls (`getServerSideProps`), a lifecycle method it
# invokes (`ngOnInit`). A declaration under one of them is
# used — never reported, and whatever it calls stays alive.
# A bare string holds in every file of the project;
# `{ names: […], files: […] }` ties the names to the files
# (globs, relative to each base) the framework reads them
# from, because `loader` is Remix's word in a route and
# anybody's word everywhere else.
#
# Frameworks are not alternatives. Every definition whose signal matches a
# directory is in force there, alongside the others, and each roots its own
# files: a Next application with Storybook, Vitest and Prisma is four of these.
#
# Everything here errs towards more entry points: a file wrongly kept alive
# hides one finding, a route wrongly reported dead gets the tool turned off.
frameworks:
# ── bundlers and dev servers ──────────────────────────────────────────────
- name: vite
detect:
configFiles: ["vite.config.{js,mjs,cjs,ts,mts,cts}"]
dependencies: [vite]
entry:
# `index.html` names these in a <script> tag, which is not a format
# basta reads.
- "src/main.{js,jsx,ts,tsx}"
- "src/entry-{client,server}.{js,jsx,ts,tsx}"
- name: electron-vite
detect:
configFiles: ["electron.vite.config.{js,mjs,cjs,ts,mts,cts}"]
dependencies: [electron-vite]
entry:
- "src/main/index.{js,ts}"
- "src/preload/index.{js,ts}"
- "src/preload/*.{js,ts}"
- "src/renderer/src/main.{js,jsx,ts,tsx}"
# ── full-stack and meta frameworks ────────────────────────────────────────
- name: next
detect:
configFiles: ["next.config.{js,mjs,cjs,ts,mts}"]
dependencies: [next]
bases: [".", "src"]
entry:
- "pages/**/*.{js,jsx,ts,tsx,mdx}"
- "app/**/{page,layout,route,loading,error,global-error,not-found,template,default,forbidden,unauthorized}.{js,jsx,ts,tsx}"
# Metadata files: a route by file name, like a page.
- "app/**/{icon,apple-icon,opengraph-image,twitter-image,sitemap,robots,manifest}.{js,jsx,ts,tsx}"
- "{middleware,proxy}.{js,ts}"
- "instrumentation.{js,ts}"
- "instrumentation-client.{js,ts}"
- "mdx-components.{js,jsx,ts,tsx}"
globals:
- names: [getServerSideProps, getStaticProps, getStaticPaths, getInitialProps, config, reportWebVitals]
files: ["pages/**/*.{js,jsx,ts,tsx}"]
- names:
- metadata
- generateMetadata
- viewport
- generateViewport
- generateStaticParams
- generateImageMetadata
- generateSitemaps
# Route segment config.
- dynamic
- dynamicParams
- revalidate
- fetchCache
- runtime
- preferredRegion
- maxDuration
- experimental_ppr
# Image metadata files.
- alt
- size
- contentType
# Route handlers.
- GET
- POST
- PUT
- PATCH
- DELETE
- HEAD
- OPTIONS
files: ["app/**/*.{js,jsx,ts,tsx}"]
- names: [middleware, proxy, config]
files: ["{middleware,proxy}.{js,ts}"]
- names: [register, onRequestError, onRouterTransitionStart]
files: ["instrumentation.{js,ts}", "instrumentation-client.{js,ts}"]
- names: [useMDXComponents]
files: ["mdx-components.{js,jsx,ts,tsx}"]
- name: nuxt
detect:
configFiles: ["nuxt.config.{ts,js,mjs,mts}"]
dependencies: [nuxt, nuxt-nightly, nuxt3]
variables:
srcDir: "."
# Nuxt 3 puts the application tree at the root and Nuxt 4 under `app/`;
# both layouts are in the wild, neither is announced anywhere else, and a
# project that moved it says where in `srcDir`. The defaults stay in the
# list: Nuxt 4 keeps `server/` and `modules/` at the root either way.
bases: [".", "app", "${srcDir}"]
entry:
- "app.{vue,js,jsx,ts,tsx}"
- "error.vue"
- "app.config.{js,ts}"
- "router.options.{js,ts}"
- "pages/**/*.{vue,js,jsx,ts,tsx}"
# A component under `components/` is rendered by name, a composable under
# `composables/` is called by name, and the rest are loaded off the file
# system. Nothing in the tree records any of it.
directories:
- components
- composables
- utils
- middleware
- plugins
- modules
- server
- layouts
- name: nitro
detect:
configFiles: ["nitro.config.{ts,js,mjs,mts}"]
dependencies: [nitropack, nitro]
variables:
srcDir: "."
bases: [".", "${srcDir}"]
# A handler in one of these is a route, reached by URL. `server` is here
# because the starter template sets `srcDir: "server"`, and a Nitro app is
# often a package of a monorepo with no Nuxt config of its own.
directories: [api, routes, middleware, plugins, tasks, server, utils]
- name: wxt
detect:
configFiles: ["wxt.config.{ts,js,mjs,mts}"]
dependencies: [wxt]
variables:
srcDir: "."
entrypointsDir: entrypoints
bases: ["${srcDir}"]
# Every file under the entrypoints directory becomes a piece of the
# extension — the background service worker, `*.content.ts` content
# scripts, HTML page directories — at build time, off the file system.
entry:
- "app.config.{js,ts}"
directories: ["${entrypointsDir}"]
# Reached the same wordless way Nuxt's are, until `imports: false` turns
# the auto-imports off; the entrypoints directory is the contract either
# way.
autoImports:
disabledBy: imports
directories: [components, composables, hooks, utils]
- name: plasmo
detect:
dependencies: [plasmo]
bases: [".", "src"]
entry:
- "{background,popup,options,newtab,devtools,sidepanel,content,sandbox}.{js,jsx,ts,tsx,vue,svelte}"
- "{background,popup,options,newtab,devtools,sidepanel}/index.{js,jsx,ts,tsx,vue,svelte}"
directories:
- background/messages
- background/ports
- contents
- tabs
- sandboxes
- name: remix
detect:
configFiles: ["remix.config.{js,mjs,cjs}"]
dependencies: ["@remix-run/dev"]
variables:
appDirectory: app
entry:
- "${appDirectory}/root.{js,jsx,ts,tsx}"
- "${appDirectory}/entry.{client,server}.{js,jsx,ts,tsx}"
- "${appDirectory}/routes/**/*.{js,jsx,ts,tsx,mdx}"
- "server.{js,mjs,ts}"
globals:
- names: [loader, action, clientLoader, clientAction, meta, links, headers, handle, shouldRevalidate, ErrorBoundary, HydrateFallback, Layout, middleware, clientMiddleware]
# Anywhere under the app directory, not only `routes/`: a route module
# named from `routes.ts` (`route("cart", "./features/cart/route.tsx")`)
# is reached by that string, so it is no entry point and its `loader`
# is an export nothing imports.
files: ["${appDirectory}/**/*.{js,jsx,ts,tsx}"]
- names: [handleDataRequest, handleError, streamTimeout]
files: ["${appDirectory}/entry.server.{js,jsx,ts,tsx}"]
- name: react-router
detect:
configFiles: ["react-router.config.{js,mjs,ts,mts}"]
dependencies: ["@react-router/dev"]
variables:
appDirectory: app
entry:
- "${appDirectory}/root.{js,jsx,ts,tsx}"
- "${appDirectory}/routes.{js,ts}"
- "${appDirectory}/entry.{client,server}.{js,jsx,ts,tsx}"
- "${appDirectory}/routes/**/*.{js,jsx,ts,tsx,mdx}"
- "server.{js,mjs,ts}"
globals:
- names: [loader, action, clientLoader, clientAction, meta, links, headers, handle, shouldRevalidate, ErrorBoundary, HydrateFallback, Layout, middleware, clientMiddleware]
# Anywhere under the app directory, not only `routes/`: a route module
# named from `routes.ts` (`route("cart", "./features/cart/route.tsx")`)
# is reached by that string, so it is no entry point and its `loader`
# is an export nothing imports.
files: ["${appDirectory}/**/*.{js,jsx,ts,tsx}"]
- names: [handleDataRequest, handleError, streamTimeout]
files: ["${appDirectory}/entry.server.{js,jsx,ts,tsx}"]
- name: sveltekit
detect:
dependencies: ["@sveltejs/kit"]
entry:
- "src/routes/**/+*.{js,ts,svelte}"
- "src/hooks.{js,ts}"
- "src/hooks.{client,server}.{js,ts}"
- "src/hooks/index.{js,ts}"
- "src/params/**/*.{js,ts}"
- "src/service-worker.{js,ts}"
- "src/service-worker/index.{js,ts}"
- "src/instrumentation.server.{js,ts}"
globals:
- names: [load, actions, prerender, ssr, csr, trailingSlash, config, entries, fallback, GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS]
files: ["src/routes/**/+*.{js,ts}"]
# What the router hands a page or a layout, as Svelte 4 props.
- names: [data, form, params]
files: ["src/routes/**/+*.svelte"]
- names: [handle, handleFetch, handleError, handleValidationError, init, reroute, transport]
files: ["src/hooks.{js,ts}", "src/hooks.{client,server}.{js,ts}", "src/hooks/index.{js,ts}"]
- names: [match]
files: ["src/params/**/*.{js,ts}"]
- name: astro
detect:
configFiles: ["astro.config.{js,mjs,cjs,ts,mts}"]
dependencies: [astro]
variables:
srcDir: src
bases: ["${srcDir}"]
entry:
- "pages/**/*.{astro,js,ts,md,mdx}"
- "content/config.{js,mjs,ts}"
- "content.config.{js,mjs,ts}"
- "live.config.{js,mjs,ts}"
- "middleware.{js,ts}"
- "middleware/index.{js,ts}"
- "actions/index.{js,ts}"
globals:
- names: [getStaticPaths, prerender, partial, ALL, GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS]
files: ["pages/**/*.{astro,js,ts}"]
- names: [onRequest]
files: ["middleware.{js,ts}", "middleware/index.{js,ts}"]
- names: [collections]
files: ["content/config.{js,mjs,ts}", "content.config.{js,mjs,ts}", "live.config.{js,mjs,ts}"]
- names: [server]
files: ["actions/index.{js,ts}"]
- name: solid-start
detect:
dependencies: ["@solidjs/start"]
entry:
- "src/app.{jsx,tsx}"
- "src/entry-{client,server}.{jsx,tsx}"
- "src/middleware.{js,ts}"
- "src/middleware/index.{js,ts}"
- "src/routes/**/*.{js,jsx,ts,tsx}"
globals:
- names: [route, GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS]
files: ["src/routes/**/*.{js,jsx,ts,tsx}"]
- name: tanstack-start
detect:
configFiles: ["tsr.config.json"]
dependencies:
- "@tanstack/react-start"
- "@tanstack/solid-start"
- "@tanstack/router-plugin"
- "@tanstack/router-vite-plugin"
- "@tanstack/router-cli"
bases: ["src", "app"]
entry:
- "routes/**/*.{js,jsx,ts,tsx}"
- "router.{js,jsx,ts,tsx}"
- "{client,server,ssr,start}.{js,jsx,ts,tsx}"
- "routeTree.gen.ts"
globals:
- names: [Route, ServerRoute]
files: ["routes/**/*.{js,jsx,ts,tsx}"]
- name: qwik-city
detect:
dependencies: ["@builder.io/qwik-city", "@qwik.dev/router"]
entry:
- "src/root.{jsx,tsx}"
- "src/entry.*.{jsx,tsx}"
- "src/routes/**/*.{js,jsx,ts,tsx,md,mdx}"
globals:
- names: [head, onRequest, onGet, onPost, onPut, onPatch, onDelete, onHead, onOptions, onStaticGenerate]
files: ["src/routes/**/*.{js,jsx,ts,tsx}"]
- name: gatsby
detect:
configFiles: ["gatsby-config.{js,mjs,ts}"]
dependencies: [gatsby]
entry:
- "gatsby-{config,node,browser,ssr}.{js,jsx,mjs,ts,tsx}"
- "plugins/**/gatsby-{config,node,browser,ssr}.{js,jsx,mjs,ts,tsx}"
- "src/html.{js,jsx,tsx}"
- "src/pages/**/*.{js,jsx,ts,tsx,mdx}"
- "src/templates/**/*.{js,jsx,ts,tsx}"
- "src/api/**/*.{js,ts}"
globals:
- names: [query, Head, config, getServerData]
files: ["src/pages/**/*.{js,jsx,ts,tsx}", "src/templates/**/*.{js,jsx,ts,tsx}"]
- names:
- createPages
- createPagesStatefully
- createResolvers
- createSchemaCustomization
- onCreateBabelConfig
- onCreateDevServer
- onCreateNode
- onCreatePage
- onCreateWebpackConfig
- onPluginInit
- onPreBootstrap
- onPreBuild
- onPreInit
- onPostBootstrap
- onPostBuild
- pluginOptionsSchema
- setFieldsOnGraphQLNodeType
- sourceNodes
# gatsby-browser and gatsby-ssr.
- onClientEntry
- onInitialClientRender
- onPreRenderHTML
- onPreRouteUpdate
- onRenderBody
- onRouteUpdate
- onRouteUpdateDelayed
- onServiceWorkerActive
- onServiceWorkerUpdateReady
- replaceHydrateFunction
- replaceRenderer
- shouldUpdateScroll
- wrapPageElement
- wrapRootElement
files: ["**/gatsby-{node,browser,ssr}.{js,jsx,mjs,ts,tsx}"]
- name: redwood
detect:
configFiles: ["redwood.toml"]
dependencies: ["@redwoodjs/core"]
entry:
- "web/src/{App,Routes}.{js,jsx,tsx}"
- "web/src/entry.{client,server}.{js,jsx,tsx}"
- "api/src/lib/{auth,db,logger}.{js,ts}"
directories:
- web/src/pages
- web/src/layouts
- api/src/functions
- api/src/services
- api/src/graphql
- api/src/directives
- scripts
- name: analog
detect:
dependencies: ["@analogjs/platform"]
entry:
- "src/main.ts"
- "src/main.server.ts"
- "src/app/pages/**/*.{ts,analog,ag}"
- "src/server/routes/**/*.ts"
- "src/server/middleware/**/*.ts"
# ── application frameworks ────────────────────────────────────────────────
- name: angular
detect:
configFiles: ["angular.json"]
dependencies: ["@angular/cli", "@angular/build", "@angular-devkit/build-angular"]
# A workspace keeps each application under `projects/<name>/`.
entry:
- "{projects/*/,}src/{main,main.server,polyfills,test}.ts"
- "{projects/*/,}server.ts"
# Swapped in by `fileReplacements`, which names them in JSON: the
# production build imports `environment.ts` and gets another file.
- "{projects/*/,}src/environments/*.ts"
# Called by the framework on a class it instantiates itself; no code in
# the project names them.
globals:
- ngOnChanges
- ngOnInit
- ngDoCheck
- ngAfterContentInit
- ngAfterContentChecked
- ngAfterViewInit
- ngAfterViewChecked
- ngOnDestroy
- canActivate
- canActivateChild
- canDeactivate
- canMatch
- intercept
- writeValue
- registerOnChange
- registerOnTouched
- setDisabledState
- name: nest
detect:
configFiles: ["nest-cli.json"]
dependencies: ["@nestjs/core"]
variables:
sourceRoot: src
entry:
- "${sourceRoot}/main.ts"
- "${sourceRoot}/repl.ts"
# The CLI's monorepo mode: one application per directory.
- "apps/*/src/main.ts"
globals:
- onModuleInit
- onModuleDestroy
- onApplicationBootstrap
- beforeApplicationShutdown
- onApplicationShutdown
- canActivate
- intercept
- configure
- name: adonis
detect:
configFiles: ["adonisrc.ts", ".adonisrc.json"]
dependencies: ["@adonisjs/core"]
# Controllers, middleware and listeners are bound by a lazy `import()` of
# a `#alias/*` subpath, or by a string the container resolves.
directories:
- bin
- start
- commands
- config
- providers
- database
- app/controllers
- app/middleware
- app/listeners
- app/exceptions
- name: sails
detect:
configFiles: [".sailsrc"]
dependencies: [sails]
entry:
- "app.js"
directories: [api, config]
- name: fastify-autoload
detect:
dependencies: ["@fastify/autoload", "fastify-autoload"]
bases: [".", "src"]
directories: [plugins, routes]
- name: strapi
detect:
dependencies: ["@strapi/strapi"]
entry:
- "src/index.{js,ts}"
- "src/admin/app.{js,jsx,ts,tsx}"
directories:
- config
- database/migrations
- src/api
- src/components
- src/extensions
- src/middlewares
- src/policies
- src/plugins
- name: medusa
detect:
configFiles: ["medusa-config.{js,ts}"]
dependencies: ["@medusajs/medusa", "@medusajs/framework"]
entry:
- "src/modules/*/index.{js,ts}"
- "src/modules/*/migrations/*.{js,ts}"
- "src/admin/routes/**/page.{jsx,tsx}"
directories:
- src/api
- src/subscribers
- src/jobs
- src/links
- src/loaders
- src/scripts
- src/admin/widgets
- name: ember
detect:
configFiles: ["ember-cli-build.{js,cjs}"]
dependencies: [ember-source, ember-cli]
# Ember's resolver looks every module up by name.
directories: [app, addon, addon-test-support, config, mirage]
- name: quasar
detect:
configFiles: ["quasar.config.{js,mjs,cjs,ts}", "quasar.conf.js"]
dependencies: ["@quasar/app-vite", "@quasar/app-webpack"]
entry:
- "src/App.vue"
- "src/router/index.{js,ts}"
- "src/stores/index.{js,ts}"
# Boot files are listed in the config by bare name, not by path.
directories: [src/boot, src-pwa, src-ssr, src-electron, src-bex, src-capacitor]
# ── mobile ────────────────────────────────────────────────────────────────
- name: react-native
detect:
configFiles: ["metro.config.{js,cjs,mjs,ts}", "react-native.config.{js,ts}"]
dependencies: [react-native]
entry:
- "index.{js,jsx,ts,tsx}"
- "index.{ios,android}.{js,jsx,ts,tsx}"
- "App.{js,jsx,ts,tsx}"
# `import './Button'` means one of these per platform, chosen by Metro.
- "**/*.{ios,android,native,web}.{js,jsx,ts,tsx}"
- name: expo
# Not detected by `app.config.*`: Nuxt has a file of that name too.
detect:
dependencies: [expo]
entry:
- "App.{js,jsx,ts,tsx}"
- "app.config.{js,ts}"
- "**/*.{ios,android,native,web}.{js,jsx,ts,tsx}"
- name: expo-router
detect:
dependencies: [expo-router]
bases: [".", "src"]
entry:
- "app/**/*.{js,jsx,ts,tsx}"
globals:
- names: [unstable_settings, ErrorBoundary, generateStaticParams, GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS]
files: ["app/**/*.{js,jsx,ts,tsx}"]
# ── serverless and edge ───────────────────────────────────────────────────
- name: cloudflare-workers
detect:
configFiles: ["wrangler.{toml,json,jsonc}"]
dependencies: [wrangler]
entry:
- "src/{index,worker}.{js,mjs,ts,mts}"
- "_worker.js"
# Pages Functions: routed off the file system.
- "functions/**/*.{js,mjs,ts,mts}"
globals:
- names: [onRequest, onRequestGet, onRequestPost, onRequestPut, onRequestPatch, onRequestDelete, onRequestHead, onRequestOptions]
files: ["functions/**/*.{js,mjs,ts,mts}"]
- name: vercel
detect:
configFiles: ["vercel.json"]
dependencies: [vercel, "@vercel/node"]
entry:
- "api/**/*.{js,mjs,ts,mts}"
- "middleware.{js,ts}"
globals:
- names: [config, GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS]
files: ["api/**/*.{js,mjs,ts,mts}", "middleware.{js,ts}"]
- name: netlify
detect:
configFiles: ["netlify.toml"]
dependencies: [netlify-cli, "@netlify/functions", "@netlify/edge-functions"]
directories: [netlify/functions, netlify/edge-functions]
globals:
- names: [handler, config]
files: ["netlify/{functions,edge-functions}/**/*.{js,mjs,ts,mts}"]
- name: serverless
detect:
configFiles: ["serverless.{yml,yaml,json,js,ts}"]
dependencies: [serverless]
# `handler: src/handlers/create.handler` names a file without its
# extension, so the mention cannot be told from prose.
bases: [".", "src"]
entry:
- "handler.{js,mjs,ts}"
directories: [handlers, functions]
globals:
- names: [handler, main]
files: ["handler.{js,mjs,ts}", "{handlers,functions}/**/*.{js,mjs,ts}"]
- name: firebase-functions
detect:
configFiles: ["firebase.json"]
dependencies: [firebase-functions]
entry:
- "functions/src/index.{js,ts}"
- "functions/index.js"
- name: trigger-dev
detect:
configFiles: ["trigger.config.{js,mjs,ts}"]
dependencies: ["@trigger.dev/sdk"]
bases: [".", "src"]
directories: [trigger]
# ── documentation and static sites ────────────────────────────────────────
- name: docusaurus
detect:
configFiles: ["docusaurus.config.{js,mjs,ts}"]
dependencies: ["@docusaurus/core"]
entry:
- "sidebars*.{js,ts}"
- "src/pages/**/*.{js,jsx,ts,tsx,mdx}"
# A swizzled component replaces the theme's by sitting at the same path.
directories: [src/theme]
- name: vitepress
detect:
configFiles: [".vitepress/config.{js,mjs,ts,mts}"]
dependencies: [vitepress]
entry:
- "**/.vitepress/config.{js,mjs,ts,mts}"
- "**/.vitepress/theme/index.{js,mjs,ts,mts}"
- "**/*.data.{js,mjs,ts,mts}"
- "**/*.paths.{js,mjs,ts,mts}"
globals:
- names: [data]
files: ["**/*.data.{js,mjs,ts,mts}"]
- name: eleventy
detect:
configFiles: [".eleventy.js", "eleventy.config.{js,mjs,cjs}"]
dependencies: ["@11ty/eleventy"]
entry:
- ".eleventy.js"
- "**/*.11ty.{js,mjs,cjs}"
- "**/*.11tydata.{js,mjs,cjs}"
- "**/_data/**/*.{js,mjs,cjs}"
globals:
- names: [data, render]
files: ["**/*.11ty.{js,mjs,cjs}"]
# ── component workshops ───────────────────────────────────────────────────
- name: storybook
detect:
configFiles: [".storybook/main.{js,mjs,cjs,ts,mts}"]
dependencies: [storybook, "@storybook/*"]
entry:
- ".storybook/**/*.{js,jsx,mjs,cjs,ts,tsx,mts}"
- "**/*.{stories,story}.{js,jsx,ts,tsx,svelte,vue}"
globals:
- names: [parameters, decorators, globalTypes, initialGlobals, loaders, args, argTypes, tags, beforeAll, beforeEach]
files: [".storybook/preview.{js,jsx,mjs,ts,tsx}"]
- name: histoire
detect:
configFiles: ["histoire.config.{js,mjs,ts}"]
dependencies: [histoire]
entry:
- "histoire.setup.{js,ts}"
- "src/histoire.setup.{js,ts}"
- "**/*.story.{vue,svelte,js,ts}"
# ── test runners ──────────────────────────────────────────────────────────
- name: jest
detect:
configFiles: ["jest.config.{js,mjs,cjs,ts,mts,cts,json}"]
dependencies: [jest]
packageJsonKeys: [jest]
entry:
- "jest.*.{js,mjs,cjs,ts,mts,cts}"
- "{src/,}setupTests.{js,jsx,ts,tsx}"
- "**/__mocks__/**/*.{js,jsx,mjs,cjs,ts,tsx}"
- name: vitest
detect:
configFiles: ["vitest.config.{js,mjs,cjs,ts,mts,cts}", "vitest.workspace.{js,mjs,ts,json}"]
dependencies: [vitest]
entry:
- "vitest.*.{js,mjs,cjs,ts,mts,cts}"
- "**/*.{bench,test-d}.{js,mjs,ts,mts,tsx}"
- "**/__mocks__/**/*.{js,jsx,mjs,cjs,ts,tsx}"
- name: mocha
detect:
configFiles: [".mocharc.{js,cjs,mjs,json,jsonc,yaml,yml}"]
dependencies: [mocha]
packageJsonKeys: [mocha]
entry:
- ".mocharc.{js,cjs,mjs}"
directories: [test]
- name: ava
detect:
configFiles: ["ava.config.{js,cjs,mjs}"]
dependencies: [ava]
packageJsonKeys: [ava]
entry:
- "**/test.{js,cjs,mjs,ts}"
- "**/test-*.{js,cjs,mjs,ts}"
- name: playwright
detect:
configFiles: ["playwright.config.{js,mjs,cjs,ts,mts}", "playwright-ct.config.{js,mjs,cjs,ts,mts}"]
dependencies: ["@playwright/test", "@playwright/experimental-ct-*"]
entry:
- "playwright*.config.{js,mjs,cjs,ts,mts}"
- "{global-setup,global-teardown,global.setup,global.teardown}.{js,ts}"
- "**/*.setup.{js,ts}"
directories: [playwright]
- name: cypress
detect:
configFiles: ["cypress.config.{js,mjs,cjs,ts}"]
dependencies: [cypress]
entry:
- "**/*.cy.{js,jsx,ts,tsx}"
directories: [cypress]
- name: cucumber
detect:
configFiles: ["cucumber.{js,mjs,cjs,json,yaml,yml}"]
dependencies: ["@cucumber/cucumber"]
entry:
- "cucumber.{js,mjs,cjs}"
- "**/step_definitions/**/*.{js,mjs,cjs,ts}"
directories: [features]
# ── databases and migrations ──────────────────────────────────────────────
- name: prisma
detect:
configFiles: ["prisma.config.{js,mjs,ts,mts}", "prisma/schema.prisma"]
dependencies: [prisma, "@prisma/client"]
packageJsonKeys: [prisma]
entry:
- "prisma.config.{js,mjs,ts,mts}"
- "prisma/seed.{js,mjs,ts,mts}"
- name: knex
detect:
configFiles: ["knexfile.{js,mjs,cjs,ts}"]
dependencies: [knex]
entry:
- "knexfile.{js,mjs,cjs,ts}"
directories: [migrations, seeds]
- name: sequelize
detect:
configFiles: [".sequelizerc"]
dependencies: [sequelize-cli]
bases: [".", "src", "db", "database"]
directories: [migrations, seeders, models]
- name: typeorm
detect:
configFiles: ["ormconfig.{js,ts,json}"]
dependencies: [typeorm]
# Entities, migrations and subscribers are handed to the data source as
# glob strings far more often than as imports.
entry:
- "ormconfig.{js,ts}"
- "**/data-source.{js,ts}"
- "**/migrations/**/*.{js,ts}"
- "**/*.{entity,subscriber,migration}.{js,ts}"
# ── other toolchains ──────────────────────────────────────────────────────
- name: hardhat
detect:
configFiles: ["hardhat.config.{js,cjs,mjs,ts}"]
dependencies: [hardhat]
directories: [scripts, tasks, deploy, ignition/modules, test]
- name: create-react-app
detect:
dependencies: [react-scripts, "@craco/craco", react-app-rewired]
entry:
- "src/index.{js,jsx,ts,tsx}"
- "src/setupTests.{js,ts}"
- "src/setupProxy.js"
- "src/service-worker.{js,ts}"
- "src/react-app-env.d.ts"
# ── Python ────────────────────────────────────────────────────────────────
# Nothing in this table is about JavaScript as such: a framework is found by
# a file it cannot run without, and what it loads is a list of paths.
- name: django
detect:
configFiles: ["manage.py"]
entry:
# Applied in order by `migrate`, which finds them by listing the
# directory; nothing imports `0007_add_index.py`.
- "**/migrations/*.py"
# `manage.py <name>` is the file's name.
- "**/management/commands/*.py"
# `{% load shop_tags %}` in a template.
- "**/templatetags/*.py"
# Found by autodiscovery and the app registry, from `INSTALLED_APPS`.
- "**/{admin,apps,models,tests}.py"
# Named in settings by dotted path, as strings.
- "**/{middleware,context_processors,backends,routing}.py"
- "**/settings/*.py"
globals:
- urlpatterns
- app_name
- application
- default_app_config
- handler400
- handler403
- handler404
- handler500
- name: alembic
detect:
configFiles: ["alembic.ini"]
entry:
- "**/versions/*.py"
- "**/env.py"
globals:
- names: [revision, down_revision, branch_labels, depends_on, upgrade, downgrade]
files: ["**/versions/*.py"]
- name: scrapy
detect:
configFiles: ["scrapy.cfg"]
entry:
- "**/spiders/*.py"
- "**/{settings,pipelines,middlewares,items}.py"