Skip to content

chore: add deprecation notice - #357

Merged
Danil42Russia merged 1 commit into
developfrom
danil42russia/deprecated
Jun 30, 2026
Merged

chore: add deprecation notice#357
Danil42Russia merged 1 commit into
developfrom
danil42russia/deprecated

Conversation

@Danil42Russia

@Danil42Russia Danil42Russia commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Issue

Closes #

Checklist

Please ensure the following items are completed before requesting review:

  • Updated CHANGELOG.md with relevant changes
  • Documented the contribution in README.md
  • Added tests to demonstrate correct behavior (both positive and negative cases)
  • All tests pass successfully (yarn test)
  • Code passes linting checks (yarn lint)

Summary by CodeRabbit

  • Documentation

    • Added a clear deprecation warning to the README, pointing users to the newer product.
    • Updated the contract creation help text to mark some template types as deprecated.
  • Bug Fixes

    • The CLI now shows the deprecation notice before help output, including when no command is entered or when help/create is requested.
    • Improved the order of command handling so help messages display consistently.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a54a405a-34f8-4b8b-9434-f251f1a023df

📥 Commits

Reviewing files that changed from the base of the PR and between d044b80 and 615aea1.

📒 Files selected for processing (3)
  • README.md
  • src/cli/cli.ts
  • src/cli/constants.ts

📝 Walkthrough

Walkthrough

Blueprint is marked as deprecated. The README gains a top-level caution block and updated --type option docs. The CLI gains a printDeprecationNotice() helper invoked on no-args and help/create commands. templateTypes is extended with deprecated FunC and Tact entries.

Changes

Blueprint Deprecation Notices

Layer / File(s) Summary
CLI deprecation notice and template types
src/cli/cli.ts, src/cli/constants.ts
Adds printDeprecationNotice() using chalk, calls it before showHelp() on no-args and help/create commands, and extends templateTypes with func-empty, tact-empty, func-counter, tact-counter entries labeled as deprecated.
README caution and --type docs
README.md
Adds a top-of-file caution block marking Blueprint as deprecated and updates the --type option list to label func-* and tact-* types as deprecated.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A carrot once fresh, now left on the shelf,
Blueprint steps back, retiring itself.
Red chalk on the screen, a notice appears,
"Move on to Acton!" the bunny now cheers.
Deprecated the types, the README updated too,
Hop along, fellow dev — there's a new path for you! 🌟

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and matches the main change: adding a deprecation notice.
Description check ✅ Passed The description follows the repository template with the issue section and required checklist items.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch danil42russia/deprecated

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Danil42Russia
Danil42Russia merged commit d2eca1f into develop Jun 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants