@instructure/ui-codemods

    8.15.0 • Public • Published

    category: packages

    ui-codemods

    The ui-codemods should make it easier to deal with API changes when upgrading Instructure UI libraries.

    npm  MIT License  Code of Conduct

    Installation

    The codemod scripts can be installed via the following command:

    yarn add @instructure/ui-codemods

    The configuration files are located in the instui-config package. This can be installed via the following command:

    yarn add @instructure/instui-config

    Executing Codemods Using instui-cli

    All available codemods can also be executed using the instui-cli instui codemod command. See instui-cli for more detailed documentation.

    Updating Deprecated Props

    This codemod helps you update your project by renaming props that have had names changed (e.g., onReady => onOpen).

    jscodeshift -t node_modules/@instructure/ui-codemods/lib/updatePropNames.js <path> --config=node_modules/@instructure/instui-config/codemod-configs/v<version number ex. 5 or 6>/propNames.config.json

    Updating Package Imports

    This codemod helps you update your project by renaming imports that have changed (e.g., instructure-ui => @instructure/<package name>).

    jscodeshift -t node_modules/@instructure/ui-codemods/lib/updateImports.js <path> --config=node_modules/@instructure/instui-config/codemod-configs/v<version number ex. 5 or 6>/imports.config.js

    Keywords

    none

    Install

    npm i @instructure/ui-codemods

    DownloadsWeekly Downloads

    1,869

    Version

    8.15.0

    License

    MIT

    Unpacked Size

    116 kB

    Total Files

    18

    Last publish

    Collaborators

    • kyler-instructure
    • jonscheiding
    • instuici
    • codequistador
    • natearmstrong
    • eschiebel
    • maths22
    • hyan
    • jcrystal
    • skacsmark
    • itadmins
    • quizzesuici
    • instructure-toolsmiths-service-user
    • prenner
    • aogata-inst
    • acallejas
    • viktor.ohad
    • eszter.szabo
    • amireh-inst
    • daniel.hatas.instructure
    • brianlwatson
    • instout