feat(create): update app name in 'pyproject.toml' and 'package.json'

[srtaalej]

Changelog

The create command now updates the app name in package.json and pyproject.toml project files.

Summary

This PR extends UpdateDefaultProjectFiles to also replace the app name in package.json and pyproject.toml when creating a new project

Before

After

Requirements

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.80%. Comparing base (3aa60a2) to head (6d0c146).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #344      +/-   ##
==========================================
+ Coverage   64.73%   64.80%   +0.06%     
==========================================
  Files         212      212              
  Lines       17805    17827      +22     
==========================================
+ Hits        11526    11552      +26     
+ Misses       5204     5203       -1     
+ Partials     1075     1072       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[zimeg]

@srtaalej LGTM! I tested this with the following commands 🧪 ✨

$ ./bin/slack create asdf -t slack-samples/bolt-js-starter-template
$ ./bin/slack create asdf -t slack-samples/bolt-python-assistant-template

I'm not confident in regex in general but let's be optimistic about these finds - the unit tests are appreciated toward the happy path but I'm leaving a comment toward expected coverages 👁️‍🗨️

[mwbrooks]

🎉 Super cool @srtaalej! Nice work on putting this together and I'm sorry that I didn't remember package.json also didn't work.

🛠️ I've marked this as Request changes because we will need to improve the package.json regex to avoid replacing multiple names. I've left a few suggestions. I think it's important to add test cases for these, so we don't accidentally introduce a bug in the future.

[mwbrooks]

suggestion(blocking): I think this regex will match all "name" keys in package.json instead of just the top-level "name" field. While other "name" keys are rare, I think that's a little too risky.

A few ideas:

1. Update the regex to only match the top-level key
   • Not trivial in regex
   • This may work where $2 is the name field:
   • (.*\{[^{]*"name"\s*:\s*")([^"]*)(".*)
2. Just match the name key with 2 spaces
   • The standard indentation used by npm init
   • This may work: (?m)^(\s{2}"name"\s*:\s*")([^"]*)(")
   • Personally, this is my preference since it feels "safer"
3. Do nothing when we more than one "name" key exists (better to error on doing nothing than corrupting the package.json file)

Here is an example of multiple matches and why we'd need a fix:

[srtaalej]

wow thank you for the detailed explanantion! this is super helpful ❤️ looking into this ASAP 🚀

[mwbrooks]

note: I've confirmed that this will only match name= under the [project] section. Great work @srtaalej!

While we're using teh re.ReplaceAll it should only match "all" names under the project and seems okay.

[mwbrooks]

suggestion: Can we add a test where package.json contains 2 name keys. I think this would build confidence in our regex and help avoid regretful regressions later in life by developers unfamiliar with the regex.

We could put the "name" in the config section:

{
  "name": "vibrant-butterfly-1234",
  "version": "1.0.0",
  "description": "A Slack app built with Bolt",
  "main": "app.js",
  "scripts": {
    "start": "node app.js"
  },
  "dependencies": {
    "@slack/bolt": "^4.0.0"
  },
  "config": {
    "name": "local-server-name",
    "host": "localhost",
    "port": "8080"
  }
}

[mwbrooks]

suggestion: Likewise, I think we should add an extra name = under another section to make sure we never replace other name keys.

An example could be:

[project]
name = "vibrant-butterfly-1234"
version = "0.1.0"
requires-python = ">=3.9"
dependencies = [
    "slack-sdk==3.40.0",
    "slack-bolt==1.27.0",
    "slack-cli-hooks<1.0.0",
]

[tool.ruff]
[tool.ruff.lint]
[tool.ruff.format]

[tool.pytest.ini_options]
testpaths = ["tests"]

[project.scripts]
name = "my_package.name:main_function"

[mwbrooks]

praise: Great use of the embeds to keep test data clean and easy to maintain!