DEPRECATION: add deprecation warning to this package

[DukeFerdinand]

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

Summary by Sourcery

Deprecate the auro-combobox component and add a warning message to the documentation, advising users to migrate to the new Auro Formkit.

Documentation:

• Add a deprecation warning to the README, advising users to migrate to the new Auro Formkit.
• Update the documentation build process to use a custom script for deprecated components.
• Update the README template to include a deprecation warning.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-combobox component and updates the documentation build process to accommodate deprecated components. The changes involve adding a warning message to the README, updating the documentation build script, and adding new files for documentation generation.

Updated class diagram for the deprecatedDocsProcessor

classDiagram
  class deprecatedDocsProcessor {
    +fileConfigs()
    +processDocFiles(config)
  }

  class fileConfigs {
    +identifier: string
    +input: string
    +output: string
    +mdMagicConfig: object
    +preProcessors: array
  }

  class defaultDocsProcessorConfig {
    +component: undefined
    +overwriteLocalCopies: boolean
    +remoteReadmeVersion: string
  }

deprecatedDocsProcessor -- fileConfigs : uses
deprecatedDocsProcessor -- defaultDocsProcessorConfig : uses

Loading

File-Level Changes

Change	Details	Files
Adds a deprecation warning to the combobox component.	Adds a warning message to the top of the README. The warning message informs users that the component is deprecated and links to the new Auro Formkit. Updates the link to the design tokens CSS in the README to point to the auro-classic version.	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 file docTemplates/README.md to be used as a template for deprecated components. Adds a new file packageScripts/deprecatedDocsProcessor.js to handle the documentation generation for deprecated components.	package.json docTemplates/README.md packageScripts/deprecatedDocsProcessor.js

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Surge demo deployment failed! 😭

[sourcery-ai]

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

Overall Comments:

• Consider adding a script to remove the deprecated package from projects that use it.

Here's what I looked at during the review

• 🟡 General issues: 1 issue 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: fileConfigs is invoked with a config parameter it doesn't accept.

The function 'fileConfigs' is defined without parameters, but later called with 'config'. Either update the function to accept and use the config parameter or remove the argument when calling it for better clarity.

Suggested implementation:

export const fileConfigs = (config) => [

If there are any calls to fileConfigs that no longer pass the config parameter, you'll want to update them accordingly to pass config if necessary.

[blackfalcon]

🎉 This PR is included in version 2.2.5 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