Merge pull request #2349 from contentstack/feat/DX-3899

DX - 3899 -  Migration Rewrite to TS

Author: cs-raj

.github/workflows/release.yml

@@ -230,6 +230,10 @@ jobs:
         if: ${{env.release_releaseAll == 'true' || env.release_plugins_migration == 'true'}}
         working-directory: ./packages/contentstack-migration
         run: npm install
+      - name: Compiling Migration
+        if: ${{ steps.migration-installation.conclusion == 'success'  }}
+        working-directory: ./packages/contentstack-migration
+        run: npm run prepack
       - name: Publishing migration
         uses: JS-DevTools/npm-publish@v3
         if: ${{ steps.migration-installation.conclusion == 'success'  }}

.talismanrc

@@ -1,6 +1,6 @@
 fileignoreconfig:
 - filename: package-lock.json
-  checksum: 9bc80890e9aff310a9288fdc9fbaccb2652594b2e92f95f8b17f5d4a2be45f81
+  checksum: 20001b2b16e2ab8cc8a3ccc30cebb5093c5c63f58e5b5fe64889d260a8d4cc56
 - filename: pnpm-lock.yaml
-  checksum: 70c84ad3ad7bcee1ed18cd49d921bce674c25fa4b20dfacd9dc3bd5a20ecee6b
+  checksum: c2982bbd478bd9aabcc12bc162d2a76e2635d70023674a677dea996a8671e9ab
 version: '1.0'

package-lock.json

@@ -5,4 +5,6 @@
 /tmp
 /yarn.lock
 node_modules
-.nyc_output
+.nyc_output
+/lib
+tsconfig.tsbuildinfo

packages/contentstack-migration/.gitignore

@@ -0,0 +1,8 @@
+{
+  "require": ["test/helpers/init.js", "ts-node/register", "source-map-support/register"],
+  "watch-extensions": [
+    "ts"
+  ],
+  "recursive": true,
+  "timeout": 5000
+}

packages/contentstack-migration/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "inlcude": [
+      "lib/**/*.js"
+  ]
+}

packages/contentstack-migration/.nycrc.json

