@mikro-orm/seeder 7.0.0-dev.9 → 7.0.0-dev.91

package/README.md

@@ -11,7 +11,6 @@ TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-or
 [![Chat on discord](https://img.shields.io/discord/1214904142443839538?label=discord&color=blue)](https://discord.gg/w8bjxFHS7X)
 [![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
 [![Coverage Status](https://img.shields.io/coveralls/mikro-orm/mikro-orm.svg)](https://coveralls.io/r/mikro-orm/mikro-orm?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/27999651d3adc47cfa40/maintainability)](https://codeclimate.com/github/mikro-orm/mikro-orm/maintainability)
 [![Build Status](https://github.com/mikro-orm/mikro-orm/workflows/tests/badge.svg?branch=master)](https://github.com/mikro-orm/mikro-orm/actions?workflow=tests)
 
 ## 🤔 Unit of What?
@@ -141,7 +140,7 @@ There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit m
 - [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys)
 - [Filters](https://mikro-orm.io/docs/filters)
 - [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
-- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
+- [Populating relations](https://mikro-orm.io/docs/populating-relations)
 - [Property Validation](https://mikro-orm.io/docs/property-validation)
 - [Lifecycle Hooks](https://mikro-orm.io/docs/events#hooks)
 - [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
@@ -382,6 +381,8 @@ See also the list of contributors who [participated](https://github.com/mikro-or
 
 Please ⭐️ this repository if this project helped you!
 
+> If you'd like to support my open-source work, consider sponsoring me directly at [github.com/sponsors/b4nan](https://github.com/sponsors/b4nan).
+
 ## 📝 License
 
 Copyright © 2018 [Martin Adámek](https://github.com/b4nan).

package/SeedManager.d.ts

@@ -7,11 +7,20 @@ export declare class SeedManager implements ISeedManager {
     private readonly absolutePath;
     constructor(em: EntityManager);
     static register(orm: MikroORM): void;
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    private detectSourceFolder;
     seed(...classNames: Constructor<Seeder>[]): Promise<void>;
     /**
      * @internal
      */
     seedString(...classNames: string[]): Promise<void>;
-    createSeeder(className: string): Promise<string>;
+    create(className: string): Promise<string>;
     private generate;
 }

package/SeedManager.js

@@ -1,6 +1,7 @@
 import { Utils, } from '@mikro-orm/core';
+import { fs } from '@mikro-orm/core/fs-utils';
 import { writeFile } from 'node:fs/promises';
-import globby from 'globby';
+import { glob } from 'tinyglobby';
 export class SeedManager {
     em;
     config;
@@ -12,6 +13,7 @@ export class SeedManager {
         this.options = this.config.get('seeder');
         this.em = this.em.fork();
         this.config.set('persistOnCreate', true);
+        this.detectSourceFolder();
         /* v8 ignore next */
         const key = (this.config.get('preferTs', Utils.detectTypeScriptSupport()) && this.options.pathTs) ? 'pathTs' : 'path';
         this.absolutePath = Utils.absolutePath(this.options[key], this.config.get('baseDir'));
@@ -19,6 +21,32 @@ export class SeedManager {
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/seeder', () => new SeedManager(orm.em));
     }
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    detectSourceFolder() {
+        const baseDir = this.config.get('baseDir');
+        const defaultPath = './seeders';
+        if (!fs.pathExists(baseDir + '/src')) {
+            this.options.path ??= defaultPath;
+            return;
+        }
+        const exists = fs.pathExists(`${baseDir}/${defaultPath}`);
+        const distDir = fs.pathExists(baseDir + '/dist');
+        const buildDir = fs.pathExists(baseDir + '/build');
+        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
+        const path = distDir ? './dist' : (buildDir ? './build' : './src');
+        // only if the user did not provide any values and if the default path does not exist
+        if (!this.options.path && !this.options.pathTs && !exists) {
+            this.options.path = `${path}/seeders`;
+            this.options.pathTs = './src/seeders';
+        }
+    }
     async seed(...classNames) {
         for (const SeederClass of classNames) {
             const seeder = new SeederClass();
@@ -32,7 +60,7 @@ export class SeedManager {
      */
     async seedString(...classNames) {
         const path = `${this.absolutePath}/${this.options.glob}`;
-        const files = await globby(path);
+        const files = await glob(path);
         const classMap = new Map();
         for (const path of files) {
             const exports = await Utils.dynamicImport(path);
@@ -48,8 +76,8 @@ export class SeedManager {
             await this.seed(seederClass);
         }
     }
-    async createSeeder(className) {
-        Utils.ensureDir(this.absolutePath);
+    async create(className) {
+        fs.ensureDir(this.absolutePath);
         return this.generate(className);
     }
     async generate(className) {

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@mikro-orm/seeder",
   "type": "module",
-  "version": "7.0.0-dev.9",
+  "version": "7.0.0-dev.91",
   "description": "Seeder package for MikroORM.",
   "exports": {
     "./package.json": "./package.json",
     ".": "./index.js"
   },
-  "typings": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -40,7 +39,7 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 22.11.0"
+    "node": ">= 22.17.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
@@ -52,12 +51,12 @@
     "access": "public"
   },
   "dependencies": {
-    "globby": "11.1.0"
+    "tinyglobby": "0.2.15"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.4.13"
+    "@mikro-orm/core": "^6.6.2"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.9"
+    "@mikro-orm/core": "7.0.0-dev.91"
   }
 }