devextreme-cli 1.3.0-beta.1 → 1.3.0

package/src/themebuider.js

@@ -1,7 +1,9 @@
 const fs = require('fs');
 const path = require('path');
-const packageManager = require('./utility/package-manager');
 const semver = require('semver');
+const stripBom = require('strip-bom');
+const importCwd = require('import-cwd');
+const packageManager = require('./utility/package-manager');
 const lock = require('./utility/file-lock');
 
 const commands = {
@@ -10,7 +12,7 @@ const commands = {
     BUILD_META: 'export-theme-meta'
 };
 
-const themeBuilderPackagePath = path.join(__dirname, '..', 'node_modules', 'devextreme-themebuilder');
+const themeBuilderPackagePath = path.join(process.cwd(), 'node_modules', 'devextreme-themebuilder');
 
 const scssCompiler = {
     render: (scss) => {
@@ -43,7 +45,12 @@ const createPath = filePath => {
 };
 
 const readFile = fileName => new Promise((resolve, reject) => {
-    fs.readFile(require.resolve(fileName), 'utf8', (error, data) => {
+    const fullFileName = path.normalize(path.join(
+        themeBuilderPackagePath,
+        '..',
+        fileName
+    ));
+    fs.readFile(fullFileName, 'utf8', (error, data) => {
         error ? reject(error) : resolve(data);
     });
 });
@@ -72,6 +79,7 @@ const readInput = options => new Promise(resolve => {
             console.error(`Unable to read the ${fileName} file.`);
         } else {
             const extension = path.extname(fileName);
+            data = stripBom(data.toString());
             if(extension !== '.json') {
                 options.data = data;
             } else {
@@ -87,63 +95,34 @@ const getMeta = (fullMeta, base, filter, baseParametersList) => {
     let result = {};
 
     for(const key in fullMeta) {
-        if(base && baseParametersList.indexOf(key) === -1) continue;
-        if(filter && filter.length > 0 && filter.indexOf(key) === -1) continue;
+        let universalKey = key.replace('$', '@');
+        if(base && baseParametersList.indexOf(universalKey) === -1) continue;
+        if(filter && filter.length > 0 && filter.indexOf(universalKey) === -1) continue;
         result[key] = fullMeta[key];
     }
 
     return result;
 };
 
-const installThemeBuilder = async version => {
-    const packageJsonPath = path.join(themeBuilderPackagePath, 'package.json');
-    const cwd = path.join(__dirname, '..');
-    const npmrc = './.npmrc';
-    const installationNpmrc = path.join(cwd, '.npmrc');
-    let removeNpmrc = false;
-
-    if(fs.existsSync(packageJsonPath) && require(packageJsonPath).version === version) {
-        return;
+const getInstalledPackageVersion = (packageName) => {
+    try {
+        return importCwd(`${packageName}/package.json`).version;
+    } catch(e) {
+        return null;
     }
+};
 
-    if(fs.existsSync(npmrc)) {
-        removeNpmrc = true;
-        fs.copyFileSync(npmrc, installationNpmrc);
+const installThemeBuilder = async version => {
+    if(getInstalledPackageVersion('devextreme-themebuilder') === version) {
+        return;
     }
 
     await packageManager.installPackage(`devextreme-themebuilder@${version}`, {
-        cwd,
-        stdio: 'ignore'
+        cwd: process.cwd(),
+        stdio: 'inherit'
     }, {
-        npm: ['--no-save']
+        npm: ['--no-save', '--fund=false', '--package-lock=false', '--omit=dev', '--omit=optional']
     });
-
-    if(removeNpmrc) {
-        fs.unlinkSync(installationNpmrc);
-    }
-};
-
-const getDevExtremeInfo = (dependencies) => {
-    const keyValue = Object.keys(dependencies).find((key) => /devextreme@/.test(key));
-
-    return dependencies[keyValue];
-};
-
-const getDevExtremeVersion = () => {
-    const cwd = process.cwd();
-    const dependencies = packageManager.getDependencies({ cwd });
-    const installedDevExtremePackageJson = path.join(cwd, 'node_modules', 'devextreme', 'package.json');
-
-    if(dependencies) {
-        const devextremeInfo = dependencies.devextreme || getDevExtremeInfo(dependencies);
-        if(devextremeInfo) {
-            return devextremeInfo.version;
-        }
-    } else if(fs.existsSync(installedDevExtremePackageJson)) {
-        return require(installedDevExtremePackageJson).version;
-    }
-
-    return;
 };
 
 const setWidgetsOption = (options, version) => {
@@ -165,6 +144,7 @@ const getVarsFilter = (options) => {
 
 const runThemeBuilder = async rawOptions => {
     const options = await readInput(camelize(rawOptions));
+    const initialItems = options.items ? [...options.items] : [];
     options.reader = readFile;
     options.sassCompiler = scssCompiler;
     options.lessCompiler = require('less/lib/less-node');
@@ -177,7 +157,7 @@ const runThemeBuilder = async rawOptions => {
         options.lessCompiler.options['rootpath'] = options.assetsBasePath;
     }
 
-    const version = options.version || getDevExtremeVersion() || 'latest';
+    const version = options.version || getInstalledPackageVersion('devextreme') || 'latest';
 
     await lock.acquire();
 
@@ -186,11 +166,12 @@ const runThemeBuilder = async rawOptions => {
         await installThemeBuilder(version);
     } catch(e) {
         console.log(`The devextreme-themebuilder npm package of v${version} was not installed. Please verify you are using v18.2.5 or higher and examine the installation error log to further troubleshoot the issue.`);
+        lock.release();
         return;
     }
 
-    const themeBuilder = require('devextreme-themebuilder/modules/builder');
-    const baseParameters = require('devextreme-themebuilder/modules/base-parameters');
+    const themeBuilder = importCwd('devextreme-themebuilder/modules/builder');
+    const baseParameters = importCwd('devextreme-themebuilder/modules/base-parameters');
 
     lock.release();
 
@@ -216,27 +197,24 @@ const runThemeBuilder = async rawOptions => {
         const metadata = getMeta(result.compiledMetadata, options.base, filter, baseParameters);
 
         for(const metadataKey in metadata) {
-            const formatKey = options.fileFormat === 'scss' ? metadataKey.replace('@', '$') : metadataKey;
+            const formatKey = options.fileFormat === 'scss' ?
+                metadataKey.replace('@', '$') :
+                metadataKey.replace('$', '@'); // lgtm[js/incomplete-sanitization]
             content += formatKey + ': ' + metadata[metadataKey] + ';\n';
         }
     } else if(options.command === commands.BUILD_META) {
         const metadata = getMeta(result.compiledMetadata, options.base, filter, baseParameters);
-        let exportedMeta = [];
-
-        for(const metadataKey in metadata) {
-            exportedMeta.push({ key: metadataKey, value: metadata[metadataKey] });
-        }
 
         const meta = {
             baseTheme: [ options.themeName, options.colorScheme.replace(/-/g, '.') ].join('.'),
-            items: exportedMeta,
-            version: result.version
+            items: initialItems.filter(item => metadata[item.key]),
+            version: result.version,
+            removeExternalResources: !!options.removeExternalResources,
+            outputColorScheme: options.outColorScheme,
+            makeSwatch: !!options.makeSwatch,
+            widgets: options.widgets
         };
 
-        if(result.widgets) {
-            Object.assign(meta, { widgets: result.widgets });
-        }
-
         content = JSON.stringify(meta, ' ', 4);
     }
 
@@ -258,5 +236,6 @@ const isThemeBuilderCommand = command => {
 
 module.exports = {
     run: runThemeBuilder,
-    isThemeBuilderCommand: isThemeBuilderCommand
+    isThemeBuilderCommand,
+    getInstalledPackageVersion
 };

package/src/utility/latest-versions.js

@@ -1,8 +1,8 @@
 const packageJson = require('../../package.json');
 module.exports = {
-    'devextreme': '20.1-stable',
-    'devextreme-react': '20.1-stable',
-    'devextreme-vue': '20.1-stable',
+    'devextreme': '^21.2.4',
+    'devextreme-react': '^21.2.4',
+    'devextreme-vue': '^21.2.4',
     'devextreme-cli': packageJson.version,
-    'devextreme-schematics': 'next'
+    'devextreme-schematics': 'latest'
 };

package/src/utility/package-manager.js

@@ -5,17 +5,23 @@ const yarnLockfile = require('@yarnpkg/lockfile');
 const defaultPackageManager = 'npm';
 let currentPackageManager;
 
+const getLock = (cwd, fileName, parser) => {
+    const fullFileName = path.join(cwd, fileName);
+    const fileNameContent = fs.readFileSync(fullFileName, 'utf8');
+    return parser.parse(fileNameContent);
+};
+
 const packageManagers = {
     npm: {
         installCommand: 'install',
         lockFileName: 'package-lock.json',
-        getLockFile: (cwd) => require(path.join(cwd, 'package-lock.json')),
+        getLockFile: (cwd) => getLock(cwd, 'package-lock.json', JSON),
         getDependencies: (obj) => obj.dependencies
     },
     yarn: {
         installCommand: 'add',
         lockFileName: 'yarn.lock',
-        getLockFile: (cwd) => yarnLockfile.parse(fs.readFileSync(path.join(cwd, 'yarn.lock'), 'utf8')),
+        getLockFile: (cwd) => getLock(cwd, 'yarn.lock', yarnLockfile),
         getDependencies: (obj) => obj.object
     }
 };

package/src/{layout.js → utility/prompts/layout.js}

@@ -1,4 +1,4 @@
-const runPrompts = require('./utility/prompts');
+const runPrompts = require('./prompts');
 const layouts = [
     { value: 'side-nav-outer-toolbar', title: 'Side navigation (outer toolbar)' },
     { value: 'side-nav-inner-toolbar', title: 'Side navigation (inner toolbar)' }
@@ -12,16 +12,16 @@ const getValidLayoutName = (layoutName) => {
 };
 
 const getLayoutInfo = (layoutName) => {
-    const prompts = [
+    const questions = [
         {
             type: 'select',
             name: 'layout',
-            message: 'What layout do you want to add?',
+            message: 'Specify desired application layout:',
             choices: layouts
         }
     ];
 
-    return runPrompts(prompts, getValidLayoutName(layoutName));
+    return runPrompts(questions, getValidLayoutName(layoutName));
 };
 
 module.exports = {

package/src/utility/prompts/prompts.js

@@ -0,0 +1,16 @@
+const prompts = require('prompts');
+
+const runPrompts = async(questions, validateValue) => {
+    if(validateValue) {
+        const optionData = {
+            [questions[0].name]: validateValue
+        };
+        return new Promise((resolve, reject) => {
+            resolve(optionData);
+        });
+    }
+
+    return await prompts(questions);
+};
+
+module.exports = runPrompts;

package/src/utility/prompts/vue-version.js

@@ -0,0 +1,29 @@
+const runPrompts = require('./prompts');
+const versions = [
+    { value: 'v2', title: 'Vue version (v2)' },
+    { value: 'v3', title: 'Vue version (v3)' }
+];
+
+const getValidVersion = (versionValue) => {
+    if(!versionValue || !versions.some((version) => `v${versionValue}` === version.value)) {
+        return;
+    }
+    return `v${versionValue}`;
+};
+
+const getVersionInfo = (versionValue) => {
+    const questions = [
+        {
+            type: 'select',
+            name: 'version',
+            message: 'What version do you want?',
+            choices: versions
+        }
+    ];
+
+    return runPrompts(questions, getValidVersion(versionValue));
+};
+
+module.exports = {
+    getVersionInfo
+};

package/src/utility/run-command.js

@@ -4,7 +4,7 @@ module.exports = function(commandName, args = [], customConfig = {}) {
     const forceNoCmd = customConfig.forceNoCmd;
     const command = /^win/.test(process.platform) && !forceNoCmd ? `${commandName}.cmd` : commandName;
     const config = {
-        stdio: customConfig.silent ? 'ignore' : 'inherit',
+        stdio: 'inherit',
         windowsVerbatimArguments: true
     };
 
@@ -15,8 +15,7 @@ module.exports = function(commandName, args = [], customConfig = {}) {
     console.log(`> ${command} ${args.join(' ')}`);
 
     return new Promise((resolve, reject) => {
-        spawn(command, args, config).on('exit', (code) => {
-            code ? reject(code) : resolve();
-        });
+        spawn(command, args, config)
+            .on('exit', (code) => code ? reject(code) : resolve());
     });
 };

package/src/utility/prompts.js

@@ -1,11 +0,0 @@
-const prompts = require('prompts');
-
-const runPrompts = async(promptsValue, options) => {
-    if(options) {
-        prompts.inject([options]);
-    }
-
-    return await prompts(promptsValue);
-};
-
-module.exports = runPrompts;