@@ -34,7 +34,7 @@ module.exports = async ({ migration, config }) => {
         if (masterLocale) {
           masterLocale = JSON.parse(masterLocale);
           masterLocale = Object.values(masterLocale);
-          masterLocale = masterLocale[0]?.code;
+          masterLocale = masterLocale[0]
 
           // Validate that we have a valid master locale code
           if (!masterLocale) {

packages/contentstack-migration/examples/change-master-locale/02-change-master-locale-new-file-structure.js

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.10.3",
+  "version": "1.11.0",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -18,39 +18,49 @@
   },
   "devDependencies": {
     "@oclif/test": "^4.1.13",
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^14.18.63",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^6.0.62",
     "jsdoc-to-markdown": "^8.0.3",
+    "mocha": "^10.8.2",
     "nock": "^13.5.6",
     "nyc": "^15.1.0",
-    "oclif": "^4.17.46"
+    "oclif": "^4.17.46",
+    "sinon": "^19.0.5",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
   },
   "engines": {
     "node": ">=8.3.0"
   },
   "files": [
+    "/lib",
     "/npm-shrinkwrap.json",
-    "/oclif.manifest.json",
-    "/src",
-    "/yarn.lock"
+    "/oclif.manifest.json"
   ],
   "homepage": "https://github.com/contentstack/cli",
   "keywords": [
     "oclif-plugin"
   ],
   "license": "MIT",
   "oclif": {
-    "commands": "./src/commands",
+    "commands": "./lib/commands",
     "bin": "csdx",
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-migration/<%- commandPath %>"
   },
   "repository": "contentstack/cli",
   "scripts": {
     "postpack": "rm -f oclif.manifest.json",
-    "generate-api-ref-md-doc": "nyc jsdoc2md ./src/modules/* > ./docs/api-reference.md",
-    "prepack": "oclif manifest && oclif readme && pnpm generate-api-ref-md-doc",
-    "test": "nyc mocha --timeout 3000 \"test/**/*.test.js\"",
+    "generate-api-ref-md-doc": "nyc jsdoc2md ./src/modules/*.ts > ./docs/api-reference.md || true",
+    "compile": "tsc -b tsconfig.json",
+    "prepack": "pnpm compile && oclif manifest && oclif readme",
+    "pretest": "tsc -p test",
+    "test": "mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
     "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },

packages/contentstack-migration/package.json

@@ -1,21 +1,27 @@
 /* eslint-disable no-unused-expressions */
-'use strict';
+export default class ActionList {
+  typeErrors?: any;
+  actionList?: any[];
+  validators: any[];
 
-class ActionList {
-  constructor(actionList, typeErrors) {
+  constructor(actionList?: any[], typeErrors?: any) {
     typeErrors && (this.typeErrors = typeErrors);
     actionList && (this.actionList = actionList);
     this.validators = [];
   }
 
-  addValidators(validator) {
+  addValidators(validator: any): void {
     this.validators.push(validator);
   }
 
-  validate() {
+  validate(): any[] {
     const { validators, actionList } = this;
 
-    let errors = [];
+    if (!actionList) {
+      return [];
+    }
+
+    let errors: any[] = [];
     for (const action of actionList) {
       for (const validator of validators) {
         if (validator.isApplicable(action)) {
@@ -28,5 +34,3 @@ class ActionList {
     return errors;
   }
 }
-
-module.exports = ActionList;

…ack-migration/src/actions/action-list.js …ack-migration/src/actions/action-list.tspackages/contentstack-migration/src/actions/action-list.js renamed to packages/contentstack-migration/src/actions/action-list.ts packages/contentstack-migration/src/actions/action-list.js renamed to packages/contentstack-migration/src/actions/action-list.ts

@@ -1,7 +1,5 @@
-'use strict';
-
 // Utils
-const { constants } = require('../utils');
+import { constants } from '../utils';
 // Properties
 const { actions, validationAction } = constants;
 const {
@@ -18,8 +16,8 @@ const {
   field,
 } = validationAction;
 
-const actionCreators = {
-  customTasks: (callsite, opts) => {
+export const actionCreators = {
+  customTasks: (callsite: any, opts: any) => {
     const { CUSTOM_TASK } = actions;
     return {
       type: customTask,
@@ -36,7 +34,7 @@ const actionCreators = {
     };
   },
   contentType: {
-    create: (callsite, id, opts) => {
+    create: (callsite: any, id: string, opts: any) => {
       const { CREATE_CT } = actions;
       return {
         type: create,
@@ -53,7 +51,7 @@ const actionCreators = {
         },
       };
     },
-    edit: (callsite, id, opts) => {
+    edit: (callsite: any, id: string, opts: any) => {
       const { EDIT_CT } = actions;
 
       return {
@@ -72,7 +70,7 @@ const actionCreators = {
       };
     },
     // delete: () => { },
-    transformEntries: (callsite, id, opts) => {
+    transformEntries: (callsite: any, id: string, opts: any) => {
       return {
         type: transformEntries,
         meta: {
@@ -86,7 +84,7 @@ const actionCreators = {
         },
       };
     },
-    deriveLinkedEntries: (callsite, id, opts) => {
+    deriveLinkedEntries: (callsite: any, id: string, opts: any) => {
       return {
         type: deriveLinkedEntries,
         meta: {
@@ -100,7 +98,7 @@ const actionCreators = {
         },
       };
     },
-    transformEntriesToType: (callsite, id, opts) => {
+    transformEntriesToType: (callsite: any, id: string, opts: any) => {
       return {
         type: transformEntriesToType,
         meta: {
@@ -114,7 +112,7 @@ const actionCreators = {
         },
       };
     },
-    typeError: (callsite, id, { typeErrors }) => {
+    typeError: (callsite: any, id: string, { typeErrors }: { typeErrors: any }) => {
       return {
         type: typeError,
         meta: {
@@ -126,7 +124,7 @@ const actionCreators = {
         payload: { typeErrors },
       };
     },
-    apiError: (callsite, id, opts) => {
+    apiError: (callsite: any, id: string, opts: any) => {
       return {
         type: apiError,
         meta: {
@@ -138,7 +136,7 @@ const actionCreators = {
         payload: { apiError: opts },
       };
     },
-    fromFields: (callsite, id, opts) => {
+    fromFields: (callsite: any, id: string, opts: any) => {
       return {
         type: schema,
         meta: {
@@ -150,7 +148,7 @@ const actionCreators = {
         payload: { fromField: opts.fromField },
       };
     },
-    toFields: (callsite, id, opts) => {
+    toFields: (callsite: any, id: string, opts: any) => {
       return {
         type: schema,
         meta: {
@@ -162,7 +160,7 @@ const actionCreators = {
         payload: { toField: opts.toField },
       };
     },
-    toReferenceFields: (callsite, id, opts) => {
+    toReferenceFields: (callsite: any, id: string, opts: any) => {
       return {
         type: schema,
         meta: {
@@ -174,7 +172,7 @@ const actionCreators = {
         payload: { toField: opts.toReferenceField },
       };
     },
-    deriveFields: (callsite, id, opts) => {
+    deriveFields: (callsite: any, id: string, opts: any) => {
       return {
         type: schema,
         meta: {
@@ -186,7 +184,7 @@ const actionCreators = {
         payload: { deriveField: opts.deriveField },
       };
     },
-    migrationError: (callsite, id, opts) => {
+    migrationError: (callsite: any, id: string, opts: any) => {
       return {
         type: __migrationError,
         meta: {
@@ -198,7 +196,7 @@ const actionCreators = {
         payload: { migrationError: opts },
       };
     },
-    field: (callsite, id, opts) => {
+    field: (callsite: any, id: string, opts: any) => {
       return {
         type: field,
         meta: {
@@ -213,5 +211,4 @@ const actionCreators = {
   },
 };
 
-exports.actionCreators = actionCreators;
-exports.ActionList = require('./action-list');
+export { default as ActionList } from './action-list';