feat(create): update app name in 'pyproject.toml' and 'package.json' by srtaalej · Pull Request #344 · slackapi/slack-cli

srtaalej · 2026-02-17T20:34:59Z

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 · 2026-02-17T20:54:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.75%. Comparing base (113aa42) to head (4853df0).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #344      +/-   ##
==========================================
+ Coverage   64.73%   64.75%   +0.02%     
==========================================
  Files         212      212              
  Lines       17809    17825      +16     
==========================================
+ Hits        11528    11542      +14     
- Misses       5207     5209       +2     
  Partials     1074     1074

☔ 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 👁️‍🗨️

zimeg · 2026-02-19T04:21:09Z

test/testdata/pyproject-app-name.toml

+    "slack-cli-hooks<1.0.0",
+]
+
+[tool.ruff]


Suggested change

[tool.ruff]

# This comment appears before more details

[tool.ruff]

👾 suggestion(non-blocking): I understand the advantage of using regex to be comments and indentation kept during replacements. Using a package like go-toml would make me more confident in updating structured file, but IIRC templates might include comments that we want to avoid removing on accident!

Unfortunately, I don't think we should do that. I've experimented with go-toml for our venv work. When you read-in and write-out, it will re-order the sections and keys based on a random order of the Golang map. So, I've taken a regex approach with the venv as well.

zimeg · 2026-02-19T04:21:32Z

test/testdata/pyproject.toml

+    "slack-cli-hooks<1.0.0",
+]
+
+[tool.ruff]


Suggested change

[tool.ruff]

# This comment appears before more details

[tool.ruff]

🔭 suggestion(non-blocking): This comment follows the one before!

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 · 2026-02-20T05:21:03Z

internal/app/app.go

+// regexReplaceAppNameInPackageJSON replaces the top-level "name" field in a package.json file
+func regexReplaceAppNameInPackageJSON(src []byte, appName string) []byte {
+	re := regexp.MustCompile(`(?m)^(\s*"name"\s*:\s*")([^"]*)(")`)
+	repl := fmt.Sprintf("${1}%s${3}", appName)
+	return re.ReplaceAll(src, []byte(repl))
+}


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:

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*")([^"]*)(".*)

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"

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:

mwbrooks · 2026-02-20T05:22:36Z

internal/app/app.go

+// regexReplaceAppNameInPyprojectToml replaces the "name" field under the [project] section in a pyproject.toml file
+func regexReplaceAppNameInPyprojectToml(src []byte, appName string) []byte {
+	re := regexp.MustCompile(`(\[project\][^\[]*?name\s*=\s*")([^"]*)(")`)
+	repl := fmt.Sprintf("${1}%s${3}", appName)
+	return re.ReplaceAll(src, []byte(repl))
+}


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 · 2026-02-20T05:25:14Z

internal/app/app_test.go

 	}
 }
+
+func Test_RegexReplaceAppNameInPackageJSON(t *testing.T) {


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 · 2026-02-20T05:30:10Z

internal/app/app_test.go

+	}
+}
+
+func Test_RegexReplaceAppNameInPyprojectToml(t *testing.T) {


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 · 2026-02-20T05:32:01Z

test/testdata/pyproject-app-name.toml

+    "slack-cli-hooks<1.0.0",
+]
+
+[tool.ruff]


Unfortunately, I don't think we should do that. I've experimented with go-toml for our venv work. When you read-in and write-out, it will re-order the sections and keys based on a random order of the Golang map. So, I've taken a regex approach with the venv as well.

mwbrooks · 2026-02-20T05:32:35Z

test/testdata/testdata.go

+//go:embed package.json
+var PackageJSON []byte
+
+//go:embed package-app-name.json
+var PackageJSONAppName []byte
+
+//go:embed pyproject.toml
+var PyprojectTOML []byte
+
+//go:embed pyproject-app-name.toml
+var PyprojectTOMLAppName []byte


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

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

4853df0

srtaalej self-assigned this Feb 17, 2026

srtaalej requested a review from a team as a code owner February 17, 2026 20:35

srtaalej added enhancement M-T: A feature request for new functionality semver:minor Use on pull requests to describe the release version increment labels Feb 17, 2026

zimeg approved these changes Feb 19, 2026

View reviewed changes

zimeg added this to the Next Release milestone Feb 19, 2026

zimeg added the changelog Use on updates to be included in the release notes label Feb 19, 2026

mwbrooks requested changes Feb 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

feat(create): update app name in 'pyproject.toml' and 'package.json'#344
srtaalej wants to merge 1 commit intomainfrom
ale-feat-update-name-in-toml

srtaalej commented Feb 17, 2026

Uh oh!

codecov bot commented Feb 17, 2026

Uh oh!

zimeg left a comment

Uh oh!

zimeg Feb 19, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

zimeg Feb 19, 2026

Uh oh!

mwbrooks left a comment

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

mwbrooks Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

	[tool.ruff]
	# This comment appears before more details
	[tool.ruff]

Conversation

srtaalej commented Feb 17, 2026

Changelog

Summary

Requirements

Uh oh!

codecov bot commented Feb 17, 2026

Codecov Report

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments