@niroai/niro 0.17.0 → 1.0.0

package/docs/supported-javascript.md

@@ -0,0 +1,223 @@
+# Supported in JavaScript
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: catalog/javascript.json; catalog/javascript.structure.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page lists the JavaScript libraries, frameworks and build tools Niro was tested against, and whether it recognised each one.
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+The test catalog also holds 8 look-alike cases for JavaScript: code that Niro must NOT take for a route, a call or a store. They test that Niro ignores the look-alike, so they are left out of this page and its counts.
+<!-- source: catalog/javascript.json and catalog/javascript.structure.json, rows marked as traps (scripts/gen-supported-docs.js isTrap) -->
+
+## Web frameworks and HTTP servers (the routes your code serves)
+
+23 supported, 3 partly, 4 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @apollo/server | supported | yes: app.use('/graphql', expressMiddleware(server)) |
+| @azure/functions (v3 programming model) | supported | yes: <FunctionName>/function.json httpTrigger route + methods, code in index.js as module.exports = async function (context, req)<br>yes: function.json httpTrigger with no route and no methods: every verb at /api/<FunctionName> |
+| @fastify/autoload | supported | yes: the fastify-cli generated layout: app.js registers AutoLoad for plugins/ and routes/; routes/<folder>/index.js gets the folder prefix |
+| @feathersjs/feathers | not yet | no: app.use('/messages', new Service()) gives REST find/get/create/remove |
+| @google-cloud/functions-framework | supported | yes: functions.http('name', handler) |
+| @hapi/hapi | partly | yes: server.route({ method, path, handler })<br>yes: server.route([ {...}, {...} ]) with an array of route objects<br>no: plugin registered with { routes: { prefix } } |
+| @koa/router | supported | yes: const router = new Router(); router.get(path, h)<br>yes: new Router({ prefix }) in its own file, then router.get/post<br>yes: a Router held in a variable not called router (audit), mounted with router.use(path, audit.routes()) |
+| @remix-run/node (Remix v2) | supported | yes: app/routes/<dotted>.js resource route with loader and action, in JavaScript |
+| @sveltejs/kit | supported | yes: src/routes/<path>/+server.js in JavaScript with JSDoc types, a [param], a group and a [...rest] |
+| @tinyhttp/app | supported | yes: new App().get().post() (ES module) |
+| Cloudflare Pages Functions | supported | yes: functions/<path>.js exporting function onRequestGet / onRequestPost ...<br>yes: functions/<dir>/[param].js and [[param]].js |
+| connect | not yet | no: connect().use(path, handler): any verb |
+| express | supported | yes: app.get/app.post(path, handler) on the app object<br>yes: Router() in its own file, module.exports, mounted with app.use(prefix, router)<br>yes: app.route(path).put(h).delete(h) chain<br>yes: router mounted inside a router: app.use("/v2", v2); v2.use("/promos", promos) |
+| express-file-routing | supported | yes: await createRouter(app) binding routes/ directly to the app, in JavaScript (ESM) |
+| fastify | partly | yes: fastify.get(path, handler)<br>yes: fastify.route({ method, url, handler })<br>yes: fastify.route({ method: [PUT, PATCH], url })<br>no: plugin in another file registered with { prefix } |
+| firebase-functions | partly | yes: exports.name = functions.https.onRequest(handler): path is the export name<br>yes: v2 onRequest(options, handler)<br>partly: Express app passed to onRequest: routes under the export name |
+| Gatsby Functions (gatsby) | supported | yes: src/api/<path>.js default export handler(req, res) |
+| koa-router | supported | yes: legacy koa-router package, router.get and router.del |
+| micro + microrouter | not yet | no: module.exports = router(get(path, h), post(path, h)) |
+| Netlify Edge Functions | supported | yes: netlify/edge-functions/<name>.js with export const config = { path } |
+| Netlify Functions (@netlify/functions) | supported | yes: netlify/functions/<name>.mjs default export with export const config = { path } |
+| Netlify Functions (@netlify/functions), Lambda-compatible | supported | yes: netlify/functions/<name>.js with exports.handler = async (event, context): /.netlify/functions/<name> |
+| next | supported | yes: pages/api/auth/[...nextauth].js: export default NextAuth(options), a catch-all API route in JavaScript<br>yes: pages/api/<path>/[[...slug]].js beside a fixed file in the same folder (fixed routes win)<br>yes: app/<path>/route.js in JavaScript, with a dynamic segment and a route group |
+| next (pages router) | supported | yes: pages/api/<path>.js default export handler, verb from req.method<br>yes: pages/api/catalog/[id].js dynamic segment |
+| polka | supported | yes: polka().get(...).post(...) chained on the constructor call |
+| restify | supported | yes: server.get/post/del(path, handler) |
+| sails | not yet | no: config/routes.js object map 'VERB /path': 'Controller.action' |
+| serverless framework (AWS Lambda) | supported | yes: serverless.yml functions.<name>.events http/httpApi path+method, handler file.export |
+| Vercel Functions (@vercel/node), no framework | supported | yes: api/<name>.js with module.exports = (req, res) => {}: every verb<br>yes: api/<name>.mjs exporting GET, POST: the export name is the verb<br>yes: api/<dir>/[param].js: one segment, value in req.query |
+| ws | supported | yes: new WebSocketServer({ port, path }); wss.on('connection') |
+
+## The language's own HTTP server
+
+0 supported, 0 partly, 5 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Bun.serve | not yet | no: Bun.serve({ fetch(req) }) with new URL(req.url).pathname comparison<br>no: Bun.serve({ routes: { "/path/:id": { GET, DELETE } } }) route table |
+| node:http | not yet | no: http.createServer(handler) with if/else on req.method and new URL(req.url).pathname<br>no: switch over `${req.method} ${req.url}` with one case per route<br>no: new http.Server() then server.on('request', handler) |
+| node:http2 | not yet | no: http2.createSecureServer().on('stream') reading headers[':path'] |
+| node:https | not yet | no: https.createServer(tlsOptions, handler) with req.url comparison |
+| node:net | not yet | no: net.createServer(socket => ...).listen(port): a raw TCP service (not HTTP) |
+
+## HTTP client libraries (the calls your code makes to other services)
+
+14 supported, 5 partly, 2 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @apollo/client | supported | yes: useQuery(gql`...`) and useMutation in JSX, uri set on ApolloClient in another module |
+| axios | partly | no: axios.create({ baseURL: import.meta.env.X ?? default }) exported from one module, api.get(path) in another<br>yes: axios.get(`${BASE}/path`)<br>yes: axios.post(literalUrl, body)<br>no: axios({ method, url, data }) called as a function<br>yes: const api = axios.create({ baseURL }); api.get(path)<br>partly: axios.request({ url, method })<br>partly: this.http = axios.create({ baseURL: env }) in a constructor; this.http.get(path) |
+| axios (any client) | supported | yes: the call sits in a const arrow function: const f = () => axios.get(url)<br>yes: the call sits in a method of an object literal<br>yes: the call sits in exports.name = () => ... |
+| bent | not yet | no: bent(base, 'json') returns a function called with the path |
+| cross-fetch | supported | yes: crossFetch(url) |
+| got | supported | yes: got(url).json() called as a function<br>yes: got.post(url, { json })<br>yes: got.extend({ prefixUrl }) then client.get(relative) |
+| graphql-request | partly | no: request(endpoint, query)<br>yes: new GraphQLClient(endpoint).request(query) |
+| isomorphic-fetch | supported | yes: require('isomorphic-fetch') then the global fetch(url) |
+| make-fetch-happen | not yet | no: require(...).defaults(opts) then fetch(url) |
+| needle | supported | yes: needle('get', url): verb as the first argument<br>yes: needle.post(url, data) |
+| node-fetch | supported | yes: fetch(url, { method }) imported from node-fetch under another name |
+| ofetch | partly | yes: ofetch(url)<br>no: ofetch.create({ baseURL }) then api(path) |
+| phin | supported | yes: phin({ url, method, data }) |
+| react-router-dom | supported | yes: createBrowserRouter([{ path, loader({ params }) { fetch(...) } }])<br>yes: route action({ request }) posting with fetch |
+| redaxios | supported | yes: redaxios.get(url) |
+| request (deprecated) | supported | yes: request.get(url, cb)<br>yes: request({ uri, method }, cb) |
+| superagent | supported | yes: superagent.get(url)<br>yes: superagent.delete(url)<br>yes: superagent.post(url).send(body).set(h) chain |
+| swr | partly | yes: useSWR(url, fetcher) in a JSX component<br>partly: useSWRMutation(url, (url, { arg }) => fetch(url, { method: 'POST' })) |
+| undici | partly | yes: request(url) from undici<br>yes: undici.fetch(url)<br>partly: new Pool(origin).request({ path, method }) |
+| vue (single-file component) | supported | yes: <script setup> in a .vue file calling axios.get |
+| wretch | supported | yes: wretch(url).delete().res()<br>yes: wretch(base).url(path).post(body) |
+
+## The language's own HTTP client
+
+8 supported, 1 partly, 2 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @sveltejs/kit | supported | yes: export async function load({ fetch }) in +page.js using the fetch it is given |
+| fetch (any client) | supported | yes: the call sits in an async arrow with a block body<br>yes: the call sits in a class field holding an arrow function |
+| fetch (browser) | supported | yes: fetch(url) in an async function inside useEffect, in a .jsx file |
+| fetch (global) | partly | yes: fetch(literalUrl)<br>yes: fetch(`${BASE}/path`, { method }) with BASE from process.env ?? default<br>partly: fetch(new Request(url, { method }))<br>yes: a project wrapper api(path, opts) around fetch, called with the path |
+| node:http | supported | yes: http.request({ hostname, port, path, method }, cb)<br>yes: http.request(urlString, { method }, cb)<br>yes: http.get(url, cb) |
+| node:http2 | not yet | no: http2.connect(origin).request({ ':path', ':method' }) |
+| node:https | supported | yes: https.get(url, cb)<br>yes: https.request({ host, port, path, method }, cb) |
+| node:net | not yet | no: net.createConnection({ host, port }): raw TCP client |
+| svelte (component) | supported | yes: fetch inside <script> of a .svelte component |
+| vue (single-file component) | supported | yes: <script setup> in a .vue file calling fetch with a method |
+| WebSocket (global) | supported | yes: new WebSocket('ws://host/path') (global since Node 22) |
+
+## gRPC
+
+3 supported, 2 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @grpc/grpc-js | partly | partly: server streaming: client.method(req).on('data')<br>no: promisify(client.method).bind(client) passed as a value (gRPC plan 8.1: code, later)<br>yes: literal_path: new grpc.Client(addr).makeUnaryRequest('/pkg.S/M', ...) |
+| @grpc/grpc-js (static codegen) | supported | yes: constructor: new services.{S}Client(addr, creds) from *_grpc_pb |
+| @grpc/grpc-js (static grpc-tools codegen) | supported | yes: server.addService(services.{S}Service, { method }) with *_grpc_pb.js checked in, paths written in the generated object |
+| @grpc/grpc-js + @grpc/proto-loader | supported | yes: grpc-node-addservice: server.addService(proto.{S}.service, { method: impl }) after loadSync(proto)<br>yes: constructor: new proto.{S}(addr, creds) from loadPackageDefinition, then client.method(req, cb) |
+| grpc (deprecated native package) | partly | yes: grpc.load(proto); server.addService(proto.pkg.{S}.service, impl)<br>partly: constructor: new pkg.{S}(addr, creds) after grpc.load |
+
+## Databases and data stores
+
+23 supported, 1 partly, 4 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @aws-sdk/client-dynamodb | supported | yes: client.send(new PutItemCommand({ TableName })) |
+| @aws-sdk/client-s3 | supported | yes: s3.send(new PutObjectCommand({ Bucket, Key })) |
+| @aws-sdk/lib-dynamodb | supported | yes: DynamoDBDocumentClient.from(client).send(new GetCommand({ TableName })) |
+| @elastic/elasticsearch | supported | yes: es.search({ index }) / es.index({ index, document }) |
+| aws-sdk (v2) | supported | yes: new AWS.DynamoDB.DocumentClient().put({ TableName }).promise() |
+| better-sqlite3 | supported | yes: db.prepare(sql).get()/run(); db.exec(sql) |
+| bookshelf | not yet | no: bookshelf.model('Book', { tableName }) then fetch()/fetchAll() |
+| cassandra-driver | supported | yes: client.execute(cql, params, { prepare }) |
+| dynamoose | supported | yes: dynamoose.model('Device', schema); Device.get/create |
+| firebase-admin | supported | yes: admin.firestore().collection('x').doc(id).get()/set(); collection('x').add() |
+| ioredis | supported | yes: redis.get/set/hset/incr on new Redis(url)<br>yes: main reads a key another service writes |
+| knex | supported | yes: knex('table').where().select() / insert()<br>yes: knex.select('*').from('table')<br>yes: knex.raw(sql)<br>yes: knex.schema.createTable('t', fn) (DDL) |
+| lowdb | not yet | no: JSONFilePreset('db.json', defaults); db.data.x.push(); db.write() |
+| mongodb | supported | yes: const col = db.collection('x'); col.find()/insertOne()/updateOne()/aggregate()<br>yes: client.db('x').collection('y').deleteOne() in one chain<br>yes: main reads a collection another service writes |
+| mongoose | supported | yes: mongoose.model('Cart', schema): collection is the plural, lower-cased name<br>yes: mongoose.model('Audit', schema, 'audit_trail') third argument |
+| mssql | supported | yes: pool.request().input(...).query(sql)<br>yes: sql.query`...` tagged template |
+| mysql | supported | yes: pool.query(sql, params, callback) (legacy mysql package) |
+| mysql2 | supported | yes: mysql2/promise pool.execute(sql, params) |
+| nano | not yet | no: nano.db.use('db').get()/insert() |
+| neo4j-driver | supported | yes: session.run(cypher) and session.executeWrite(tx => tx.run(cypher)) |
+| objection | not yet | no: class X extends Model { static get tableName() }; X.query().findById() |
+| oracledb | supported | yes: conn.execute(sql, binds) |
+| pg | supported | yes: pool.query(sqlText, params) for SELECT, INSERT, DELETE<br>yes: client.query({ text, values }) config object<br>yes: table name from a constant in a template literal<br>yes: main reads a table another service writes (cross-service data link) |
+| pg-promise | supported | yes: db.any/none/one(sql, params) |
+| postgres (postgres.js) | supported | yes: sql`SELECT ... FROM t WHERE id = ${id}` tagged template<br>yes: sql.unsafe(sqlText) |
+| redis | supported | yes: createClient({ url }); client.set/get/hGetAll (v4 camelCase) |
+| sequelize | partly | no: sequelize.define('Model', attrs, { tableName }) then Model.findAll()<br>no: class X extends Model {}; X.init(attrs, { sequelize, tableName }); X.create()<br>yes: sequelize.query(sql, { type }) |
+| sqlite3 | supported | yes: db.all/db.run/db.get(sql, params, cb) |
+
+## Messaging and events (queues, topics, streams)
+
+9 supported, 16 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| @aws-sdk/client-sns | supported | yes: sns.send(new PublishCommand({ TopicArn })) |
+| @aws-sdk/client-sqs | partly | partly: sqs.send(new ReceiveMessageCommand({ QueueUrl })) polling loop<br>partly: sqs.send(new SendMessageCommand({ QueueUrl: env ?? default })) |
+| @azure/event-hubs | partly | no: new EventHubConsumerClient(group, conn, 'hub').subscribe({...})<br>yes: new EventHubProducerClient(conn, 'hub').sendBatch(batch) |
+| @azure/service-bus | partly | no: sb.createReceiver('queue').subscribe({ processMessage })<br>yes: sb.createSender('queue').sendMessages({ body }) |
+| @google-cloud/pubsub | partly | no: pubsub.subscription('sub').on('message', h)<br>yes: pubsub.topic('t').publishMessage({ json }) |
+| @stomp/stompjs | partly | no: client.subscribe('/queue/x', h)<br>partly: client.publish({ destination, body }) |
+| agenda | supported | yes: agenda.define('job-name', handler)<br>yes: agenda.now('job', data); agenda.every(interval, 'job') |
+| amqplib | partly | partly: ch.consume('queue', handler)<br>partly: assertExchange + bindQueue(q, exchange, pattern) + consume(q)<br>partly: ch.sendToQueue('queue', buf)<br>partly: ch.publish('exchange', 'routing.key', buf) |
+| aws-sdk (v2) | partly | partly: new AWS.SQS().sendMessage({ QueueUrl }).promise() |
+| bee-queue | partly | partly: new BeeQueue('name').process(handler)<br>partly: queue.createJob(data).save() |
+| bull | partly | partly: new Queue('name', redisUrl).process(handler)<br>yes: new Queue('name', url).add(data) |
+| bullmq | partly | yes: new Worker('queue', processor, { connection })<br>partly: new Queue('name', { connection }).add('job', data) |
+| events (EventEmitter) | supported | yes: class X extends EventEmitter; bus.on('name', h); bus.emit('name', data) |
+| firebase-functions | supported | yes: Firestore trigger onDocumentCreated('collection/{id}') |
+| ioredis | supported | yes: sub.subscribe('channel'); sub.on('message', h)<br>yes: redis.publish('channel', msg) |
+| kafkajs | partly | yes: consumer.subscribe({ topic }) then consumer.run({ eachMessage })<br>yes: consumer.subscribe({ topics: [a, b] })<br>yes: producer.send({ topic, messages })<br>no: producer.sendBatch({ topicMessages: [{ topic }] })<br>yes: producer.send({ topic: literal }) in main, consumed by kafkajs-svc<br>yes: producer.send({ topic: TOPICS.X }) with the topic in a constant object |
+| mqtt | supported | yes: client.subscribe('topic'); client.on('message', h)<br>yes: client.publish('topic', payload) |
+| nats | partly | yes: nc.subscribe('subject') with for await<br>no: nc.subscribe('subject', { queue, callback })<br>yes: request side nc.request; reply side subscribe + m.respond<br>yes: nc.publish('subject', data)<br>yes: await nc.request('subject', data) |
+| node-rdkafka | supported | yes: consumer.subscribe(['topic']); consumer.on('data', h)<br>yes: producer.produce('topic', partition, buffer) |
+| pg | partly | no: client.query('LISTEN channel'); client.on('notification', h)<br>partly: SELECT pg_notify('channel', payload) |
+| redis | supported | yes: await subscriber.subscribe('channel', listener)<br>yes: client.xReadGroup(group, consumer, [{ key }]) (streams)<br>yes: client.publish('channel', msg); client.xAdd('stream', '*', fields) |
+| rhea | supported | yes: connection.open_receiver('address'); container.on('message', h)<br>yes: connection.open_sender('address').send({ body }) |
+| socket.io | partly | partly: io.on('connection', s => s.on('event', h)); io.emit('event') |
+| socket.io-client | partly | partly: io(url).emit('event', data); socket.on('event', h) |
+| sqs-consumer | not yet | no: Consumer.create({ queueUrl, handleMessage }) |
+| zeromq | partly | yes: new zmq.Subscriber(); sock.subscribe('topic')<br>partly: new zmq.Publisher(); pub.send(['topic', msg]) |
+
+## Build tools and package managers
+
+9 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Bun workspaces | supported | yes: package.json workspaces with bun.lock, an app using Bun.serve and no server framework dependency |
+| Lerna | supported | yes: lerna.json "packages": ["packages/*"] with fixed versioning; packages named by their package.json |
+| npm | supported | yes: one package.json, src/ code, test/ tests, dist/ output gitignored |
+| npm workspaces | supported | yes: root package.json "workspaces": ["apps/*", "packages/*"], sibling dependency by name with "*" |
+| pnpm workspaces | supported | yes: pnpm-workspace.yaml packages list, "workspace:*" protocol, catalog: versions |
+| Rush | supported | yes: rush.json "projects": [{ packageName, projectFolder }] with folders that are not one glob; common/ holds tool config |
+| webpack | supported | yes: webpack.config.js resolve.alias { Utilities: path.resolve(__dirname, "src/utilities/") } imports, a minified vendor file in public/ |
+| yarn 1 (classic) workspaces | supported | yes: "workspaces": { "packages": [...], "nohoist": [...] } object form, yarn.lock v1 |
+| yarn 2+ (berry) with Plug n Play | supported | yes: .yarnrc.yml nodeLinker pnp, "workspace:^" protocol, generated .pnp.cjs and .yarn/ folder |
+
+## Project and folder layouts
+
+6 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Babel or tsc output folders | supported | yes: source in src/, CommonJS output in lib/ and ESM output in es/ (both gitignored), "main": "lib/index.js" |
+| Electron | supported | yes: one package with main/ (Node process), preload/ and renderer/ (browser), electron-builder output in release/ |
+| Jest, Mocha, Cypress | supported | yes: __tests__/ folders, colocated *.test.js, test/ for Mocha, cypress/e2e, and coverage/lcov-report output |
+| Next.js (pages router) | supported | yes: pages/ and pages/api/ at the root, lib/ helpers, .next/ build output and out/ static export |
+| Node module systems | supported | yes: "type": "module" package with .mjs and .cjs files, createRequire, an "exports" map with subpaths and conditions, "imports" #aliases |
+| Yeoman | supported | yes: generator-<name>/generators/<sub>/index.js with templates/ holding EJS-templated JS that is not valid code |

