|
| 1 | +import {parse, prettyPrint} from 'recast'; |
| 2 | +import {builders, namedTypes} from 'ast-types'; |
| 3 | +import * as babelParser from 'recast/parsers/babel'; |
| 4 | +import {copy, copySync, existsSync, readFileSync, writeFileSync} from 'fs-extra'; |
| 5 | +import {dirname, resolve} from 'path'; |
| 6 | +import _ from 'lodash'; |
| 7 | + |
| 8 | +import notify from '../notify'; |
| 9 | +import {_extractDefault} from './init'; |
| 10 | +import {cfgDir, cfgPath, defaultCfg, legacyCfgPath, plugs, schemaFile, schemaPath} from './paths'; |
| 11 | + |
| 12 | +// function to remove all json serializable entries from an array expression |
| 13 | +function removeElements(node: namedTypes.ArrayExpression): namedTypes.ArrayExpression { |
| 14 | + const newElements = node.elements.filter((element) => { |
| 15 | + if (namedTypes.ObjectExpression.check(element)) { |
| 16 | + const newElement = removeProperties(element); |
| 17 | + if (newElement.properties.length === 0) { |
| 18 | + return false; |
| 19 | + } |
| 20 | + } else if (namedTypes.ArrayExpression.check(element)) { |
| 21 | + const newElement = removeElements(element); |
| 22 | + if (newElement.elements.length === 0) { |
| 23 | + return false; |
| 24 | + } |
| 25 | + } else if (namedTypes.Literal.check(element)) { |
| 26 | + return false; |
| 27 | + } |
| 28 | + return true; |
| 29 | + }); |
| 30 | + return {...node, elements: newElements}; |
| 31 | +} |
| 32 | + |
| 33 | +// function to remove all json serializable properties from an object expression |
| 34 | +function removeProperties(node: namedTypes.ObjectExpression): namedTypes.ObjectExpression { |
| 35 | + const newProperties = node.properties.filter((property) => { |
| 36 | + if ( |
| 37 | + namedTypes.ObjectProperty.check(property) && |
| 38 | + (namedTypes.Literal.check(property.key) || namedTypes.Identifier.check(property.key)) && |
| 39 | + !property.computed |
| 40 | + ) { |
| 41 | + if (namedTypes.ObjectExpression.check(property.value)) { |
| 42 | + const newValue = removeProperties(property.value); |
| 43 | + if (newValue.properties.length === 0) { |
| 44 | + return false; |
| 45 | + } |
| 46 | + } else if (namedTypes.ArrayExpression.check(property.value)) { |
| 47 | + const newValue = removeElements(property.value); |
| 48 | + if (newValue.elements.length === 0) { |
| 49 | + return false; |
| 50 | + } |
| 51 | + } else if (namedTypes.Literal.check(property.value)) { |
| 52 | + return false; |
| 53 | + } |
| 54 | + } |
| 55 | + return true; |
| 56 | + }); |
| 57 | + return {...node, properties: newProperties}; |
| 58 | +} |
| 59 | + |
| 60 | +export function configToPlugin(code: string): string { |
| 61 | + const ast: namedTypes.File = parse(code, { |
| 62 | + parser: babelParser |
| 63 | + }); |
| 64 | + const statements = ast.program.body; |
| 65 | + let moduleExportsNode: namedTypes.AssignmentExpression | null = null; |
| 66 | + let configNode: any = null; |
| 67 | + |
| 68 | + for (const statement of statements) { |
| 69 | + if (namedTypes.ExpressionStatement.check(statement)) { |
| 70 | + const expression = statement.expression; |
| 71 | + if ( |
| 72 | + namedTypes.AssignmentExpression.check(expression) && |
| 73 | + expression.operator === '=' && |
| 74 | + namedTypes.MemberExpression.check(expression.left) && |
| 75 | + namedTypes.Identifier.check(expression.left.object) && |
| 76 | + expression.left.object.name === 'module' && |
| 77 | + namedTypes.Identifier.check(expression.left.property) && |
| 78 | + expression.left.property.name === 'exports' |
| 79 | + ) { |
| 80 | + moduleExportsNode = expression; |
| 81 | + if (namedTypes.ObjectExpression.check(expression.right)) { |
| 82 | + const properties = expression.right.properties; |
| 83 | + for (const property of properties) { |
| 84 | + if ( |
| 85 | + namedTypes.ObjectProperty.check(property) && |
| 86 | + namedTypes.Identifier.check(property.key) && |
| 87 | + property.key.name === 'config' |
| 88 | + ) { |
| 89 | + configNode = property.value; |
| 90 | + if (namedTypes.ObjectExpression.check(property.value)) { |
| 91 | + configNode = removeProperties(property.value); |
| 92 | + } |
| 93 | + } |
| 94 | + } |
| 95 | + } else { |
| 96 | + configNode = builders.memberExpression(moduleExportsNode.right, builders.identifier('config')); |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + if (!moduleExportsNode) { |
| 103 | + console.log('No module.exports found in config'); |
| 104 | + return ''; |
| 105 | + } |
| 106 | + if (!configNode) { |
| 107 | + console.log('No config field found in module.exports'); |
| 108 | + return ''; |
| 109 | + } |
| 110 | + if (namedTypes.ObjectExpression.check(configNode) && configNode.properties.length === 0) { |
| 111 | + return ''; |
| 112 | + } |
| 113 | + |
| 114 | + moduleExportsNode.right = builders.objectExpression([ |
| 115 | + builders.property( |
| 116 | + 'init', |
| 117 | + builders.identifier('decorateConfig'), |
| 118 | + builders.arrowFunctionExpression( |
| 119 | + [builders.identifier('_config')], |
| 120 | + builders.callExpression( |
| 121 | + builders.memberExpression(builders.identifier('Object'), builders.identifier('assign')), |
| 122 | + [builders.objectExpression([]), builders.identifier('_config'), configNode] |
| 123 | + ) |
| 124 | + ) |
| 125 | + ) |
| 126 | + ]); |
| 127 | + |
| 128 | + return prettyPrint(ast, {tabWidth: 2}).code; |
| 129 | +} |
| 130 | + |
| 131 | +export const _write = (path: string, data: string) => { |
| 132 | + // This method will take text formatted as Unix line endings and transform it |
| 133 | + // to text formatted with DOS line endings. We do this because the default |
| 134 | + // text editor on Windows (notepad) doesn't Deal with LF files. Still. In 2017. |
| 135 | + const crlfify = (str: string) => { |
| 136 | + return str.replace(/\r?\n/g, '\r\n'); |
| 137 | + }; |
| 138 | + const format = process.platform === 'win32' ? crlfify(data.toString()) : data; |
| 139 | + writeFileSync(path, format, 'utf8'); |
| 140 | +}; |
| 141 | + |
| 142 | +// Migrate Hyper3 config to Hyper4 but only if the user hasn't manually |
| 143 | +// touched the new config and if the old config is not a symlink |
| 144 | +export const migrateHyper3Config = () => { |
| 145 | + copy(schemaPath, resolve(cfgDir, schemaFile), (err) => { |
| 146 | + if (err) { |
| 147 | + console.error(err); |
| 148 | + } |
| 149 | + }); |
| 150 | + |
| 151 | + if (existsSync(cfgPath)) { |
| 152 | + return; |
| 153 | + } |
| 154 | + |
| 155 | + if (!existsSync(legacyCfgPath)) { |
| 156 | + copySync(defaultCfg, cfgPath); |
| 157 | + return; |
| 158 | + } |
| 159 | + |
| 160 | + // Migrate |
| 161 | + copySync(resolve(dirname(legacyCfgPath), '.hyper_plugins', 'local'), plugs.local); |
| 162 | + |
| 163 | + const defaultCfgData = JSON.parse(readFileSync(defaultCfg, 'utf8')); |
| 164 | + let newCfgData; |
| 165 | + try { |
| 166 | + const legacyCfgRaw = readFileSync(legacyCfgPath, 'utf8'); |
| 167 | + const legacyCfgData = _extractDefault(legacyCfgRaw); |
| 168 | + newCfgData = _.merge({}, defaultCfgData, legacyCfgData); |
| 169 | + |
| 170 | + const pluginCode = configToPlugin(legacyCfgRaw); |
| 171 | + if (pluginCode) { |
| 172 | + const pluginPath = resolve(plugs.local, 'migrated-hyper3-config.js'); |
| 173 | + newCfgData.localPlugins = ['migrated-hyper3-config', ...(newCfgData.localPlugins || [])]; |
| 174 | + _write(pluginPath, pluginCode); |
| 175 | + } |
| 176 | + } catch (e) { |
| 177 | + console.error(e); |
| 178 | + notify( |
| 179 | + 'Hyper 4', |
| 180 | + `Failed to migrate your config from Hyper 3.\nDefault config will be created instead at ${cfgPath}` |
| 181 | + ); |
| 182 | + newCfgData = defaultCfgData; |
| 183 | + } |
| 184 | + _write(cfgPath, JSON.stringify(newCfgData, null, 2)); |
| 185 | + |
| 186 | + notify('Hyper 4', `Settings location and format has changed to ${cfgPath}`); |
| 187 | +}; |
0 commit comments