open-vault/ui/scripts/codemods/icon-transform.js
Jordan Reimer 5c2a08de6d
Ember Upgrade to 3.24 (#13443)
* Update browserslist

* Add browserslistrc

* ember-cli-update --to 3.26, fix conflicts

* Run codemodes that start with ember-*

* More codemods - before cp*

* More codemods (curly data-test-*)

* WIP ember-basic-dropdown template errors

* updates ember-basic-dropdown and related deps to fix build issues

* updates basic dropdown instances to new version API

* updates more deps -- ember-template-lint is working again

* runs no-implicit-this codemod

* creates and runs no-quoteless-attributes codemod

* runs angle brackets codemod

* updates lint:hbs globs to only touch hbs files

* removes yield only templates

* creates and runs deprecated args transform

* supresses lint error for invokeAction on LinkTo component

* resolves remaining ambiguous path lint errors

* resolves simple-unless lint errors

* adds warnings for deprecated tagName arg on LinkTo components

* adds warnings for remaining curly component invocation

* updates global template lint rules

* resolves remaining template lint errors

* disables some ember specfic lint rules that target pre octane patterns

* js lint fix run

* resolves remaining js lint errors

* fixes test run

* adds npm-run-all dep

* fixes test attribute issues

* fixes console acceptance tests

* fixes tests

* adds yield only wizard/tutorial-active template

* fixes more tests

* attempts to fix more flaky tests

* removes commented out settled in transit test

* updates deprecations workflow and adds initializer to filter by version

* updates flaky policies acl old test

* updates to flaky transit test

* bumps ember deps down to LTS version

* runs linters after main merge

* fixes client count tests after bad merge conflict fixes

* fixes client count history test

* more updates to lint config

* another round of hbs lint fixes after extending stylistic rule

* updates lint-staged commands

* removes indent eslint rule since it seems to break things

* fixes bad attribute in transform-edit-form template

* test fixes

* fixes enterprise tests

* adds changelog

* removes deprecated ember-concurrency-test-waiters dep and adds @ember/test-waiters

* flaky test fix

Co-authored-by: hashishaw <cshaw@hashicorp.com>
2021-12-16 20:44:29 -07:00

71 lines
2.5 KiB
JavaScript

#!/usr/bin/env node
/* eslint-env node */
/**
* Codemod to transform Icon component to new API to accomodate FlightIcon
* example execution from ui directory -> npx ember-template-recast ./templates -t ./scripts/codemods/icon-transform.js
* above will run transform on all files in templates directory
*/
module.exports = (env) => {
const {
syntax: { builders },
} = env;
const hsSizes = ['s', 'm', 'l', 'xlm', 'xl', 'xxl'];
// find attribute by name
const findAttribute = (attrs, name) => {
for (let i = 0; i < attrs.length; i++) {
if (attrs[i].name === name) {
return [attrs[i], i, attrs[i].value.chars];
}
}
return [];
};
// possibly a bug with ember-template-recast for multi line components with attributes on their own lines
// when removing an attribute the one on the line below will jump to the same line as the previous one
// this does not happen when removing the first attribute -- doing so may add unnecessary quotes to the first shifted attribute
// example: class="{{foo}}" -> class=""{{foo}}""
const preserveFormatting = (attributes, removeIndex) => {
if (removeIndex > 0) {
// shift the location of the attributes that appear after the one being removed to preserve formatting
for (let i = attributes.length - 1; i > removeIndex; i--) {
attributes[i].loc = attributes[i - 1].loc;
}
}
};
// transform structure icon size letter to flight icon supported size
const transformSize = (attributes, attrName) => {
const [attr, attrIndex, value] = findAttribute(attributes, attrName);
if (hsSizes.includes(value)) {
if (['s', 'm', 'l'].includes(value)) {
// before removing attribute set the location of the remaining attributes
preserveFormatting(attributes, attrIndex);
// since 16 is the default in the component we can remove the attribute
attributes.splice(attrIndex, 1);
} else {
attr.value = builders.text('24');
// rename attribute
if (attrName === '@sizeClass') {
attr.name = '@size';
}
}
}
};
return {
ElementNode(node) {
if (node.tag === 'Icon') {
const { attributes } = node;
// the inital refactor of the component introduced a sizeClass attribute
// this can now be mapped to size and removed
transformSize(attributes, '@sizeClass');
// check for old component instances that may still have a letter for size value
transformSize(attributes, '@size');
}
},
};
};