@instructure/ui-codemods 10.20.2-snapshot-11 → 10.20.2-snapshot-13

package/lib/utils/updateV7Popover.ts

@@ -1,133 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type {
-  Collection,
-  JSCodeshift,
-  JSXExpressionContainer,
-  StringLiteral
-} from 'jscodeshift'
-import type { JSXChild } from '../helpers/codemodHelpers'
-import {
-  findElements,
-  findImport,
-  getVisibleChildren,
-  isJSXElement,
-  isJSXIdentifier,
-  isJSXMemberExpression,
-  isJSXText,
-  printWarning
-} from '../helpers/codemodHelpers'
-
-/**
- * Does the following updates on a <Popover>:
- * - `<Popover><Popover.Trigger>{t}</Popover.Trigger></Popover>` ->
- *     `<Popover renderTrigger={t} />`
- * - `<Popover><Popover.Content>c</Popover.Content></Popover>` ->
- *     `<Popover>c</Popover>`
- * - `<Popover onToggle=` -> Display warning that it needs to be done
- *   manually
- **/
-export default function updateV7Popover(
-  j: JSCodeshift,
-  root: Collection,
-  filePath: string
-) {
-  const importName = findImport(j, root, 'Popover', [
-    '@instructure/ui-popover',
-    '@instructure/ui'
-  ])
-  if (!importName) {
-    return false
-  }
-  let isUpdated = false
-  ///// `<Popover><Popover.Trigger>{t}</Popover.Trigger></Popover>` ->
-  /////     `<Popover renderTrigger={t} />`
-  findElements(filePath, j, root, 'Popover').forEach((path) => {
-    const trigger = getVisibleChildren(
-      getChildrenByName('Popover', 'Trigger', path.value.children)
-    )
-    if (trigger.length > 0) {
-      // should have 0 or 1 child
-      isUpdated = true
-      const theChild = trigger[0]
-      let toAdd = theChild as StringLiteral | JSXExpressionContainer
-      if (isJSXText(theChild)) {
-        toAdd = j.stringLiteral(theChild.value)
-      }
-      if (isJSXElement(theChild)) {
-        toAdd = j.jsxExpressionContainer(theChild)
-      } // hope these conversions are enough
-      path.value.openingElement.attributes!.push(
-        j.jsxAttribute(j.jsxIdentifier('renderTrigger'), toAdd)
-      )
-    }
-  })
-  ///// `<Popover><Popover.Content>c</Popover.Content></Popover>` ->
-  /////    `<Popover>c</Popover>`
-  findElements(filePath, j, root, 'Popover').forEach((path) => {
-    const trigger = getChildrenByName('Popover', 'Content', path.value.children)
-    if (trigger) {
-      // should have 0 or 1 child
-      isUpdated = true
-      path.value.children!.push(...trigger)
-    }
-  })
-  ///// `<Popover onToggle=` -> Display warning that it needs to be done manually
-  findElements(filePath, j, root, 'Popover', { name: 'onToggle' }).forEach(
-    (path) => {
-      printWarning(
-        filePath,
-        path.value.loc?.start.line,
-        "Popover's onToggle needs to be converted manually " +
-          'to onShowContent and onHideContent'
-      )
-    }
-  )
-  return isUpdated
-}
-
-/**
- * Removes the child of the given array that is named like `Name1.Name2`
- * It returns the first child of the child that has this name (if any)
- */
-function getChildrenByName(name1: string, name2: string, array?: JSXChild[]) {
-  if (!array) {
-    return
-  }
-  for (const child of array) {
-    if (
-      isJSXElement(child) &&
-      child.children &&
-      isJSXMemberExpression(child.openingElement.name) &&
-      isJSXIdentifier(child.openingElement.name.object) &&
-      child.openingElement.name.object.name === name1 &&
-      child.openingElement.name.property.name === name2
-    ) {
-      array.splice(array.indexOf(child), 1)
-      return child.children
-    }
-  }
-  return
-}

package/lib/utils/updateV7Tabs.ts

