export query command base code

[shafeeqd959]

Query-based Export Plugin for Contentstack CLI

Overview

Introducing a new plugin for Contentstack CLI that enables query-based content export. This plugin allows users to selectively export content types and their dependencies using MongoDB-style queries, improving the flexibility of content migration and backup processes.

Key Features

• Query-based filtering for content types
• Automatic dependency resolution (global fields, extensions, taxonomies)
• Recursive reference detection and export
• Smart asset reference handling
• Complete dependency chain export

Implementation Details

• Created as a standalone plugin (@contentstack/cli-cm-export-query)
• Leverages existing export command internally with query support
• Focuses on content type queries with automatic dependency resolution
• Implements intelligent reference detection across various field types

Current Scope

✅ Supported:

• Content type query filtering
• Automatic dependency resolution
• Referenced content type export
• Asset reference detection
• Entry export for matched content types

❌ Not Yet Supported:

• Direct queries for other modules (entries, assets)
• Cross-module querying
• Custom reference handling

Usage Examples

# Export content types with "blog" in title
csdx cm:stacks:export-query -a <alias> --query '{"title": {"$regex": "blog"}}'

# Export content types updated after specific date
csdx cm:stacks:export-query -a <alias> --query '{
  "$and": [
    {"title": {"$exists": true}},
    {"updated_at": {"$gte": "2024-01-01"}}
  ]
}'

Testing

• Unit tests added for core functionality
• Integration tests for query processing
• Test coverage for dependency resolution
• Reference handling test cases

Documentation

• Added comprehensive documentation
• Included usage examples
• Documented query format and options
• Added technical architecture details

Future Enhancements

• Query support for other modules
• Cross-module query capabilities
• Enhanced filtering options
• Performance optimizations

Breaking Changes

None - This is a new plugin that doesn't affect existing functionality

Related Issues

Closes #[issue_number]

Checklist

• Tests added/updated
• Documentation updated
• Code follows project style guidelines
• All tests passing
• PR is properly scoped

[netrajpatel]

@shafeeqd959 Can you fix the GH workflow

[Copilot]

Pull Request Overview

This PR introduces a new CLI plugin for query-based exports, including test scaffolding, core export logic, utilities, configuration, and documentation updates.

• Adds test configuration and runner (test/tsconfig.json, test/run.test.js, Mocha configs)
• Implements core query export components (QueryParser, QueryExporter, ModuleExporter) and related utility modules
• Updates CLI command, package manifest, README, and CI workflows

Reviewed Changes

Copilot reviewed 38 out of 46 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
test/tsconfig.json	Adds TypeScript config for tests
test/run.test.js	Implements integration test runner with file inclusion
src/utils/file-helper.ts	Provides file read/write utilities
src/utils/logger.ts	Implements logging with Winston
src/utils/query-parser.ts	Parses and validates JSON queries
src/core/query-executor.ts	Coordinates the query-based export flow
src/core/module-exporter.ts	Wraps the Contentstack export command invocation
src/commands/cm/stacks/export-query.ts	Defines the CLI command entry point
README.md	Documents plugin usage and features
package.json	Declares plugin metadata, dependencies, scripts, and flags
.nycrc.json	Configures coverage reporting (typo)

Comments suppressed due to low confidence (1)

README.md:77

• The path src/config/export-defaults.json does not match the actual file (src/config/export-config.json). Update the documentation to point to the correct file.

The plugin includes a default configuration file at `src/config/export-defaults.json`:

[shafeeqd959]

@shafeeqd959 Can you fix the GH workflow

this workflow will be fixed once we made the repo public