Merge pull request #5 from hankei6km/topic/update-package-info

Update package info

Author: hankei6km

README.md

@@ -5,16 +5,15 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
 
 ## 利用方法
 
-まだ記述の途中。
-
 1. GitHub から import する(GitHubBox からは https://githubbox.com/hankei6km/my-starter-npm-cli-and-lib)
 1. fork
-1. `package.json` の `name` `version` `description` `license` 、`LICENSE` あたりを新しいパッケージにあわせて変更
+1. `package.json` と `LICENSE` 等を新しいパッケージにあわせて変更(付録にテンプレート)
 1. 新しい terminal を開き `$ npm run upgrade-interactive` 等でパッケージを更新
+1. ブラウザーをリロードする
 
-これで 'npm run csb:test'(`jest --watchAll`) が terminal(「yarn start」タブ) 内で実行される。
+これで terminal(「yarn start」タブ) 内で `start` スクリプトが実行される(通常はエラーとなる)、後は必要に応じてコードの編集等を行う。
 
-コマンドとしての実行を試す場合は `npm run start -- foo.txt` のように実行する。
+テストの実行は CodeSandbox 上では `npm run csb:test` を利用する。コマンドとしての実行を試す場合は `npm run start -- foo.txt` のように実行する。
 
 ### CLI 部分の変更
 
@@ -28,24 +27,40 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
 
 ### npm publish
 
-GitHub で Release を Publish するとビルド実行後に `npm pulish` される。
+GitHub で Release を Publish すると `npm pbulish` される。
+
+なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` を実行してもビルドはされないので注意。
 
-なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` 等を実行してもビルドはされないので注意。
+## 付録
 
+`package.json` に記述する情報のテンプレート。`license` を変更したら `LICENSE` ファイルの変更も忘れずに。
 
-## 既知の問題
+```
+  "name": "<package-name>",
+  "version": "0.1.0",
+  "description": "<description>",
+  "author": "user <mail addr> (website url)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/<user>/<repository>.git"
+  },
+  "bugs": {
+    "url": "https://github.com/<user>/<repository>/issues"
+  },
+  "keywords": []
+```
 
 ## 参考
 
 - [TypeScript で npm ライブラリ開発ことはじめ - Qiita](https://qiita.com/saltyshiomix/items/d889ba79978dadba63fd)
 - [TypeScript で CLI ツールを作って、npm パッケージにする - Qiita](https://qiita.com/suzuki_sh/items/f3349efbfe1bdfc0c634)
 - [yarn upgrade-interactive と同じように npm でも対話型な更新をしたい！ - Qiita](https://qiita.com/kotarella1110/items/08afeb61d493829711eb)
-- [Node.jsパッケージの公開 - GitHub Docs](https://docs.github.com/ja/actions/guides/publishing-nodejs-packages)
-- [GitHub Actionsでnpmに自動でリリースするworkflowを作ってみた | DevelopersIO](https://dev.classmethod.jp/articles/github-actions-npm-automatic-release/)
+- [Node.js パッケージの公開 - GitHub Docs](https://docs.github.com/ja/actions/guides/publishing-nodejs-packages)
+- [GitHub Actions で npm に自動でリリースする workflow を作ってみた | DevelopersIO](https://dev.classmethod.jp/articles/github-actions-npm-automatic-release/)
 
 ## ライセンス
 
 MIT License
 
 Copyright (c) 2021 hankei6km
-

package-lock.json

@@ -1,23 +1,25 @@
 {
   "name": "my-starter-ts-npm-cli-and-lib",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Typescript で CLI とライブラリの npm パッケージを作成するためのスターター。",
+  "license": "MIT",
+  "keywords": [],
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "bin": {
-    "count": "./dist/main.js"
+    "count": "dist/main.js"
   },
-  "license": "MIT",
   "scripts": {
     "start": "tsc && node dist/main.js",
     "start:watch": "nodemon --watch src --ext ts --exec ts-node src/main.ts",
     "build": "tsc",
     "test": "jest",
     "clean": "rm dist/*",
     "upgrade-interactive": "npm-check --update",
-    "csb:test": "npm test -- --watchAll"
+    "csb:test": "npm test -- --runInBand --watchAll"
   },
   "dependencies": {
     "yargs": "^16.2.0"
@@ -32,6 +34,5 @@
     "ts-jest": "^26.5.5",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4"
-  },
-  "keywords": []
+  }
 }

package.json

@@ -4,7 +4,7 @@
   "view": "browser",
   "template": "node",
   "container": {
-    "startScript": "csb:test",
+    "startScript": "start",
     "node": "14"
   }
 }

sandbox.config.json

@@ -5,7 +5,8 @@ import cli from './cli';
 
 const argv = yargs(hideBin(process.argv))
   .scriptName('count')
-  .usage('$0 [args]')
+  .usage('$0 [FILE]...')
+  .example('$0 foo.ts bar.ts', 'count chars in files')
   .demand(1)
   .help().argv;