-
Notifications
You must be signed in to change notification settings - Fork 0
Include the scope in the package name #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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.
There was a problem hiding this 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-parameterand increments version to 0.2.0. - Updates build scripts to use
rimrafandrun-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 similarlyconstructs) is declared in bothdependenciesanddevDependencies. Consider removing it fromdevDependenciesor promoting it to apeerDependencyto avoid duplication and potential version mismatches.
"aws-cdk-lib": "^2.127.0",
package.json:17
- The
testscript 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>
kikuomax
left a comment
There was a problem hiding this 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.
Proposed changes
Includes the scope
@codemonger-ioin the package name;cdk-ghost-string-parameter→@codemonger-io/cdk-ghost-string-parameter.Also includes other changes:
Related issues