Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

DEPRECATION: add deprecation warning to this package #281

Closed

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Mar 6, 2025

Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.

Summary by Sourcery

Adds a deprecation warning to the component and updates the documentation to reflect this change. This includes updating the README, adding a new documentation template, and modifying the build process for documentation.

Enhancements:

  • Updates the build process to generate documentation for deprecated components using a custom script.

Documentation:

  • Adds a deprecation warning to the component's README, advising users to migrate to the new Auro Formkit.
  • Updates the documentation build process to use a custom script for deprecated components.

As part of the new formkit release, all old form element repositories are being deprecated.
@DukeFerdinand DukeFerdinand requested a review from a team as a code owner March 6, 2025 23:07
@DukeFerdinand DukeFerdinand self-assigned this Mar 6, 2025
Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-dropdown component and updates the documentation build process to accommodate deprecated components. It also updates the location of the design tokens CSS file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Adds a deprecation warning to the component's README, indicating it's no longer supported and users should migrate to Auro Formkit.
  • Adds a deprecation warning at the top of the README.
  • Replaces the existing README content with a new template that includes the deprecation warning.
README.md
docTemplates/README.md
Updates the documentation build process to use a custom script for deprecated components.
  • Replaces the standard documentation build script with deprecatedDocsProcessor.js.
  • Adds a new script deprecatedDocsProcessor.js to handle documentation generation for deprecated components.
package.json
packageScripts/deprecatedDocsProcessor.js
Updates the location of the design tokens CSS file.
  • Changes the path for the design tokens CSS file in the example code to point to the auro-classic directory.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

github-actions bot commented Mar 6, 2025

Surge demo deployment failed! 😭

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a script to automatically update the auro-design-tokens and webcorestylesheets versions in the README.
  • It would be helpful to include a brief explanation of why the component is being deprecated in the README.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


processDocFiles({ overwriteLocalCopies: false })
.then(() => {
throw new Error("TESTING ERROR");
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Potential leftover test throw in production.

The deliberate error throw in the .then() block appears to be a remnant of a debugging session. This will prevent the normal success log from ever being executed and could lead to confusion in production.

// README.md
{
identifier: "README.md",
input: "/Users/[email protected]/code/auro/auro-cli/.gitter-temp/multi-git-changer-3406589879/docTemplates/README.md",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Avoid hard-coded absolute paths in file configurations.

Using hard-coded absolute paths might work in a controlled environment, but these paths could break when the code is run on a different machine or after refactoring the directory structure. Consider using relative paths or external configuration to improve portability.

Comment on lines +63 to +64
throw new Error("TESTING ERROR");
Logger.log("Docs processed successfully");
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (code-quality): Remove unreachable code. (remove-unreachable-code)

Suggested change
throw new Error("TESTING ERROR");
Logger.log("Docs processed successfully");
throw new Error("TESTING ERROR");


ExplanationStatements after a return, break, continue or throw will never be executed.
Leaving them in the code confuses the reader, who may believe that these
statements have some effect. They should therefore be removed.

@DukeFerdinand DukeFerdinand deleted the deprecations/2025_03_05_add_deprecation_warnings branch March 6, 2025 23:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

formkit deprecate old form components in respective docs
1 participant