@@ -1,129 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type { Collection, JSCodeshift, JSXAttribute } from 'jscodeshift'
-import {
-  findElements,
-  findImport,
-  isJSXAttribue,
-  isLiteral,
-  printWarning
-} from '../helpers/codemodHelpers'
-
-type SizeValue = 'small' | 'medium' | 'large'
-
-// default theme values for Tabs's size prop
-const sizeConversions = {
-  small: '30em',
-  medium: '48em',
-  large: '62em'
-}
-/**
- * Does the following updates on a <Tabs>:
- * - `Tabs size="" maxWidth=..` -> `Tabs maxWidth=..` (delete size)
- * - `Tabs size=` -> `<Tabs maxWidth=` (convert size to maxWidth)
- * - `Tabs selectedIndex=` -> display warning to use isSelected on Tabs.Panel
- **/
-export default function updateV7Tabs(
-  j: JSCodeshift,
-  root: Collection,
-  filePath: string
-) {
-  const importName = findImport(j, root, 'Tabs', [
-    '@instructure/ui-tabs',
-    '@instructure/ui'
-  ])
-  if (!importName) {
-    return false
-  }
-  let isUpdated = false
-  // `Tabs size="" maxWidth=..` -> delete size
-  // `Tabs size=` -> `<Tabs maxWidth=` (convert size to maxWidth)
-  findElements(filePath, j, root, importName, { name: 'size' }).forEach(
-    (path) => {
-      const attributes = path.value.openingElement.attributes
-      if (!attributes) {
-        return
-      }
-      // delete size is maxWidth exists
-      let hasMaxWidth = false
-      let sizeAttribute: JSXAttribute
-      for (const attr of attributes) {
-        if (isJSXAttribue(attr)) {
-          if (attr.name.name === 'maxWidth') {
-            hasMaxWidth = true
-          } else {
-            if (attr.name.name === 'size') {
-              sizeAttribute = attr
-            }
-          }
-        }
-      }
-      if (hasMaxWidth) {
-        isUpdated = true
-        attributes.splice(attributes.indexOf(sizeAttribute!), 1)
-      } else {
-        // `Tabs size=` -> `<Tabs maxWidth=` (convert size to maxWidth)
-        if (isLiteral(sizeAttribute!.value)) {
-          const sizeVal = sizeAttribute!.value.value as SizeValue
-          const sizeConverted = sizeConversions[sizeVal]
-          attributes.splice(attributes.indexOf(sizeAttribute!), 1)
-          attributes.push(
-            j.jsxAttribute(
-              j.jsxIdentifier('maxWidth'),
-              j.stringLiteral(sizeConverted)
-            )
-          )
-          printWarning(
-            filePath,
-            sizeAttribute!.loc?.start.line,
-            "Tabs 'size' attribute was converted to " +
-              "'maxWidth', please check the value, it's only valid if this " +
-              'was not overridden in the theme.'
-          )
-          isUpdated = true
-        } else {
-          printWarning(
-            filePath,
-            sizeAttribute!.loc?.start.line,
-            "Tabs 'size' attribute has non-literal value," +
-              'please update manually.'
-          )
-        }
-      }
-    }
-  )
-  // `Tabs selectedIndex=` -> display warning to use isSelected on Tabs.Panel
-  findElements(filePath, j, root, importName, {
-    name: 'selectedIndex'
-  }).forEach((path) => {
-    printWarning(
-      filePath,
-      path.value.loc?.start.line,
-      "Tabs 'selectedIndex' attribute needs to be updated " +
-        "manually, use 'isSelected' on 'Tabs.Panel'."
-    )
-  })
-  return isUpdated
-}

package/lib/utils/updateV8RenderProp.ts

@@ -1,142 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import {
-  Collection,
-  JSCodeshift,
-  JSXElement,
-  JSXExpressionContainer,
-  JSXFragment
-} from 'jscodeshift'
-import {
-  addImportIfNeeded,
-  findImport,
-  isCallExpression,
-  isIdentifier,
-  isJSXElement,
-  isJSXFragment,
-  isLiteral,
-  isMemberExpression,
-  isSpreadElement,
-  printWarning
-} from '../helpers/codemodHelpers'
-
-export type UpdateV8RenderPropOptions = {
-  wrapperPath: string
-  wrapperTag: string
-  isDefaultImport: boolean
-}
-
-/**
- * Updates ReactDOM.render calls with a given wrapper, for example:
- * ReactDOM.render(<div />) -> ReactDOM.render(<Root><div /></Root>)
- */
-export default function updateV8RenderProp(
-  j: JSCodeshift,
-  root: Collection,
-  filePath: string,
-  options: UpdateV8RenderPropOptions
-) {
-  let functionImport: string | undefined
-  const defaultImport = findImport(j, root, 'ReactDOM', 'react-dom')
-  if (!defaultImport) {
-    functionImport = findImport(j, root, 'render', 'react-dom')
-  }
-  if (!functionImport && !defaultImport) {
-    return false
-  }
-  let hasModifications = false
-  root.find(j.CallExpression).forEach((path) => {
-    const astNode = path.value.callee
-    // it's a function import: import {render} from 'react-dom'; render()
-    const foundFunctionImport =
-      functionImport && isIdentifier(astNode) && astNode.name === functionImport
-    // it's a default import: import ReactDOM from 'react-dom'; ReactDOM.render()
-    const foundDefaultImport =
-      defaultImport &&
-      isMemberExpression(astNode) &&
-      isIdentifier(astNode.object) &&
-      astNode.object.name === defaultImport &&
-      isIdentifier(astNode.property) &&
-      astNode.property.name === 'render'
-    if (foundFunctionImport || foundDefaultImport) {
-      hasModifications = true
-      // add import
-      addImportIfNeeded(j, root, options.wrapperTag, options.wrapperPath, true)
-      // wrap in <Root>
-      const args = path.value.arguments
-      if (args.length === 0) {
-        printWarning(
-          filePath,
-          path.value.loc?.start.line,
-          'ReactDOM.render() seems to have 0 arguments, please check'
-        )
-        return
-      }
-      const firstArg = args[0]
-      if (isSpreadElement(firstArg)) {
-        printWarning(
-          filePath,
-          path.value.loc?.start.line,
-          'ReactDOM.render()-s first argument is spread element, please update manually.'
-        )
-        return
-      } else {
-        let argToAdd: (JSXElement | JSXExpressionContainer | JSXFragment)[]
-        if (
-          isJSXElement(firstArg) ||
-          (isJSXFragment(firstArg) &&
-            firstArg.children &&
-            firstArg.children.length > 0)
-        ) {
-          argToAdd = [firstArg]
-        } else if (
-          isLiteral(firstArg) ||
-          isIdentifier(firstArg) ||
-          isCallExpression(firstArg)
-        ) {
-          argToAdd = [j.jsxExpressionContainer(firstArg)]
-        } else if (
-          isJSXFragment(firstArg) &&
-          (!firstArg.children || firstArg.children.length == 0)
-        ) {
-          return // no need to style empty tag
-        } else {
-          printWarning(
-            filePath,
-            path.value.loc?.start.line,
-            'ReactDOM.render()-s first argument is some strange type, please update manually.'
-          )
-          return
-        }
-        args[0] = j.jsxElement(
-          j.jsxOpeningElement(j.jsxIdentifier(options.wrapperTag)),
-          j.jsxClosingElement(j.jsxIdentifier(options.wrapperTag)),
-          argToAdd
-        )
-      }
-    }
-  })
-  return hasModifications
-}

