Add TS configuration and NX project for metadata (DevExpress#30193)

Author: IlyaKhD

.github/workflows/wrapper_tests.yml

@@ -99,9 +99,9 @@ jobs:
       - name: Vue - Check packing
         run: pnpx nx pack devextreme-vue
 
-      - name: Archive internal-tools artifacts
+      - name: Archive devextreme-metadata artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: internal-tools-artifacts
-          path: artifacts/internal-tools/
+          name: devextreme-metadata-artifacts
+          path: packages/devextreme-metadata/dist/
           retention-days: 7

.gitignore

@@ -6,6 +6,7 @@ dist
 bin
 obj
 /artifacts
+/packages/metadata/artifacts
 
 # dependencies
 node_modules

nx.json

@@ -2,6 +2,13 @@
   "extends": "nx/presets/npm.json",
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "nxCloudAccessToken": "ZDFmMzkyZTYtZmU5MC00MDMyLWI3NDktYjhhYWUxZWM4YTg3fHJlYWQ=",
+  "namedInputs": {
+    "metadataToolsCommonInputs": [
+      "{projectRoot}/**/*.ts",
+      "{projectRoot}/tsconfig.json",
+      { "externalDependencies": [ "devextreme-internal-tools", "ts-node", "typescript"] }
+    ]
+  },
   "targetDefaults": {
     "build": {
       "dependsOn": [
@@ -20,21 +27,6 @@
       ],
       "cache": true
     },
-    "angular:copy-metadata": {
-      "dependsOn": [
-        "tools:discover-metadata"
-      ]
-    },
-    "react:copy-metadata": {
-      "dependsOn": [
-        "tools:discover-metadata"
-      ]
-    },
-    "vue:copy-metadata": {
-      "dependsOn": [
-        "tools:discover-metadata"
-      ]
-    },
     "lint": {
       "cache": true
     },

package.json

@@ -4,21 +4,14 @@
   "license": "MIT",
   "author": "Developer Express Inc.",
   "scripts": {
-    "devextreme:inject-descriptions-to-bundle": "dx-tools inject-descriptions --target-path ./packages/devextreme/ts/dx.all.d.ts --artifacts ./artifacts/internal-tools",
-    "devextreme:inject-descriptions-to-modules": "dx-tools inject-descriptions --collapse-tags --sources ./packages/devextreme/js --artifacts ./artifacts/internal-tools",
+    "devextreme:inject-descriptions-to-bundle": "dx-tools inject-descriptions --target-path ./packages/devextreme/ts/dx.all.d.ts --artifacts ./node_modules/devextreme-metadata/dist",
+    "devextreme:inject-descriptions-to-modules": "dx-tools inject-descriptions --collapse-tags --sources ./packages/devextreme/js --artifacts ./node_modules/devextreme-metadata/dist",
     "devextreme:inject-descriptions": "npm run devextreme:inject-descriptions-to-bundle && npm run devextreme:inject-descriptions-to-modules",
-    "angular:copy-metadata": "shx mkdir -p ./packages/devextreme-angular/metadata/ && shx cp ./artifacts/internal-tools/NGMetaData.json ./packages/devextreme-angular/metadata/ && shx cp ./artifacts/internal-tools/integration-data.json ./packages/devextreme-angular/metadata/",
     "angular:regenerate": "nx regenerate devextreme-angular",
-    "angular:inject-descriptions": "dx-tools inject-descriptions --sources ./packages/devextreme-angular/npm/dist --artifacts ./artifacts/internal-tools",
-    "react:copy-metadata": "shx mkdir -p ./packages/devextreme-react/metadata/ && shx cp ./artifacts/internal-tools/integration-data.json ./packages/devextreme-react/metadata/",
+    "angular:inject-descriptions": "dx-tools inject-descriptions --sources ./packages/devextreme-angular/npm/dist --artifacts ./node_modules/devextreme-metadata/dist",
     "react:regenerate": "nx regenerate devextreme-react",
     "react-storybook:start": "nx start devextreme-react-storybook",
     "tools": "dx-tools",
-    "tools:discover-declarations": "dx-tools discover-declarations --sources ./packages/devextreme/js --exclude \"js/(renovation|__internal|.eslintrc.js)\" --compiler-options \"{ \\\"typeRoots\\\": [] }\" --artifacts ./artifacts/internal-tools",
-    "tools:generate-imd": "dx-tools make-integration-metadata --config ./tools/imd-cfg.json",
-    "tools:generate-ng-smd": "dx-tools make-angular-metadata --config ./tools/ng-smd-cfg.json",
-    "tools:discover-metadata": "npm run tools:discover-declarations && npm run tools:generate-imd && npm run tools:generate-ng-smd",
-    "vue:copy-metadata": "shx mkdir -p ./packages/devextreme-vue/metadata/ && shx cp ./artifacts/internal-tools/integration-data.json ./packages/devextreme-vue/metadata/",
     "vue:regenerate": "nx regenerate devextreme-vue",
     "regenerate-all": "nx run-many -t regenerate",
     "lint-staged": "lint-staged",
@@ -44,7 +37,8 @@
     "axe-core": "4.10.3",
     "cheerio": "1.0.0-rc.10",
     "codelyzer": "6.0.2",
-    "devextreme-internal-tools": "18.0.0-beta.11",
+    "devextreme-internal-tools": "catalog:tools",
+    "devextreme-metadata": "workspace:*",
     "http-server": "14.1.1",
     "husky": "8.0.3",
     "jest": "29.7.0",

packages/devextreme-angular/build.config.js

@@ -1,17 +1,12 @@
-const unifiedConfig = require('../../tools/generators-config').angularConfig;
-
 module.exports = {
   tools: {
     metadataGenerator: {
-      sourceMetadataFilePath: './metadata/NGMetaData.json',
-      imdMetadataFilePath: './metadata/integration-data.json',
       outputFolderPath: './metadata/generated',
       nestedPathPart: 'nested',
       basePathPart: 'base',
       widgetPackageName: 'devextreme',
       wrapperPackageName: 'devextreme-angular',
       generateReexports: true,
-      unifiedConfig,
     },
     componentGenerator: {
       metadataFolderPath: './metadata/generated/',
@@ -61,7 +56,6 @@ module.exports = {
       outputFileName: 'tests/src/server/component-names.ts',
     },
     commonReexportsGenerator: {
-      imdMetadataFilePath: './metadata/integration-data.json',
       outputPath: './src/',
     },
   },

packages/devextreme-angular/gulpfile.js

@@ -23,6 +23,7 @@ const argv = require('yargs')
   .parseSync();
 
 const buildConfig = require('./build.config');
+const { angularConfig } = require('../../tools/generators-config');
 
 // ------------Components------------
 
@@ -35,7 +36,12 @@ gulp.task('clean.metadata', gulp.series(() => {
 gulp.task('generate.metadata', gulp.series('clean.metadata', (done) => {
   const generator = new AngularMetadataGenerator();
 
-  generator.generate(buildConfig.tools.metadataGenerator);
+  generator.generate({
+    ...buildConfig.tools.metadataGenerator,
+    unifiedConfig: angularConfig,
+    sourceMetadataFilePath: require.resolve('devextreme-metadata/NGMetaData.json'),
+    imdMetadataFilePath: require.resolve('devextreme-metadata/integration-data.json'),
+  });
   done();
 }));
 
@@ -118,11 +124,11 @@ gulp.task('generate.facades', gulp.series('generate.moduleFacades', (done) => {
 }));
 
 gulp.task('generate.common-reexports', (done) => {
-  const { outputPath, imdMetadataFilePath } = buildConfig.tools.commonReexportsGenerator;
+  const { outputPath } = buildConfig.tools.commonReexportsGenerator;
 
   AngularCommonReexportsGenerator.generate({
     outputPath,
-    metadata: JSON.parse(fs.readFileSync(imdMetadataFilePath).toString()),
+    metadata: JSON.parse(fs.readFileSync(require.resolve('devextreme-metadata/integration-data.json')).toString()),
     templatingOptions: {
       quotes: 'single',
       excplicitIndexInImports: true,

packages/devextreme-angular/package.json

@@ -51,6 +51,7 @@
     "cross-env": "7.0.3",
     "css-loader": "6.10.0",
     "del": "2.2.2",
+    "devextreme-metadata": "workspace:*",
     "eslint": "catalog:",
     "eslint-config-devextreme": "1.1.5",
     "eslint-plugin-import": "catalog:",

packages/devextreme-angular/project.json

@@ -34,10 +34,10 @@
     },
     "regenerate": {
       "executor": "nx:run-script",
+      "dependsOn": ["devextreme-metadata:build"],
       "options": {
         "script": "regenerate"
-      },
-      "dependsOn": ["devextreme-monorepo:\"angular:copy-metadata\""]
+      }
     },
     "test:dev": {
       "executor": "nx:run-script",
@@ -53,7 +53,7 @@
   },
   "namedInputs": {
     "default": [
-      "{projectRoot}/metadata/**/*",
+      "{projectRoot}/devextreme-metadata/**/*",
       "{projectRoot}/src/**/*",
       "{projectRoot}/build.config.js",
       "{projectRoot}/gulpfile.js",

packages/devextreme-metadata/.prettierignore

@@ -0,0 +1,3 @@
+/dist/
+/pnpm-lock.yaml
+*.json

packages/devextreme-metadata/.prettierrc.yaml

@@ -0,0 +1,12 @@
+arrowParens: always
+bracketSameLine: true
+bracketSpacing: true
+endOfLine: lf
+experimentalOperatorPosition: start
+objectWrap: preserve
+printWidth: 100
+quoteProps: preserve
+semi: true
+singleQuote: true
+tabWidth: 2
+trailingComma: all