DEPRECATION: add deprecation warning to this package

[DukeFerdinand]

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

Summary by Sourcery

Documentation:

• Adds a deprecation warning to the README and other documentation files.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-datepicker component and updates the documentation build process to reflect the deprecation. It introduces a new documentation processor and template specifically for deprecated components, guiding users to migrate to the new Auro Formkit.

Class diagram for documentation build process

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

  class templateFiller {
    +extractNames()
    +formatApiTable()
  }

  class Logger {
    +log(message)
    +error(message)
  }

  deprecatedDocsProcessor --|> templateFiller : uses
  deprecatedDocsProcessor --|> Logger : uses

Loading

File-Level Changes

Change	Details	Files
Added a deprecation warning to the README file.	Added a warning message indicating that the component is deprecated and users should migrate to Auro Formkit.	README.md
Updated the build process for documentation.	Replaced the original documentation build script with a script that generates documentation for deprecated components. Added a new script deprecatedDocsProcessor.js to handle the generation of documentation for deprecated components.	package.json packageScripts/deprecatedDocsProcessor.js
Added a new template for generating README files for deprecated components.	Created a new template file docTemplates/README.md to be used for generating README files for deprecated components. The template includes a deprecation warning and links to the new Auro Formkit.	docTemplates/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

• 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.

[sourcery-ai]

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

Overall Comments:

• Consider adding a more specific deprecation date or timeframe to the warning messages.
• It might be helpful to include migration instructions or a link to a migration guide in the deprecation warning.

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 but does not accept any.

In processDocFiles the call is made as fileConfigs(config) though fileConfigs is defined without parameters. Consider refactoring fileConfigs to either accept the config parameter and use it, or call it without arguments to avoid confusion.

Suggested change

	export const fileConfigs = () => [
	export const fileConfigs = (config) => [

[github-actions]

Surge demo deployment failed! 😭

[blackfalcon]

🎉 This PR is included in version 3.2.5 🎉

The release is available on:

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

Your semantic-release bot 📦🚀