Codemod

This script is used to modify files which use ICDS components to upgrade from v2 to v3 of the ICDS library.

What is this used for

This codemod has been developed to help users migrate from v2 of ICDS components to v3.

Given a directory, it will scan over files and find any relevant ICDS components that require a change either by component name or props used.

How to run

This package will be usable as an executable, requiring a directory and optional test boolean argument to cover tests

- npx @ukic/codemod <dir> <test>

Options:

  --dir     Directory your project is located in using ICDS components
    [string]

  --test   By default testing is false (with exception of types)
    [boolean]: true | false                                            

Examples:

With tests

- npx @ukic/codemod --dir ./#path/app/src/components --test true

Without tests

- npx @ukic/codemod --dir ./#path/app/src/components

Contributing

We have a couple of resources to help you with contributing.

• To find out more about the different types of contributions, the criteria, raising issues or our release roadmap, read how to contribute to the Design System and UI Kit.
• Make sure to also read our coding standards and technical instructions.
• IC Design System guidance site repository contains the code and content for the Design System guidance site.
• IC UI Kit repository contains the code and content for the web components.

Security

If you've found a vulnerability, we want to know so that we can fix it. Our security policy tells you how to do this.

Questions about the departments

The team is only able to talk about the projects we've put on GitHub 🕵️. We unfortunately can't talk about the work of our departments 😢.

Visit our websites to learn more about:

• The Secret Intelligence Service (MI6).
• The Government Communications Headquarters (GCHQ).
• The Security Service (MI5).
• His Majesty's Government Communications Centre (HMGCC)- our national security partner.

License

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is and available under the terms of the Open Government License v3.0.

© Crown copyright 2022