{"_id":"@adocasts.com/generate-models","_rev":"3-e47873643878f7a9771fe27749fea09c","name":"@adocasts.com/generate-models","dist-tags":{"latest":"0.1.0-4.dev"},"versions":{"0.1.0-1.dev":{"name":"@adocasts.com/generate-models","version":"0.1.0-1.dev","keywords":["adonisjs","lucid","model","generate"],"author":{"name":"tomgobich,adocasts.com"},"license":"MIT","_id":"@adocasts.com/generate-models@0.1.0-1.dev","maintainers":[{"name":"tomgobich","email":"tom@tomgobich.com"}],"homepage":"https://github.com/adocasts/generate-models#readme","bugs":{"url":"https://github.com/adocasts/generate-models/issues"},"c8":{"exclude":["tests/**"],"reporter":["text","html"]},"np":{"tag":"latest","branch":"main","message":"chore(release): %s","anyBranch":false},"dist":{"shasum":"579685aba93d3c3f5bf327b4b67cb19dea47984b","tarball":"https://registry.npmjs.org/@adocasts.com/generate-models/-/generate-models-0.1.0-1.dev.tgz","fileCount":29,"integrity":"sha512-oua+0gT0qZCgb3e/f82b1UzpWpgJIdaZfoUo8fqLDpHZt8/eUsRGoiAJPwZz63mmxKj2einkVvUMsNvvCfuGQw==","signatures":[{"sig":"MEUCIQDzns/1CpuHZluNHtaWDJ0Pxlxmr7Uef2kkcVYXD3mtJwIgBoZSOWXdvYay4uLEX2V8NO3CKHPmuyClGvScv3JnFhc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33673},"type":"module","engines":{"node":">=20.6.0"},"exports":{".":"./build/index.js","./types":"./build/src/types.js","./commands":"./build/commands/main.js"},"gitHead":"a098b0777bf38aaddcc93ff88600859f674ea7e0","scripts":{"lint":"eslint .","test":"c8 npm run quick:test","build":"tsc","clean":"del-cli build","format":"prettier --write .","pretest":"npm run lint","release":"np","version":"npm run build","prebuild":"npm run clean","postbuild":"npm run copy:templates && npm run index:commands","typecheck":"tsc --noEmit","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","copy:templates":"copyfiles \"stubs/**/*.stub\" build","index:commands":"adonis-kit index build/commands","prepublishOnly":"npm run build"},"_npmUser":{"name":"tomgobich","email":"tom@tomgobich.com"},"prettier":"@adonisjs/prettier-config","repository":{"url":"git+https://github.com/adocasts/generate-models.git","type":"git"},"_npmVersion":"10.7.0","description":"Generate Lucid Models from an existing database schema","directories":{},"_nodeVersion":"20.14.0","publishConfig":{"tag":"latest","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"c8":"^10.1.2","np":"^10.0.7","eslint":"^9.10.0","del-cli":"^5.1.0","ts-node":"^10.9.2","prettier":"^3.3.3","@swc/core":"^1.7.26","copyfiles":"^2.4.1","typescript":"^5.6.2","@types/node":"^22.5.5","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0","@adonisjs/tsconfig":"^1.4.0","ts-node-maintained":"^10.9.4","@adonisjs/assembler":"^7.8.2","knex-schema-inspector":"^3.1.0","@adonisjs/eslint-config":"^2.0.0-beta.6","@adonisjs/prettier-config":"^1.4.0"},"peerDependencies":{"@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0"},"_npmOperationalInternal":{"tmp":"tmp/generate-models_0.1.0-1.dev_1726701096232_0.42748658216315194","host":"s3://npm-registry-packages"}},"0.1.0-2.dev":{"name":"@adocasts.com/generate-models","version":"0.1.0-2.dev","keywords":["adonisjs","lucid","model","generate"],"author":{"name":"tomgobich,adocasts.com"},"license":"MIT","_id":"@adocasts.com/generate-models@0.1.0-2.dev","maintainers":[{"name":"tomgobich","email":"tom@tomgobich.com"}],"homepage":"https://github.com/adocasts/generate-models#readme","bugs":{"url":"https://github.com/adocasts/generate-models/issues"},"c8":{"exclude":["tests/**"],"reporter":["text","html"]},"np":{"tag":"latest","branch":"main","message":"chore(release): %s","anyBranch":false},"dist":{"shasum":"75318906b5817c398117b7b3df92a68697215a65","tarball":"https://registry.npmjs.org/@adocasts.com/generate-models/-/generate-models-0.1.0-2.dev.tgz","fileCount":29,"integrity":"sha512-Vs03LFOuYrpChGCAbNTo1DMCrM6Oz76QTeQgBXN3i7pxXnTugtrSLR9TTFnd4XAuj8CRvnSmBdYDaEn765EUYw==","signatures":[{"sig":"MEUCIHf87Y4pFvc3V/hmjscO5jt6MvgJ336FrmMe/DtFU5kfAiEAk/YFJpSU9X28IKs81mo4u3m9nPLn7UQ4NfLk5hboVlI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33871},"type":"module","engines":{"node":">=20.6.0"},"exports":{".":"./build/index.js","./types":"./build/src/types.js","./commands":"./build/commands/main.js"},"gitHead":"b762de849b1b1824efb7e61b6a8a601053b4dabe","scripts":{"lint":"eslint .","test":"c8 npm run quick:test","build":"tsc","clean":"del-cli build","format":"prettier --write .","pretest":"npm run lint","release":"np","version":"npm run build","prebuild":"npm run clean","postbuild":"npm run copy:templates && npm run index:commands","typecheck":"tsc --noEmit","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","copy:templates":"copyfiles \"stubs/**/*.stub\" build","index:commands":"adonis-kit index build/commands","prepublishOnly":"npm run build"},"_npmUser":{"name":"tomgobich","email":"tom@tomgobich.com"},"prettier":"@adonisjs/prettier-config","repository":{"url":"git+https://github.com/adocasts/generate-models.git","type":"git"},"_npmVersion":"10.7.0","description":"Generate Lucid Models from an existing database schema","directories":{},"_nodeVersion":"20.14.0","dependencies":{"knex-schema-inspector":"^3.1.0"},"publishConfig":{"tag":"latest","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"c8":"^10.1.2","np":"^10.0.7","eslint":"^9.10.0","del-cli":"^5.1.0","ts-node":"^10.9.2","prettier":"^3.3.3","@swc/core":"^1.7.26","copyfiles":"^2.4.1","typescript":"^5.6.2","@types/node":"^22.5.5","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0","@adonisjs/tsconfig":"^1.4.0","ts-node-maintained":"^10.9.4","@adonisjs/assembler":"^7.8.2","@adonisjs/eslint-config":"^2.0.0-beta.6","@adonisjs/prettier-config":"^1.4.0"},"peerDependencies":{"@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0"},"_npmOperationalInternal":{"tmp":"tmp/generate-models_0.1.0-2.dev_1726701674151_0.1776039713665165","host":"s3://npm-registry-packages"}},"0.1.0-3.dev":{"name":"@adocasts.com/generate-models","version":"0.1.0-3.dev","keywords":["adonisjs","lucid","model","generate"],"author":{"name":"tomgobich,adocasts.com"},"license":"MIT","_id":"@adocasts.com/generate-models@0.1.0-3.dev","maintainers":[{"name":"tomgobich","email":"tom@tomgobich.com"}],"homepage":"https://github.com/adocasts/generate-models#readme","bugs":{"url":"https://github.com/adocasts/generate-models/issues"},"c8":{"exclude":["tests/**"],"reporter":["text","html"]},"np":{"tag":"latest","branch":"main","message":"chore(release): %s","anyBranch":false},"dist":{"shasum":"6374b6a116dee4a1889bc6af5ad2e88a617baa20","tarball":"https://registry.npmjs.org/@adocasts.com/generate-models/-/generate-models-0.1.0-3.dev.tgz","fileCount":29,"integrity":"sha512-nUWfvOAuvWkt1GHtHV6HoRNHPdXLcrLmTtDZLHclfxO3ZInXNSdRok7n1zgbk9Cfc1h/MG/s2uuPFh46jn4JHA==","signatures":[{"sig":"MEQCIEg9AxyVLKrod9PAEu6+OPEIzm+2sHSvBMPz64cilDReAiAuZzws2scP7w5ixND97045uUDU9rRkx65Bg1VlaoYbbQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33863},"type":"module","engines":{"node":">=20.6.0"},"exports":{".":"./build/index.js","./types":"./build/src/types.js","./commands":"./build/commands/main.js"},"gitHead":"137cc079e053357f16c06dcd0b2cc5c6eaeeb3df","scripts":{"lint":"eslint .","test":"c8 npm run quick:test","build":"tsc","clean":"del-cli build","format":"prettier --write .","pretest":"npm run lint","release":"np","version":"npm run build","prebuild":"npm run clean","postbuild":"npm run copy:templates && npm run index:commands","typecheck":"tsc --noEmit","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","copy:templates":"copyfiles \"stubs/**/*.stub\" build","index:commands":"adonis-kit index build/commands","prepublishOnly":"npm run build"},"_npmUser":{"name":"tomgobich","email":"tom@tomgobich.com"},"prettier":"@adonisjs/prettier-config","repository":{"url":"git+https://github.com/adocasts/generate-models.git","type":"git"},"_npmVersion":"10.7.0","description":"Generate Lucid Models from an existing database schema","directories":{},"_nodeVersion":"20.14.0","dependencies":{"knex-schema-inspector":"^3.1.0"},"publishConfig":{"tag":"latest","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"c8":"^10.1.2","np":"^10.0.7","eslint":"^9.10.0","del-cli":"^5.1.0","ts-node":"^10.9.2","prettier":"^3.3.3","@swc/core":"^1.7.26","copyfiles":"^2.4.1","typescript":"^5.6.2","@types/node":"^22.5.5","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0","@adonisjs/tsconfig":"^1.4.0","ts-node-maintained":"^10.9.4","@adonisjs/assembler":"^7.8.2","@adonisjs/eslint-config":"^2.0.0-beta.6","@adonisjs/prettier-config":"^1.4.0"},"peerDependencies":{"@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0"},"_npmOperationalInternal":{"tmp":"tmp/generate-models_0.1.0-3.dev_1726702084829_0.0938596648689698","host":"s3://npm-registry-packages"}},"0.1.0-4.dev":{"name":"@adocasts.com/generate-models","description":"Generate Lucid Models from an existing database schema","version":"0.1.0-4.dev","engines":{"node":">=20.6.0"},"type":"module","exports":{".":"./build/index.js","./commands":"./build/commands/main.js","./types":"./build/src/types.js"},"scripts":{"clean":"del-cli build","copy:templates":"copyfiles \"stubs/**/*.stub\" build","typecheck":"tsc --noEmit","lint":"eslint .","format":"prettier --write .","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","pretest":"npm run lint","test":"c8 npm run quick:test","prebuild":"npm run clean","build":"tsc","postbuild":"npm run copy:templates && npm run index:commands","index:commands":"adonis-kit index build/commands","release":"np","version":"npm run build","prepublishOnly":"npm run build"},"dependencies":{"knex-schema-inspector":"^3.1.0"},"devDependencies":{"@adonisjs/assembler":"^7.8.2","@adonisjs/core":"^6.13.1","@adonisjs/eslint-config":"^2.0.0-beta.6","@adonisjs/lucid":"^21.2.0","@adonisjs/prettier-config":"^1.4.0","@adonisjs/tsconfig":"^1.4.0","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@swc/core":"^1.7.26","@types/node":"^22.5.5","c8":"^10.1.2","copyfiles":"^2.4.1","del-cli":"^5.1.0","eslint":"^9.10.0","np":"^10.0.7","prettier":"^3.3.3","ts-node":"^10.9.2","ts-node-maintained":"^10.9.4","typescript":"^5.6.2"},"peerDependencies":{"@adonisjs/core":"^6.13.1","@adonisjs/lucid":"^21.2.0"},"author":{"name":"tomgobich,adocasts.com"},"license":"MIT","keywords":["adonisjs","lucid","model","generate"],"homepage":"https://github.com/adocasts/generate-models#readme","repository":{"type":"git","url":"git+https://github.com/adocasts/generate-models.git"},"bugs":{"url":"https://github.com/adocasts/generate-models/issues"},"prettier":"@adonisjs/prettier-config","publishConfig":{"access":"public","tag":"latest"},"np":{"message":"chore(release): %s","tag":"latest","branch":"main","anyBranch":false},"c8":{"reporter":["text","html"],"exclude":["tests/**"]},"_id":"@adocasts.com/generate-models@0.1.0-4.dev","gitHead":"8a1c7f6d3f3c8933fa9d7f94bed985aca8390ba9","_nodeVersion":"20.14.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-DmbcJVg7zJL5BitsmDcmuaDUQM4xXObwz0fHpCAVzVLYvaIiB/W5zEtqj8S/qmer1II95LE/nc4GbCwgyiD1FA==","shasum":"0a022617849a85c6997c8f30f769f5caf8997c69","tarball":"https://registry.npmjs.org/@adocasts.com/generate-models/-/generate-models-0.1.0-4.dev.tgz","fileCount":29,"unpackedSize":33948,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDSMOUmXMs8j9YfQ3XVo+kaKE5xHFCqsIEQFxIOH85wpwIhAIwlAOX9xeysedd8v2dnUw3VnSoVc+syo+9fEd7y9DSg"}]},"_npmUser":{"name":"tomgobich","email":"tom@tomgobich.com"},"directories":{},"maintainers":[{"name":"tomgobich","email":"tom@tomgobich.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generate-models_0.1.0-4.dev_1726833277747_0.2493454824168797"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-18T23:11:36.136Z","modified":"2024-09-20T11:54:38.069Z","0.1.0-1.dev":"2024-09-18T23:11:36.396Z","0.1.0-2.dev":"2024-09-18T23:21:14.368Z","0.1.0-3.dev":"2024-09-18T23:28:04.989Z","0.1.0-4.dev":"2024-09-20T11:54:37.897Z"},"bugs":{"url":"https://github.com/adocasts/generate-models/issues"},"author":{"name":"tomgobich,adocasts.com"},"license":"MIT","homepage":"https://github.com/adocasts/generate-models#readme","keywords":["adonisjs","lucid","model","generate"],"repository":{"type":"git","url":"git+https://github.com/adocasts/generate-models.git"},"description":"Generate Lucid Models from an existing database schema","maintainers":[{"name":"tomgobich","email":"tom@tomgobich.com"}],"readme":"# @adocasts.com/generate-models\n\n> Generate Lucid Models from an existing database\n\n[![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]\n\nWhether you're looking to start a new AdonisJS project for an existing database or\nyou've define your migrations and ran them, this package can help you get up and running by generating models to match your\ndatabase schema!\n\n> Note that this likely won't be perfect, always be sure to double-check the files after they're generated.\n\nHere's how it works:\n\n1. It'll use AdonisJS to connect to your database\n2. Once connected, it collects your tables, columns, and foreign keys\n3. Then, it'll map out what your models should look like for the tables & columns\n4. Finally, it'll then use your foreign keys to work backwards and build out your relationships\n\nHere's what's required:\n\n1. Your tables, columns, and foreign keys must be defined in your database\n2. Your database must be well structured, deviations will cause anomolies in the generated relationships\n3. Your AdonisJS application must have its database connection defined\n\nRight now, we only have database type to TypeScript type mappings defined for MySQL and PostgreSQL. Unknown column types will default to `unknown` if they cannot be mapped.\n\n## Installation\n\nYou can easily install and configure via the Ace CLI's `add` command.\n\n```shell\nnode ace add @adocasts.com/generate-models\n```\n\n##### Manual Install & Configure\n\nYou can also manually install and configure if you'd prefer\n\n```shell\nnpm install @adocasts.com/generate-models\n```\n\n```shell\nnode ace configure @adocasts.com/generate-models\n```\n\n## Generate Models Command\n\nRight now we only offer one command, and that is the `generate:models` command.\n\n```shell\nnode ace generate:models\n```\n\nThis will generate your models and plop them at the location defined within your `adonisrc.ts` file, which is `app/models` by default.\nIf any of the models already exist in your project, those models will be skipped and will **not** be replaced.\n\n[npm-image]: https://img.shields.io/npm/v/@adocasts.com/generate-models/latest.svg?style=for-the-badge&logo=npm\n[npm-url]: https://www.npmjs.com/package/@adocasts.com/generate-models/v/latest 'npm'\n[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript\n[license-url]: LICENSE.md\n[license-image]: https://img.shields.io/github/license/adocasts/generate-models?style=for-the-badge\n","readmeFilename":"README.md"}