@frankgqpeng/helloworld

A minimal CLI demo showcasing npm publishing best practices with TypeScript.

Features

• TypeScript source, compiled to CommonJS dist/
• Both library API (greet) and CLI binary (helloworld)
• Type declarations (.d.ts) shipped to consumers
• Strict files whitelist — only dist/, README.md, LICENSE published
• prepublishOnly runs lint + test + build, preventing broken releases

Installation

# As a CLI (global)
npm install -g @frankgqpeng/helloworld

# As a library
npm install @frankgqpeng/helloworld

CLI Usage

helloworld                   # => Hello, world.
helloworld Alice             # => Hello, Alice.
helloworld Alice --loud      # => Hello, Alice!
helloworld --help
helloworld --version

Or run without installing:

npx @frankgqpeng/helloworld Bob --loud

Development

npm install          # install devDependencies
npm run build        # compile TypeScript -> dist/
npm test             # run tests
npm run start        # run the CLI locally

Publishing workflow (for maintainers)

# 1. Ensure working tree is clean and tests pass
npm test

# 2. Bump version (choose one)
npm version patch    # 0.1.0 -> 0.1.1
npm version minor    # 0.1.0 -> 0.2.0
npm version major    # 0.1.0 -> 1.0.0

# 3. Dry-run to inspect what will be published
npm publish --dry-run

# 4. Publish (scoped packages default to private; --access public makes it public)
npm publish --access public

prepublishOnly automatically runs type-check, tests, and build before publish.

License

MIT