package/lib/utils/updateV8ThemeProp.ts

@@ -1,51 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Collection, JSCodeshift } from 'jscodeshift'
-import { findEveryImport } from '../helpers/codemodHelpers'
-
-/**
- * Renames components theme={} prop to themeOverride={}
- */
-export default function updateV8ThemeProp(j: JSCodeshift, root: Collection) {
-  const instUIImports = findEveryImport(j, root, '@instructure/ui', false)
-  let isChanged = false
-  instUIImports.forEach((instUIImport) => {
-    const elems = root
-      .find(j.JSXOpeningElement, {
-        name: {
-          type: 'JSXIdentifier',
-          name: instUIImport as string
-        }
-      })
-      .find(j.JSXIdentifier, {
-        name: 'theme'
-      })
-    elems.replaceWith('themeOverride')
-    if (elems.length > 0) {
-      isChanged = true
-    }
-  })
-  return isChanged
-}

package/lib/utils/warnV7ComponentDeprecations.ts

@@ -1,96 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type { Collection, JSCodeshift } from 'jscodeshift'
-import {
-  findElements,
-  findImport,
-  printWarning
-} from '../helpers/codemodHelpers'
-
-/**
- * Warns about the deprecation of DeprecatedButton, Media, MetricsList,
- * Position.Content, Position.Target, Progress components.
- */
-export default function warnV7ComponentDeprecations(
-  j: JSCodeshift,
-  root: Collection,
-  filePath: string
-) {
-  warnDeprecation(j, root, filePath, 'DeprecatedButton', [
-    '@instructure/ui',
-    '@instructure/ui-buttons'
-  ])
-  warnDeprecation(j, root, filePath, 'Media', [
-    '@instructure/ui',
-    '@instructure/ui-byline'
-  ])
-  warnDeprecation(j, root, filePath, 'MetricsList', [
-    '@instructure/ui',
-    '@instructure/ui-metric'
-  ])
-  const importName = findImport(j, root, 'Position', [
-    '@instructure/ui',
-    '@instructure/ui-position'
-  ])
-  if (importName) {
-    findElements(filePath, j, root, importName + '.Content').forEach((path) => {
-      printWarning(
-        filePath,
-        path.value.loc?.start.line,
-        'Position.Content needs to be upgraded manually at line.'
-      )
-    })
-    findElements(filePath, j, root, importName + '.Target').forEach((path) => {
-      printWarning(
-        filePath,
-        path.value.loc?.start.line,
-        'Position.Target needs to be upgraded manually at line.'
-      )
-    })
-  }
-  warnDeprecation(j, root, filePath, 'Progress', [
-    '@instructure/ui',
-    '@instructure/ui-progress'
-  ])
-}
-
-function warnDeprecation(
-  j: JSCodeshift,
-  root: Collection,
-  filePath: string,
-  name: string,
-  importPath: string[]
-) {
-  const importName = findImport(j, root, name, importPath)
-  if (importName) {
-    findElements(filePath, j, root, importName).forEach((path) => {
-      printWarning(
-        filePath,
-        path.value.loc?.start.line,
-        name + ' needs to be upgraded manually.'
-      )
-    })
-  }
-}