Show message
for ez-not-error--show-modal")*/` => `/*@Desc("Show message
for ez-not-error--show-modal")*/` + +**Example output with selectors-only=false:** + +`/*@Desc("Show message
for ez-not-error--show-modal")*/` => `/*@Desc("Show message
for ibexa-not-error--show-modal")*/` \ No newline at end of file diff --git a/js/helpers.js b/js/helpers.js new file mode 100644 index 0000000..93e1056 --- /dev/null +++ b/js/helpers.js @@ -0,0 +1,116 @@ +const fs = require('fs'); +const path = require('path'); + +const CONFIG_FILENAME = 'rector.config.js'; + +let savedMainConfig = null; + +const getMainConfig = () => { + if (savedMainConfig) { + return savedMainConfig; + } + + const { INIT_CWD } = process.env; + const fallbackConfigPath = path.resolve('js', CONFIG_FILENAME); + const customConfigPath = path.resolve(INIT_CWD, CONFIG_FILENAME); + + if (fs.existsSync(customConfigPath)) { + savedMainConfig = require(customConfigPath); + } else if (fs.existsSync(fallbackConfigPath)) { + savedMainConfig = require(fallbackConfigPath); + } else { + throw new Error(`Config file not found: ${customConfigPath} or ${fallbackConfigPath}`); + } + + return savedMainConfig; +}; + +const getPrettierConfigFile = (prettierConfigPath) => { + if (fs.existsSync(prettierConfigPath)) { + return prettierConfigPath; + } + + return require.resolve('eslint-config-ibexa/prettier'); +}; +const getAbsolutePath = (pathToDir) => { + if (path.isAbsolute(pathToDir)) { + return pathToDir; + } + + return path.join(process.env.INIT_CWD, pathToDir); +}; + +const getModifyMethod = (method) => { + const mainConfig = getMainConfig(); + + return mainConfig[method] ?? ((config) => config); +}; + +const getRulesConfig = (name) => { + const modifyConfig = getModifyMethod('config'); + const rulesConfigPath = path.join(__dirname, 'rules.config.json'); + const rawData = fs.readFileSync(rulesConfigPath); + const parsedData = JSON.parse(rawData); + const modifiedData = modifyConfig(parsedData); + const sharedConfig = modifiedData.shared ?? {}; + const namedConfig = modifiedData[name] ?? {}; + + return { + ...sharedConfig, + ...namedConfig, + }; +}; + +const shouldReplace = (original, oldValue, newValueConfig) => { + if (newValueConfig.exactMatch) { + return original === oldValue; + } else if (newValueConfig.regexp) { + return !!original.match(oldValue); + } + + return true; +}; + +const getValues = (oldValue, newValueConfig) => { + if (newValueConfig.regexp) { + return { + oldValue: new RegExp(oldValue, 'g'), + newValue: newValueConfig.to, + }; + } + + return { + oldValue, + newValue: newValueConfig.to ?? newValueConfig, + }; +}; + +const traverse = (moduleConfig, originalValue, replaceData) => { + Object.entries(moduleConfig).forEach(([oldValueRaw, newValueConfig]) => { + if (shouldReplace(originalValue, oldValueRaw, newValueConfig)) { + const { oldValue, newValue } = getValues(oldValueRaw, newValueConfig); + + replaceData(oldValue, newValue, newValueConfig); + } + }); +}; + +const isFunctionArgument = ({ parentPath }, functionName) => { + if (!parentPath?.isCallExpression()) { + return false; + } + + return parentPath.node.callee.property?.name === functionName; +}; + +module.exports = { + getMainConfig, + getPrettierConfigFile, + getAbsolutePath, + getModifyMethod, + getRulesConfig, + shouldReplace, + getValues, + traverse, + isFunctionArgument, +}; diff --git a/js/ibexa-rename-ez-global.js b/js/ibexa-rename-ez-global.js new file mode 100644 index 0000000..e55ae02 --- /dev/null +++ b/js/ibexa-rename-ez-global.js @@ -0,0 +1,16 @@ +module.exports = function ({ types }) { + return { + visitor: { + Identifier(path) { + if (path.node.name === 'eZ') { + path.node.name = types.toIdentifier('ibexa'); + } + }, + JSXIdentifier(path) { + if (path.node.name === 'eZ') { + path.node.name = types.toIdentifier('ibexa'); + } + }, + }, + }; +}; diff --git a/js/ibexa-rename-in-translations.js b/js/ibexa-rename-in-translations.js new file mode 100644 index 0000000..561e6a1 --- /dev/null +++ b/js/ibexa-rename-in-translations.js @@ -0,0 +1,34 @@ +const { getRulesConfig, traverse } = require('./helpers.js'); + +const moduleConfig = getRulesConfig('ibexa-rename-in-translations'); + +module.exports = function () { + return { + visitor: { + Identifier(path) { + if (path.node.name !== 'trans') { + return; + } + const parentCallExpresion = path.findParent((parentPath) => parentPath.isCallExpression()); + const translationComment = parentCallExpresion?.node.arguments[0]?.leadingComments[0]; + + if (translationComment) { + traverse(moduleConfig, translationComment.value, (oldValue, newValue, config) => { + if (config['selectors-only']) { + const regexp = new RegExp(`<[a-zA-Z0-9-_]*? .*?=(?:[\\"\\'])(.*?)\\1.*?>`, 'g'); + const matches = translationComment.value.match(regexp); + + matches?.forEach((match) => { + const valueToReplace = match.replaceAll(oldValue, newValue); + + translationComment.value = translationComment.value.replaceAll(match, valueToReplace); + }); + } else { + translationComment.value = translationComment.value.replaceAll(oldValue, newValue); + } + }); + } + }, + }, + }; +}; diff --git a/js/ibexa-rename-string-values.js b/js/ibexa-rename-string-values.js new file mode 100644 index 0000000..8a50251 --- /dev/null +++ b/js/ibexa-rename-string-values.js @@ -0,0 +1,29 @@ +const { getRulesConfig, traverse, isFunctionArgument } = require('./helpers.js'); + +const moduleConfig = getRulesConfig('ibexa-rename-string-values'); + +module.exports = function () { + return { + visitor: { + TemplateElement(path) { + if (isFunctionArgument(path, 'trans')) { + return; + } + + traverse(moduleConfig, path.node.value.raw, (oldValue, newValue) => { + path.node.value.raw = path.node.value.raw.replace(oldValue, newValue); + path.node.value.cooked = path.node.value.cooked.replace(oldValue, newValue); + }); + }, + StringLiteral(path) { + if (isFunctionArgument(path, 'trans')) { + return; + } + + traverse(moduleConfig, path.node.value, (oldValue, newValue) => { + path.node.value = path.node.value.replace(oldValue, newValue); + }); + }, + }, + }; +}; diff --git a/js/ibexa-rename-trans-id.js b/js/ibexa-rename-trans-id.js new file mode 100644 index 0000000..79b5438 --- /dev/null +++ b/js/ibexa-rename-trans-id.js @@ -0,0 +1,19 @@ +const { getRulesConfig, traverse, isFunctionArgument } = require('./helpers.js'); + +const moduleConfig = getRulesConfig('ibexa-rename-trans-id'); + +module.exports = function () { + return { + visitor: { + StringLiteral(path) { + if (!isFunctionArgument(path, 'trans')) { + return; + } + + traverse(moduleConfig, path.node.value, (oldValue, newValue) => { + path.node.value = path.node.value.replace(oldValue, newValue); + }); + }, + }, + }; +}; diff --git a/js/ibexa-rename-variables.js b/js/ibexa-rename-variables.js new file mode 100644 index 0000000..4e1b0fa --- /dev/null +++ b/js/ibexa-rename-variables.js @@ -0,0 +1,24 @@ +const { getRulesConfig, traverse } = require('./helpers.js'); + +const moduleConfig = getRulesConfig('ibexa-rename-variables'); + +module.exports = function ({ types }) { + return { + visitor: { + Identifier(path) { + traverse(moduleConfig, path.node.name, (oldValue, newValue) => { + const newIdentifier = path.node.name.replace(oldValue, newValue); + + path.node.name = types.toIdentifier(newIdentifier); + }); + }, + JSXIdentifier(path) { + traverse(moduleConfig, path.node.name, (oldValue, newValue) => { + const newIdentifier = path.node.name.replace(oldValue, newValue); + + path.node.name = types.toIdentifier(newIdentifier); + }); + }, + }, + }; +}; diff --git a/js/rector.config.js b/js/rector.config.js new file mode 100644 index 0000000..547e8a5 --- /dev/null +++ b/js/rector.config.js @@ -0,0 +1,23 @@ +module.exports = { + config: { + paths: [ + { + input: 'src/bundle/Resources/public', + output: 'src/bundle/Resources/public', + }, + { + input: 'src/bundle/ui-dev/src/modules', + output: 'src/bundle/ui-dev/src/modules', + }, + ], + // prettierConfigPath: 'pathToPrettierConfigFile', + }, + plugins: (plugins) => { + // modify enabled plugins + return plugins; + }, + pluginsConfig: (config) => { + // modify plugins config + return config; + }, +}; diff --git a/js/rules.config.json b/js/rules.config.json new file mode 100644 index 0000000..df09215 --- /dev/null +++ b/js/rules.config.json @@ -0,0 +1,63 @@ +{ + "ibexa-rename-variables": { + "^Ez(.*?)Validator$": { + "to": "Ibexa$1Validator", + "regexp": true + }, + "^Ez(.*?)Field$": { + "to": "Ibexa$1Field", + "regexp": true + }, + "_EZ_": { + "to": "_IBEXA_", + "regexp": true + }, + "ez": { + "to": "ibexa", + "exactMatch": true + }, + "ezSiteLocationId": { + "to": "ibexaSiteLocationId", + "exactMatch": true + } + }, + "ibexa-rename-string-values": { + "\\.ez-": { + "to": ".ibexa-", + "regexp": true + }, + "#ez-": { + "to": "#ibexa-", + "regexp": true + }, + "^ez-": { + "to": "ibexa-", + "regexp": true + }, + "^ezplatform-": { + "to": "ibexa-", + "regexp": true + }, + "^ezplatform.": { + "to": "ibexa.", + "regexp": true + }, + "ibexa-field-edit--ez([A-Za-z0-9]+)": { + "to": "ibexa-field-edit--ibexa$1", + "regexp": true + } + }, + "ibexa-rename-trans-id": { + "^ez": { + "to": "ibexa", + "regexp": true + } + }, + "ibexa-rename-in-translations": { + "ez-": { + "to": "ibexa-", + "regexp": true, + "selectors-only": true + } + } +} diff --git a/js/transform-script.js b/js/transform-script.js new file mode 100755 index 0000000..af1c090 --- /dev/null +++ b/js/transform-script.js @@ -0,0 +1,25 @@ +const { execSync } = require('child_process'); +const path = require('path'); +const fs = require('fs'); + +const { getMainConfig, getPrettierConfigFile, getAbsolutePath } = require('./helpers'); + +const { config } = getMainConfig(); +const { paths, prettierConfigPath } = config; +const prettierConfigFile = getPrettierConfigFile(prettierConfigPath); + +paths.forEach(({ input, output }) => { + const inputAbsolutePath = getAbsolutePath(input); + const outputAbsolutePath = getAbsolutePath(output); + + if (!fs.existsSync(inputAbsolutePath)) { + return; + } + + let command = `babel ${inputAbsolutePath} -d ${outputAbsolutePath} --retain-lines`; + command += ` && yarn prettier "${outputAbsolutePath}/**/*.js" --config ${prettierConfigFile} --write`; + + try { + execSync(command, { stdio: 'inherit' }); + } catch (err) {} // eslint-disable-line no-empty +}); diff --git a/package.json b/package.json new file mode 100644 index 0000000..b197056 --- /dev/null +++ b/package.json @@ -0,0 +1,19 @@ +{ + "name": "rector", + "repository": "git@github.com:ibexa/rector.git", + "private": true, + "prettier": "eslint-config-ibexa/prettier", + "dependencies": { + "@babel/cli": "^7.27.0", + "@babel/core": "^7.26.10", + "@babel/plugin-syntax-jsx": "^7.25.9", + "eslint-config-ibexa": "https://github.com/ibexa/eslint-config-ibexa.git#~v1.1.1" + }, + "scripts": { + "test": "yarn prettier-test && yarn eslint-test", + "fix": "yarn prettier-test --write && yarn eslint-test --fix", + "eslint-test": "eslint \"./js/**/*.js\"", + "prettier-test": "yarn prettier \"./js/**/*.{js,scss}\" --check", + "transform": "node ./js/transform-script.js" + } +}