ROADMAP.md

Roadmap

Since I forked the project of emmanuelbuah, before adding new features, the very first thing to do is to make a stable version of this fork. The initial state for this fork is v0.9-dev.

Short term goals

My goal with this project is to maintain this repository with a good workflow using CI and unit/integration tests, as well as having ~100% coverage and ensure support for node 8,10,11,12 the latest version of mongodb (currently 4.0), and node-mongodb-native 3.x.

v0.9-dev

• Improve TypeScript & TSlint configuration
• Create documentation using Docsify
• Init CLI app

v1.0.0rc1

• Refactor TS types
• Improve unit tests (to fit with new features)
• Compile library files (including CLI app) using Webpack
• Add the following API methods (#16):
  • .isLocked()
  • .getMigrations()
  • .getConfig()
• Rename log config option to logs to fit with CLI usage
• Implement MongoDB query interface (#15)

v1.0.0rc2

• Add time spent while executing migration for CLI usage (#42)
• Rename getClient() to getDb() to avoid misleading (#30)
• Allow array in iterate method (#39)
• Fix docker:test build exiting with code 0 when errored (#29)
• Init command
• Improve migration organization; see object injection (#55)
• Display a warning when migration up/down function is not an async function (mgdb-migrator/issue#5, see this)
• Rename mongo-interface.ts to query-interface.ts
• Create a license file
• Move src to lib and dist to build
• Rerun command

v1.0.0 (mvp)

• Init monorepo using Lerna with the following packages
• Support for ES6 and Typescript
• Validate command
• Event isteners
• Refactor yargs implementation (#131)
• Create examples (#132)
  • commonjs
  • babel-async-await
  • babel-typescript
  • typescript
  • backup
• Update documentation (guides)
  • Organizing migrations
  • Usage with Typescript
  • Usage with Babel
  • Working with backups

What's next ?

Then, next releases will come with new features and codebase improvements !