Skip to content

Conversation

@kikuomax
Copy link
Member

@kikuomax kikuomax commented Jun 1, 2025

Proposed changes

Includes the scope @codemonger-io in the package name; cdk-ghost-string-parameter@codemonger-io/cdk-ghost-string-parameter.

Also includes other changes:

  • Bumps the version to 0.2.0.
  • Bumps the dependencies.

Related issues

kikuomax added 6 commits May 29, 2025 18:45
Replaces the package name: `cdk-ghost-string-parameter` →
`@codemonger-io/cdk-ghost-string-parameter`.

Also bumps the version to 0.2.0.
Installs `npm-run-all2` and replaces `npm run` with `run-s`.
Installs `rimraf` and removes the `dist` folder before `build`. Also
removes the `temp` folder before `build:doc`.
Topics:
- Includes the scope `@codemonger-io` in the package name
- Bumps the version to 0.2.0
- Uses `pnpm` instead of `npm` for development
Replaces the package name.
@kikuomax kikuomax requested a review from Copilot June 1, 2025 10:10
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Renames the package to include the @codemonger-io scope, bumps version and dependencies, and updates documentation to reflect the new scope.

  • Renames NPM package to @codemonger-io/cdk-ghost-string-parameter and increments version to 0.2.0.
  • Updates build scripts to use rimraf and run-s, adds/removes devDependencies accordingly.
  • Regenerates and reformats API documentation with scoped package name and HTML tables.

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
package.json Scoped package name, version bump, dependency/version updates, updated script commands
api-docs/markdown/index.md Updated package list link and replaced Markdown table with HTML
api-docs/markdown/*.md Updated navigation links to scoped name and converted Markdown tables to HTML
api-docs/cdk-ghost-string-parameter.api.md Updated API report header to scoped name
README.md & README.ja.md Updated install/import commands, switched to pnpm, and bumped version in URLs
Comments suppressed due to low confidence (3)

package.json:39

  • [nitpick] The aws-cdk-lib (and similarly constructs) is declared in both dependencies and devDependencies. Consider removing it from devDependencies or promoting it to a peerDependency to avoid duplication and potential version mismatches.
"aws-cdk-lib": "^2.127.0",

package.json:17

  • The test script is still a placeholder. Adding real unit tests and updating this script to run them will improve reliability and prevent regressions.
"test": "echo \"Error: no test specified\" && exit 1"

api-docs/markdown/index.md:9

  • [nitpick] The API docs are auto-generated but have been manually converted to HTML tables here. This makes maintenance harder; instead, adjust the documentation generator's template to produce the desired Markdown or HTML consistently.
+<table><thead><tr><th>

Copy link
Member Author

@kikuomax kikuomax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have self-reviewed the changes.

@kikuomax kikuomax merged commit 6ad6faf into main Jun 1, 2025
@kikuomax kikuomax deleted the issue/1-3-4-5-scoped-package-name branch June 1, 2025 15:03
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.

Clean the dist folder before build Make scripts in package.json package-manager-agnostic Bump dependencies Include the scope in the package name

2 participants