package/docs/supported-kotlin.md

@@ -0,0 +1,124 @@
+# Supported in Kotlin
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: catalog/kotlin.json; catalog/kotlin.structure.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page lists the Kotlin libraries, frameworks and build tools Niro was tested against, and whether it recognised each one.
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+The test catalog also holds 4 look-alike cases for Kotlin: code that Niro must NOT take for a route, a call or a store. They test that Niro ignores the look-alike, so they are left out of this page and its counts.
+<!-- source: catalog/kotlin.json and catalog/kotlin.structure.json, rows marked as traps (scripts/gen-supported-docs.js isTrap) -->
+
+## Web frameworks and HTTP servers (the routes your code serves)
+
+4 supported, 0 partly, 2 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| http4k | not yet | no: routes("path" bind METHOD to handler) |
+| Javalin in Kotlin | supported | yes: app.get(path) { ctx -> } with a trailing lambda |
+| Ktor Resources (type-safe routing) | not yet | no: @Resource(path) classes and get<Res> { } |
+| Ktor server | supported | yes: routing { get(path) { } ; post(path) { } } inside Application.module()<br>yes: route(prefix) { get { } ; post(sub) { } }<br>yes: routes declared in a fun Route.x() extension called from routing { } |
+| Spring Web MVC in Kotlin | supported | yes: @RestController + @RequestMapping prefix + @GetMapping in Kotlin |
+| Spring WebFlux Kotlin DSL | supported | yes: coRouter { GET(path, handler::fn); "/prefix".nest { GET(sub, h) } }<br>yes: router { GET(path) { .. } } |
+
+## The language's own HTTP server
+
+2 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| com.sun.net.httpserver from Kotlin | supported | yes: server.createContext(path) { exchange -> } |
+| Servlet API from Kotlin | supported | yes: @WebServlet(path) class X : HttpServlet() { override fun doGet } |
+
+## HTTP client libraries (the calls your code makes to other services)
+
+3 supported, 2 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Fuel | partly | no: "url".httpGet().responseString() string extension<br>yes: Fuel.post(url).body(..) |
+| Ktor client | partly | yes: client.get("url/$id") / client.post(url) { setBody(..) }<br>partly: client.request(url) { method = HttpMethod.Post }<br>no: client.get { url { protocol; host; port; path(..) } }<br>yes: HttpClient { defaultRequest { url(base) } } then relative get(path) |
+| OkHttp from Kotlin | supported | yes: client.newCall(Request.Builder().url(..).post(json.toRequestBody()).build()).execute() |
+| Retrofit with Kotlin suspend functions | not yet | no: interface with suspend @GET fun, Retrofit.Builder().baseUrl(base) |
+| Spring RestTemplate Kotlin extension | supported | yes: restTemplate.getForObject<T>(url) |
+| Spring WebClient with coroutines | supported | yes: webClient.get().uri(path).retrieve().awaitBody<T>() |
+
+## The language's own HTTP client
+
+1 supported, 1 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| java.net.http from Kotlin | partly | partly: HttpRequest.newBuilder(URI(x)).GET().build(); http.send(..) |
+| java.net.HttpURLConnection from Kotlin | not yet | no: (URL(x).openConnection() as HttpURLConnection) with requestMethod = ".." |
+| kotlin.io URL.readText() (stdlib extension) | supported | yes: URL(x).readText() |
+
+## gRPC
+
+5 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| grpc-java base in Kotlin with net.devh @GrpcService | supported | yes: @GrpcService class X : {S}Grpc.{S}ImplBase() |
+| grpc-java client from Kotlin | supported | yes: {S}Grpc.newBlockingStub(channel).rpc(req), channel forTarget("host:port") |
+| grpc-kotlin | supported | yes: class X : {S}GrpcKt.{S}CoroutineImplBase() with override suspend fun (and Flow for streams) |
+| grpc-kotlin client | supported | yes: {S}GrpcKt.{S}CoroutineStub(channel).rpc(req), streams collected as Flow |
+| net.devh @GrpcClient in Kotlin | supported | yes: @GrpcClient("name") private lateinit var stub: {S}BlockingStub |
+
+## Databases and data stores
+
+1 supported, 1 partly, 6 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Android Room | partly | partly: @Entity(tableName) + @Dao interface with @Query(SQL) / @Insert / @Delete |
+| Exposed (JetBrains) | not yet | no: object X : Table("name"); transaction { X.selectAll() / X.insert { } / X.deleteWhere { } } |
+| Exposed (JetBrains) DAO | not yet | no: object X : IntIdTable("name") with an IntEntity; Entity.all() / Entity.new { } |
+| JDBC from Kotlin | not yet | no: DriverManager.getConnection(..).use { it.prepareStatement(SQL) } |
+| Ktorm | not yet | no: object X : Table<Nothing>("name"); database.from(X).select() / database.insert(X) { } |
+| MongoDB Kotlin coroutine driver | not yet | no: database.getCollection<T>("name").find(..) / insertOne |
+| Spring Data (Kotlin coroutines) | supported | yes: interface : CoroutineCrudRepository<T, Id>, @Table data class |
+| SQLDelight | not yet | no: .sq file with CREATE TABLE and labelled queries; generated xQueries.label() calls |
+
+## Messaging and events (queues, topics, streams)
+
+2 supported, 1 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Apache Kafka clients from Kotlin | partly | partly: KafkaProducer(props).use { it.send(ProducerRecord(t, k, v)) }; consumer.subscribe(listOf(t)) |
+| Spring AMQP in Kotlin | supported | yes: @RabbitListener(queues = ["literal"]) and rabbitTemplate.convertAndSend |
+| Spring for Apache Kafka in Kotlin | supported | yes: @KafkaListener(topics = ["literal"]) and kafkaTemplate.send |
+
+## Build tools and package managers
+
+8 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Amper (JetBrains) | supported | yes: project.yaml listing modules, module.yaml with product: jvm/app or jvm/lib, flat src/ and test/ |
+| Android Gradle Plugin | supported | yes: com.android.application module and com.android.library module; Kotlin under src/main/java; test and androidTest |
+| Gradle buildSrc (Kotlin DSL) | supported | yes: buildSrc with `kotlin-dsl` precompiled script plugins, plus a .main.kts script |
+| Gradle Kotlin DSL (multi-project) | supported | yes: settings include(...), a Kotlin application, a Spring Boot Kotlin service and a plain kotlin("jvm") library |
+| Gradle Kotlin DSL (single project) | supported | yes: one build.gradle.kts with kotlin("jvm") and application, src/main/kotlin and src/test/kotlin |
+| Gradle version catalog (Kotlin) | supported | yes: alias(libs.plugins.ktor) and implementation(projects.moneyLib) |
+| Kotlin Multiplatform | supported | yes: shared module with commonMain, jvmMain, jsMain (expect/actual) and commonTest; a JVM server depending on it |
+| Maven + kotlin-maven-plugin | supported | yes: <sourceDirectory>src/main/kotlin</sourceDirectory> with kotlin-maven-plugin; Spring Boot service and Kotlin library |
+
+## Project and folder layouts
+
+1 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Gradle with flat Kotlin source folders | supported | yes: kotlin.srcDir("src") and srcDir("test") instead of src/main/kotlin |

package/docs/supported-overview.md

@@ -0,0 +1,89 @@
+# What Niro supports
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: niro_local/languages.py LANGUAGES; profiles/local/unparsed-languages.json; catalog/*.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page says which computers Niro runs on, which languages it reads, and how much of each language's libraries it recognises. Each language has its own page with the full list.
+
+## Computers
+
+- **macOS and Linux**, on Intel (x64) and ARM (arm64) processors.
+<!-- source: niro-cli src/lib/engine.js:79-90 (engine labels macos-x86_64, macos-arm64, linux-x86_64, linux-arm64) -->
+- **Windows:** supported. The details are coming.
+<!-- source: Niraj, 2026-11-10 -->
+- **Node.js 18 or newer** runs the `niro` command.
+<!-- source: niro-cli src/lib/machineCheck.js:13 (MIN_NODE_MAJOR) -->
+- **Disk:** `niro start` warns when less than 2 GB is free, because a large repository's graph can need more.
+<!-- source: niro-cli src/lib/machineCheck.js:14 (LOW_DISK_BYTES); src/commands/start.js:175 -->
+
+## Languages Niro reads
+
+Niro reads a file when its ending (its extension) is one of these:
+
+| Language | File endings |
+|---|---|
+| Java | `.java` |
+| JavaScript | `.js` `.jsx` `.mjs` `.cjs` `.html` `.htm` `.vue` `.svelte` |
+| TypeScript | `.ts` `.mts` `.cts` `.astro` |
+| TSX | `.tsx` |
+| Python | `.py` `.pyw` `.pyi` |
+| C# | `.cs` `.csx` |
+| Kotlin | `.kt` `.kts` |
+| Go | `.go` |
+| PHP | `.php` `.phtml` `.php3` `.php4` `.php5` |
+| Ruby | `.rb` `.rake` `.gemspec` |
+| Swift | `.swift` |
+| Rust | `.rs` |
+| C | `.c` `.h` |
+| C++ | `.cpp` `.cc` `.cxx` `.hpp` `.hxx` `.h++` `.c++` `.hh` `.tcc` `.ipp` `.inl` `.tpp` |
+<!-- source: niro-local src/niro_local/languages.py LANGUAGES -->
+
+Notes on the table:
+
+- In `.html` and `.htm` files, and in `.vue` and `.svelte` components, Niro reads only the script blocks inside the page.
+<!-- source: niro-local src/niro_local/languages.py, the comment above the javascript entry ("only the page's inline script blocks are read") -->
+- A `.h` header that holds C++ is read as C++, not as C.
+<!-- source: niro-local src/niro_local/languages.py, the comment above the c entry -->
+
+## Languages Niro counts but does not read
+
+Niro has no reader for these. It counts their files, and says so in a build's summary and in `get_index_status`, but nothing in them reaches the graph.
+
+| File ending | Language |
+|---|---|
+| `.fs` | F# |
+| `.fsi` | F# |
+| `.fsx` | F# |
+| `.vb` | Visual Basic |
+<!-- source: niro-local src/niro_local/profiles/local/unparsed-languages.json -->
+
+## Libraries recognised, per language
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+| Language | Libraries supported | Partly | Not yet | Full list |
+|---|---|---|---|---|
+| C | 13 | 4 | 34 | [supported-c.md](supported-c.md) |
+| C++ | 24 | 6 | 48 | [supported-cpp.md](supported-cpp.md) |
+| C# | 61 | 25 | 36 | [supported-csharp.md](supported-csharp.md) |
+| Go | 72 | 36 | 61 | [supported-go.md](supported-go.md) |
+| Java | 108 | 19 | 17 | [supported-java.md](supported-java.md) |
+| JavaScript | 95 | 28 | 18 | [supported-javascript.md](supported-javascript.md) |
+| Kotlin | 27 | 5 | 10 | [supported-kotlin.md](supported-kotlin.md) |
+| PHP | 41 | 18 | 19 | [supported-php.md](supported-php.md) |
+| Python | 91 | 28 | 26 | [supported-python.md](supported-python.md) |
+| Ruby | 34 | 25 | 24 | [supported-ruby.md](supported-ruby.md) |
+| Rust | 38 | 11 | 19 | [supported-rust.md](supported-rust.md) |
+| Swift | 21 | 10 | 20 | [supported-swift.md](supported-swift.md) |
+| TypeScript | 82 | 17 | 32 | [supported-typescript.md](supported-typescript.md) |
+
+PowerShell has one entry in the test catalog and no reader, so it has no page.
+<!-- source: catalog/powershell.json (1 row, pending) -->

package/docs/supported-php.md

@@ -0,0 +1,157 @@
+# Supported in PHP
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: catalog/php.json; catalog/php.structure.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page lists the PHP libraries, frameworks and build tools Niro was tested against, and whether it recognised each one.
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+## Web frameworks and HTTP servers (the routes your code serves)
+
+6 supported, 2 partly, 8 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| api-platform/core | not yet | no: #[ApiResource(operations: [new Get(), new GetCollection(), new Post()])] on an entity |
+| cakephp/cakephp | not yet | no: config/routes.php: $builder->connect(path, [controller, action]), ->get, ->resources |
+| codeigniter4/framework | not yet | no: app/Config/Routes.php: $routes->get('vendors', 'Vendors::index'), group, resource |
+| laminas/laminas-mvc | not yet | no: module.config.php router routes with type Literal and 'route' => path |
+| Laravel Folio | supported | yes: resources/views/pages/<path>.blade.php is a GET route at /<path>; nested folders nest the path<br>yes: index.blade.php is the root of its folder: pages/index.blade.php -> /, pages/plants/index.blade.php -> /plants<br>yes: a bracketed file name is a path parameter: [id], a model binding [Plant], or a keyed binding [Plant:slug] (on Windows [Plant-slug])<br>yes: [...name].blade.php captures several segments<br>yes: Folio::path(resource_path('views/<folder>'))->uri('/prefix') in a service provider mounts another pages folder under a prefix |
+| laravel/framework | partly | yes: Route::get(path, closure) in routes/web.php<br>yes: Route::post(path, [Controller::class, 'method'])<br>yes: Route::put(path, 'Controller@method') legacy string<br>yes: Route::prefix('admin')->group(closure)<br>no: Route::resource(name, Controller::class) expands to seven routes<br>yes: routes/api.php served under /api by the framework<br>yes: Route::match(['get','post'], path, handler) |
+| laravel/lumen-framework | not yet | no: $router->get(path, 'Controller@method') in routes/web.php<br>no: $router->group(['prefix' => 'v2'], closure) |
+| league/route | supported | yes: $router->map('GET', path, [Controller::class, 'm']) and ->group |
+| mezzio/mezzio | supported | yes: config/routes.php: $app->get(path, Handler::class) and ->route(path, H, [verbs]) |
+| nikic/fast-route | supported | yes: $r->addRoute('GET', path, handler) in simpleDispatcher<br>yes: $r->get(path) and $r->addGroup(prefix, closure) |
+| slim/slim | supported | yes: $app->get(path, closure)<br>yes: $app->group(prefix, fn (RouteCollectorProxy $group) => $group->post(...))<br>yes: $app->map(['GET','POST'], path, closure) |
+| spatie/laravel-route-attributes | supported | yes: #[Prefix] on class, #[Get]/#[Post] on methods |
+| symfony/routing | partly | yes: #[Route(path, methods: [...])] on a controller method<br>yes: class-level #[Route('/catalog')] prefixes every method route<br>no: legacy docblock @Route("/path", methods={"GET"})<br>no: config/routes.yaml path + controller + methods |
+| WordPress admin-ajax | not yet | no: add_action('wp_ajax_shop_refund', fn) served at POST /wp-admin/admin-ajax.php?action=shop_refund |
+| WordPress REST API | not yet | no: register_rest_route(namespace, path, ['methods' => 'GET', 'callback' => fn]) on rest_api_init |
+| yiisoft/yii2 | not yet | no: config urlManager rules 'GET loyalty' => 'loyalty/index' |
+
+## The language's own HTTP server
+
+1 supported, 1 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| PHP built-in ($_SERVER) | not yet | no: front controller: if on REQUEST_METHOD and parse_url(REQUEST_URI) path<br>no: switch ($path) { case '/health': ... }<br>no: preg_match('#^/receipts/(\d+)$#', $path) for a path parameter |
+| PHP built-in (web server maps files) | partly | partly: one script per path: public/api/coupons.php checks REQUEST_METHOD |
+| PHP built-in server / any document-root web server | supported | yes: <docroot>/<path>/index.php answers /<path>/ (a request that names no file gets the folder's index.php); the docroot comes from php -S -t, a Dockerfile or the web server config |
+
+## HTTP client libraries (the calls your code makes to other services)
+
+3 supported, 4 partly, 2 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| guzzlehttp/guzzle | partly | yes: new Client(['base_uri' => ...]) then $client->get(relative path)<br>yes: $client->request('POST', absolute url, options)<br>yes: $client->getAsync(url)->wait()<br>no: $client->send(new Request('DELETE', url))<br>yes: ClientInterface injected into a typed property, $this->http->post(url)<br>partly: base_uri read from getenv() set in docker-compose<br>yes: $client->requestAsync('GET', url) |
+| kriswallsmith/buzz | supported | yes: $browser->get(url) on Buzz\Browser |
+| laravel/framework (Http facade) | partly | yes: Http::get(absolute url)<br>partly: Http::withToken($t)->post(url) and other option chains<br>partly: Http::baseUrl(config('services.x.url'))->get(path), config from env()<br>no: Http::pool(fn (Pool $pool) => [$pool->get(url), ...]) |
+| psr/http-client (PSR-18) | not yet | no: $client->sendRequest($factory->createRequest('GET', url)) |
+| rmccue/requests | supported | yes: WpOrg\Requests\Requests::get(url) and ::post(url, headers, data) |
+| saloonphp/saloon | not yet | no: Connector::resolveBaseUrl() plus Request $method and resolveEndpoint() |
+| several (main project) | supported | yes: main calls a server in each framework through a different client form |
+| symfony/http-client | partly | yes: HttpClient::create()->request('GET', url)<br>yes: HttpClientInterface injected, $this->client->request('POST', url)<br>yes: HttpClient::createForBaseUri(base)->request('GET', path)<br>partly: scoped client base_uri in framework.yaml, injected by name |
+| WordPress HTTP API | partly | partly: wp_remote_get(url), wp_remote_post(url, args), wp_remote_request(url, ['method' => ...]) |
+
+## The language's own HTTP client
+
+1 supported, 1 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| ext-curl | partly | yes: curl_init(url) then curl_exec<br>partly: curl_init() then curl_setopt($ch, CURLOPT_URL, url) and CURLOPT_POST<br>no: curl_setopt_array($ch, [CURLOPT_URL => url, CURLOPT_CUSTOMREQUEST => 'PATCH'])<br>yes: curl_multi_add_handle with handles from curl_init(url) |
+| PHP streams (allow_url_fopen) | supported | yes: file_get_contents(absolute url)<br>yes: file_get_contents(url, false, stream_context_create(['http' => ['method' => 'POST']]))<br>yes: fopen(url, 'r') then stream_get_contents |
+
+## gRPC
+
+2 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| grpc/grpc | supported | yes: new {S}Client($addr, ['credentials' => ...]) then $client->PlaceOrder($req)->wait()<br>yes: $call = $client->ListOrders($req); foreach ($call->responses() as $x)<br>yes: hand-written BaseStub subclass calling $this->_simpleRequest('/pkg.S/M', ...) |
+| spiral/roadrunner-grpc | supported | yes: class X implements {S}Interface, registered with $server->registerService({S}Interface::class, new X()) |
+
+## Databases and data stores
+
+13 supported, 4 partly, 3 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| aws/aws-sdk-php (DynamoDB) | supported | yes: $ddb->putItem(['TableName' => 'carts', ...]) and query |
+| aws/aws-sdk-php (S3) | supported | yes: $s3->putObject(['Bucket' => 'shop-invoices', ...]) and getObject |
+| catfan/medoo | supported | yes: $db->select('newsletters', [...]) and $db->insert('newsletters', [...]) |
+| cycle/orm | not yet | no: #[Entity(table: 'loyalty_points')] and $orm->getRepository(X::class)->findAll() |
+| doctrine/dbal | partly | yes: $conn->executeQuery(sql) and fetchAllAssociative(sql)<br>yes: $conn->insert('stock_moves', [...]) with the table as argument 0<br>no: $conn->createQueryBuilder()->select('*')->from('suppliers') |
+| doctrine/orm | supported | yes: $em->getRepository(Product::class)->findBy([...]) with #[ORM\Table(name: 'products')]<br>yes: $em->persist($product); $em->flush()<br>yes: custom repository createQueryBuilder and createQuery(DQL) |
+| elasticsearch/elasticsearch | supported | yes: $client->index(['index' => 'products', ...]) and search |
+| ext-memcached | supported | yes: $m = new Memcached(); $m->addServer(...); $m->set(key, value) |
+| ext-pgsql (built-in) | supported | yes: pg_query($conn, sql) and pg_query_params($conn, sql, params) |
+| ext-redis (phpredis) | supported | yes: $r = new Redis(); $r->connect('redis', 6379); $r->hSet(...) |
+| illuminate/database (Eloquent) | partly | yes: Order::where(...)->get() on a model with protected $table<br>yes: Order::create($data)<br>yes: model without $table: table is the plural snake case of the class (Coupon -> coupons)<br>no: DB::table('ledger_entries')->insert([...])<br>no: DB::select('SELECT * FROM refunds WHERE ...', [...]) |
+| laminas/laminas-db | supported | yes: new TableGateway('gift_cards', $adapter); $table->select([...]) |
+| laravel/framework (Cache facade) | not yet | no: Cache::put(key, value) and Cache::remember(key, ttl, fn) |
+| laravel/framework (Redis facade) | supported | yes: Redis::incr('visits') |
+| laravel/framework (Storage facade) | supported | yes: Storage::disk('s3')->put(path, contents) |
+| mongodb/mongodb | not yet | no: $client->shop->reviews->insertOne(...) (database and collection as properties)<br>no: $client->selectCollection('shop', 'ratings')->find(...) |
+| mysqli (built-in) | supported | yes: $db = new mysqli(...); $db->query('SELECT * FROM customers')<br>yes: $db->prepare(sql); bind_param; execute<br>yes: mysqli_query($link, sql) procedural form |
+| PDO (built-in) | partly | yes: $pdo->query('SELECT ... FROM orders')<br>no: $stmt = $pdo->prepare(sql); $stmt->execute([...])<br>partly: $pdo->exec('DELETE FROM carts ...')<br>no: new PDO('pgsql:...') then prepare/execute an UPDATE |
+| predis/predis | supported | yes: $redis = new Predis\Client('tcp://redis:6379'); $redis->set(key), get, lpush |
+| several (main project) | partly | partly: main writes tables and topics that services read |
+
+## Messaging and events (queues, topics, streams)
+
+4 supported, 6 partly, 5 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| aws/aws-sdk-php (SNS) | supported | yes: $sns->publish(['TopicArn' => arn, 'Message' => ...]) |
+| aws/aws-sdk-php (SQS) | partly | partly: $sqs->sendMessage(['QueueUrl' => url, ...]) and receiveMessage |
+| bernard/bernard | not yet | no: $producer->produce(new PlainMessage('ResizeImage', [...])) |
+| enqueue/enqueue | not yet | no: $context->createProducer()->send($context->createQueue('audit'), $message) |
+| ext-rdkafka | supported | yes: $producer->newTopic('payments')->produce(RD_KAFKA_PARTITION_UA, 0, $payload)<br>yes: $consumer->subscribe(['payments-settled']) then consume() |
+| google/cloud-pubsub | supported | yes: $pubsub->topic('loyalty-events')->publish([...]) and subscription(...)->pull() |
+| laravel/framework (events) | supported | yes: event(new OrderShipped($order)) helper<br>yes: OrderShipped::dispatch($id) and Event::dispatch(new OrderShipped)<br>yes: Event::listen(OrderShipped::class, [Listener::class, 'handle']) and $listen map |
+| laravel/framework (queues) | not yet | no: SendInvoiceEmail::dispatch($order)->onQueue('emails')<br>no: dispatch(new SendInvoiceEmail($id)) global helper<br>no: Queue::pushOn('emails', new Job)<br>no: class implements ShouldQueue with handle() |
+| pda/pheanstalk | partly | partly: $p->useTube('thumbnails'); $p->put(data) and watch/reserve |
+| php-amqplib/php-amqplib | not yet | no: $channel->basic_publish($msg, 'orders', 'order.created')<br>no: $channel->basic_consume('invoice-requests', '', ..., $callback) in a worker script |
+| php-mqtt/client | partly | partly: $mqtt->publish('devices/scale/weight', ...) and subscribe('devices/+/weight', fn) |
+| predis/predis | partly | partly: $redis->publish('price-changes', ...) and $redis->pubSubLoop()->subscribe('price-changes') |
+| symfony/event-dispatcher | partly | yes: $dispatcher->dispatch(new StockLow($sku), 'stock.low')<br>partly: #[AsEventListener(event: 'stock.low')]<br>partly: EventSubscriberInterface::getSubscribedEvents() returning ['stock.low' => 'onStockLow'] |
+| symfony/messenger | partly | yes: $this->bus->dispatch(new OrderPlaced($id)) on MessageBusInterface<br>partly: #[AsMessageHandler] class with __invoke(OrderPlaced $m)<br>yes: class implements MessageHandlerInterface (before 6.2) |
+| twilio/sdk | not yet | no: $twilio->messages->create($to, ['from' => ..., 'body' => ...]) |
+
+## Build tools and package managers
+
+3 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| composer | supported | yes: one composer.json, PSR-4 src/, public/index.php, tests/, vendor/<br>yes: apps/* require a library from packages/* through a path repository<br>yes: autoload classmap of a lib/ folder (no namespaces) and a files autoload of global functions<br>yes: a console tool: composer.json "bin" names bin/shopctl; no front controller |
+| composer (symplify/monorepo-builder) | supported | yes: root composer.json maps every package namespace and replaces the packages; each package has its own composer.json |
+| none (plain PHP) | supported | yes: plain PHP without Composer: index.php with require_once of lib/*.php and includes/*.inc |
+
+## Project and folder layouts
+
+8 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Drupal | supported | yes: Drupal recommended-project: core in web/core, contrib in web/modules/contrib, own code in web/modules/custom/<m> with a .module hooks file |
+| laravel | supported | yes: a Laravel app: artisan, app/, routes/, bootstrap/cache (generated), storage/framework/views (compiled Blade) |
+| laravel + nwidart/laravel-modules | supported | yes: Modules/<Name>/ each with module.json and composer.json, loaded into one Laravel app |
+| Magento 2 | supported | yes: app/code/<Vendor>/<Module> with registration.php and etc/module.xml; generated/ holds interceptors |
+| PHPUnit, Pest, Codeception, phpspec | supported | yes: a library with tests/Unit (PHPUnit), tests/Feature (Pest), tests/Acceptance (Codeception Cest) and spec/ (phpspec) |
+| symfony | supported | yes: a Symfony app (bin/console, public/index.php) with a local bundle through a path repository; var/cache holds the generated container<br>yes: apps/orders-api (HTTP), apps/billing-worker (bin/console messenger:consume only), packages/shared-kernel |
+| WordPress | supported | yes: a WordPress site: core in wp-includes/ and wp-admin/, own plugin and theme in wp-content/, a third-party plugin beside it |
+| WordPress (roots/bedrock) | supported | yes: Bedrock: composer.json installs core to web/wp and plugins to web/app/plugins; own code in web/app/mu-plugins |