@enjoys/context-engine 1.0.0 → 1.0.2

package/data/commands/sequelize.json

@@ -0,0 +1,342 @@
+{
+  "name": "sequelize",
+  "description": "Sequelize CLI for managing database migrations, models, seeders, and initialization of Sequelize-based Node.js projects",
+  "category": "database-orm",
+  "platforms": ["linux", "macos", "windows"],
+  "shells": ["bash", "zsh", "fish", "powershell"],
+  "subcommands": [
+    {
+      "name": "init",
+      "description": "Initialize a Sequelize project creating config/config.json, models/, migrations/, and seeders/ directories with boilerplate files.",
+      "args": [],
+      "options": [
+        {"name": "--force", "description": "Force overwriting existing files and directories"}
+      ],
+      "examples": [
+        "npx sequelize-cli init",
+        "npx sequelize-cli init --force"
+      ]
+    },
+    {
+      "name": "init:config",
+      "description": "Create the config/config.json file with database connection settings for development, test, and production environments.",
+      "args": [],
+      "options": [
+        {"name": "--config", "description": "Path to config file to create", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli init:config",
+        "npx sequelize-cli init:config --config=src/config/database.json"
+      ]
+    },
+    {
+      "name": "init:migrations",
+      "description": "Create the migrations directory for storing migration files.",
+      "args": [],
+      "options": [
+        {"name": "--migrations-path", "description": "Custom path for the migrations directory", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli init:migrations",
+        "npx sequelize-cli init:migrations --migrations-path=src/db/migrations"
+      ]
+    },
+    {
+      "name": "init:models",
+      "description": "Create the models directory with an index.js file that auto-loads all model definitions.",
+      "args": [],
+      "options": [
+        {"name": "--models-path", "description": "Custom path for the models directory", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli init:models",
+        "npx sequelize-cli init:models --models-path=src/db/models"
+      ]
+    },
+    {
+      "name": "init:seeders",
+      "description": "Create the seeders directory for storing seed data files.",
+      "args": [],
+      "options": [
+        {"name": "--seeders-path", "description": "Custom path for the seeders directory", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli init:seeders",
+        "npx sequelize-cli init:seeders --seeders-path=src/db/seeders"
+      ]
+    },
+    {
+      "name": "db:create",
+      "description": "Create the database specified in the config file for the current environment.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use (development, test, production)", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--charset", "description": "Character set for the database", "type": "string"},
+        {"name": "--collate", "description": "Collation for the database", "type": "string"},
+        {"name": "--encoding", "description": "Encoding for PostgreSQL databases", "type": "string"},
+        {"name": "--url", "description": "Database connection URL (overrides config)", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:create",
+        "npx sequelize-cli db:create --env=test",
+        "npx sequelize-cli db:create --charset=utf8mb4 --collate=utf8mb4_unicode_ci",
+        "npx sequelize-cli db:create --url=postgres://user:pass@localhost:5432/mydb"
+      ]
+    },
+    {
+      "name": "db:drop",
+      "description": "Drop the database specified in the config file for the current environment. WARNING: This destroys all data.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:drop",
+        "npx sequelize-cli db:drop --env=test"
+      ]
+    },
+    {
+      "name": "db:migrate",
+      "description": "Run all pending migrations to update the database schema. Migrations are executed in chronological order.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--migrations-path", "description": "Path to migrations directory", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"},
+        {"name": "--to", "description": "Migrate up to a specific migration file name", "type": "string"},
+        {"name": "--from", "description": "Migrate starting from a specific migration", "type": "string"},
+        {"name": "--debug", "description": "Show debug information and SQL queries"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:migrate",
+        "npx sequelize-cli db:migrate --env=production",
+        "npx sequelize-cli db:migrate --to=20240101000000-create-users.js",
+        "npx sequelize-cli db:migrate --debug"
+      ]
+    },
+    {
+      "name": "db:migrate:undo",
+      "description": "Revert the most recently applied migration. Executes the down() method of the last migration.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--migrations-path", "description": "Path to migrations directory", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"},
+        {"name": "--name", "description": "Name of the specific migration to revert", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:migrate:undo",
+        "npx sequelize-cli db:migrate:undo --name=20240101000000-create-users.js",
+        "npx sequelize-cli db:migrate:undo --env=test"
+      ]
+    },
+    {
+      "name": "db:migrate:undo:all",
+      "description": "Revert all applied migrations, effectively resetting the database schema to its initial state.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--to", "description": "Revert down to a specific migration (keeps that migration applied)", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:migrate:undo:all",
+        "npx sequelize-cli db:migrate:undo:all --to=20240101000000-create-users.js",
+        "npx sequelize-cli db:migrate:undo:all --env=test"
+      ]
+    },
+    {
+      "name": "db:migrate:status",
+      "description": "Show the status of all migrations, indicating which have been applied (up) and which are pending (down).",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--migrations-path", "description": "Path to migrations directory", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:migrate:status",
+        "npx sequelize-cli db:migrate:status --env=production"
+      ]
+    },
+    {
+      "name": "db:seed",
+      "description": "Run a specific seeder file to populate the database with initial or test data.",
+      "args": [],
+      "options": [
+        {"name": "--seed", "description": "Name of the specific seeder file to run", "type": "string"},
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--seeders-path", "description": "Path to seeders directory", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:seed --seed=20240101000000-demo-users.js",
+        "npx sequelize-cli db:seed --seed=20240101000000-demo-users.js --env=test"
+      ]
+    },
+    {
+      "name": "db:seed:all",
+      "description": "Run all seed files to populate the database with data. Seeders are executed in alphabetical order.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--seeders-path", "description": "Path to seeders directory", "type": "string"},
+        {"name": "--url", "description": "Database connection URL", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:seed:all",
+        "npx sequelize-cli db:seed:all --env=test",
+        "npx sequelize-cli db:seed:all --debug"
+      ]
+    },
+    {
+      "name": "db:seed:undo",
+      "description": "Revert the most recently executed seeder file.",
+      "args": [],
+      "options": [
+        {"name": "--seed", "description": "Name of the specific seeder to revert", "type": "string"},
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:seed:undo",
+        "npx sequelize-cli db:seed:undo --seed=20240101000000-demo-users.js"
+      ]
+    },
+    {
+      "name": "db:seed:undo:all",
+      "description": "Revert all seed files, removing all seeded data from the database.",
+      "args": [],
+      "options": [
+        {"name": "--env", "description": "Environment to use", "type": "string"},
+        {"name": "--config", "description": "Path to config file", "type": "string"},
+        {"name": "--debug", "description": "Show debug information"}
+      ],
+      "examples": [
+        "npx sequelize-cli db:seed:undo:all",
+        "npx sequelize-cli db:seed:undo:all --env=test"
+      ]
+    },
+    {
+      "name": "migration:generate",
+      "description": "Generate a new migration file with a timestamp prefix and the specified name.",
+      "args": [],
+      "options": [
+        {"name": "--name", "description": "Name for the migration file", "type": "string"},
+        {"name": "--underscored", "description": "Use snake_case for the migration file name"}
+      ],
+      "examples": [
+        "npx sequelize-cli migration:generate --name=create-users-table",
+        "npx sequelize-cli migration:generate --name=add-email-to-users --underscored"
+      ]
+    },
+    {
+      "name": "model:generate",
+      "description": "Generate a new model file and its associated migration file. Creates both the model definition and the initial migration to create the table.",
+      "args": [],
+      "options": [
+        {"name": "--name", "description": "Name of the model", "type": "string"},
+        {"name": "--attributes", "description": "Comma-separated list of attribute:type pairs", "type": "string"},
+        {"name": "--force", "description": "Force overwriting existing model file"},
+        {"name": "--underscored", "description": "Use snake_case for table and column names"}
+      ],
+      "examples": [
+        "npx sequelize-cli model:generate --name=User --attributes=firstName:string,lastName:string,email:string",
+        "npx sequelize-cli model:generate --name=Product --attributes=name:string,price:decimal,stock:integer --underscored",
+        "npx sequelize-cli model:generate --name=Order --attributes=userId:integer,total:decimal,status:enum:'{pending,shipped,delivered}'"
+      ]
+    },
+    {
+      "name": "seed:generate",
+      "description": "Generate a new seed file with a timestamp prefix for populating the database with test or initial data.",
+      "args": [],
+      "options": [
+        {"name": "--name", "description": "Name for the seed file", "type": "string"},
+        {"name": "--underscored", "description": "Use snake_case for the seed file name"}
+      ],
+      "examples": [
+        "npx sequelize-cli seed:generate --name=demo-users",
+        "npx sequelize-cli seed:generate --name=initial-products --underscored"
+      ]
+    }
+  ],
+  "globalOptions": [
+    {"name": "--help", "short": "-h", "description": "Show help information"},
+    {"name": "--version", "description": "Show sequelize-cli version"},
+    {"name": "--env", "description": "The environment to use (default: development)", "type": "string"},
+    {"name": "--config", "description": "Path to JSON config file (default: config/config.json)", "type": "string"},
+    {"name": "--models-path", "description": "Path to models directory (default: models/)", "type": "string"},
+    {"name": "--seeders-path", "description": "Path to seeders directory (default: seeders/)", "type": "string"},
+    {"name": "--migrations-path", "description": "Path to migrations directory (default: migrations/)", "type": "string"},
+    {"name": "--url", "description": "Database connection string URL (overrides config file)", "type": "string"},
+    {"name": "--debug", "description": "Show debug output and SQL queries"},
+    {"name": "--options-path", "description": "Path to a JSON file with additional options", "type": "string"}
+  ],
+  "examples": [
+    "npx sequelize-cli init",
+    "npx sequelize-cli db:create",
+    "npx sequelize-cli model:generate --name=User --attributes=name:string,email:string",
+    "npx sequelize-cli db:migrate",
+    "npx sequelize-cli db:migrate:status",
+    "npx sequelize-cli db:migrate:undo",
+    "npx sequelize-cli db:migrate:undo:all",
+    "npx sequelize-cli seed:generate --name=demo-users",
+    "npx sequelize-cli db:seed:all",
+    "npx sequelize-cli db:seed:undo:all",
+    "npx sequelize-cli db:drop",
+    "npx sequelize-cli migration:generate --name=add-index-to-users"
+  ],
+  "relatedCommands": ["prisma", "typeorm", "node", "mysql", "psql", "npm", "npx"],
+  "contextEngine": {
+    "detectors": [
+      {
+        "name": "sequelize_config_detect",
+        "description": "Detect Sequelize configuration files",
+        "command": "find . -maxdepth 3 -name '.sequelizerc' -o -name 'config.json' -path '*/config/*' 2>/dev/null | head -5",
+        "parser": "lines",
+        "cacheFor": 60
+      },
+      {
+        "name": "sequelize_models_detect",
+        "description": "Detect Sequelize model files",
+        "command": "find . -path '*/models/*.js' -o -path '*/models/*.ts' 2>/dev/null | head -10",
+        "parser": "lines",
+        "cacheFor": 60
+      },
+      {
+        "name": "sequelize_migrations_detect",
+        "description": "Detect Sequelize migration files",
+        "command": "find . -path '*/migrations/*.js' -type f 2>/dev/null | head -10",
+        "parser": "lines",
+        "cacheFor": 30
+      },
+      {
+        "name": "sequelize_seeders_detect",
+        "description": "Detect Sequelize seeder files",
+        "command": "find . -path '*/seeders/*.js' -type f 2>/dev/null | head -10",
+        "parser": "lines",
+        "cacheFor": 30
+      },
+      {
+        "name": "sequelize_package_detect",
+        "description": "Detect sequelize in package.json dependencies",
+        "command": "cat package.json 2>/dev/null | grep -E '\"sequelize(-cli)?\"' | head -3",
+        "parser": "lines",
+        "cacheFor": 60
+      }
+    ]
+  }
+}