https://github.com/heiwa4126/npm-hello

npm パッケージの練習
https://github.com/heiwa4126/npm-hello

Last synced: 5 days ago
JSON representation

npm パッケージの練習

• Host: GitHub
• URL: https://github.com/heiwa4126/npm-hello
• Owner: heiwa4126
• License: mit
• Created: 2024-04-12T05:49:02.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-01T11:29:20.000Z (about 1 month ago)
• Last Synced: 2024-10-29T06:23:41.480Z (16 days ago)
• Language: JavaScript
• Size: 143 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npm-hello (@heiwa4126/hello)

npm パッケージの練習。最初は CommonJS のみで始める。

"Hello, NPM package!" を返すだけの関数。

## インストール

```sh

npm install @heiwa4126/hello

```

CLI として `heiwa4126-hello` がインストールされる。

## 使用例

```javascript

const { hello } = require("@heiwa4126/hello");

console.log(hello());

```

output:

```text

Hello, NPM package!

```

または

```sh

npx @heiwa4126/hello

```

## 開発メモ

ソースには run-scripts に

- `npm test` - [tape](https://www.npmjs.com/package/tape) によるテスト

- `npm run lint` - [biome](https://www.npmjs.com/package/@biomejs/biome) による lint

- `npm run check` - biome による [安全な修正(Safe fixes)](https://biomejs.dev/ja/linter/#%E5%AE%89%E5%85%A8%E3%81%AA%E4%BF%AE%E6%AD%A3safe-fixes)

- `npm run lint:package` - [npm-package-json-lint](https://www.npmjs.com/package/npm-package-json-lint) による package.json の lint

- `npm run linklocal` - 自分自身のリンクを node_modules の下に作る。Python の editable mode (`pip install -e`) に相当する。多分 Linux でしか動かない

が書いてあります。

レポジトリからクローンしたら

```sh

npm i

npm run linklocal  # オプション

```

で始めて作業してください。

また数字のみの git タグ(例:"v1.0.0","v1.0.0-0"など)をつけて、

GitHub に `git push --tags` すると

GitHub Packages が生成される

GitHub Actions が書いてあります

([release-package.yml](.github/workflows/release-package.yml))。

GitHub Packages については

[GitHub Packages のクイックスタート - GitHub Docs](https://docs.github.com/ja/packages/quickstart)

を参照してください。