CLI npm packaging (9531e42f) · Commits · sc07 / Fedify Patched

.github/workflows/build.yaml

+10 −0

Original line number	Diff line number	Diff line
		@@ -130,6 +130,8 @@ jobs:
		working-directory: ${{ github.workspace }}/src/npm/
		- run: deno task pack
		working-directory: ${{ github.workspace }}/cli/
		- run: 'deno task npm "$(jq -r .version deno.json)"'
		working-directory: ${{ github.workspace }}/cli/
		- id: extract-changelog
		uses: dahlia/submark@5a5ff0a58382fb812616a5801402f5aef00f90ce
		with:
		@@ -175,6 +177,14 @@ jobs:
		env:
		NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
		working-directory: ${{ github.workspace }}/src/npm/
		- if: github.event_name == 'push' && github.ref_type == 'tag'
		run: \|
		set -ex
		npm config set //registry.npmjs.org/:_authToken "$NPM_AUTH_TOKEN"
		npm publish --provenance --access public fedify-cli-*.tgz
		env:
		NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
		working-directory: ${{ github.workspace }}/cli/

		publish-examples-blog:
		if: github.event_name == 'push'

.vscode/settings.json

+6 −0

Original line number	Diff line number	Diff line
		{
		"deno.enable": true,
		"deno.enablePaths": [
		"cli",
		"src",
		"examples/blog",
		"examples/hono-sample"
		],
		"deno.unstable": true,
		"files.eol": "\n",
		"files.insertFinalNewline": true,

cli/.gitignore

+1 −0

Original line number	Diff line number	Diff line
		fedify-cli-*.tar.xz
		fedify-cli-*.tgz
		fedify-cli-*.zip

cli/README.md

+28 −5

Original line number	Diff line number	Diff line
		<!-- deno-fmt-ignore-file -->

		`fedify`: the CLI toolchain for debugging fediverse apps
		========================================================
		`fedify`: the CLI toolchain for Fedify and debugging ActivityPub
		================================================================

		[![JSR][JSR badge]][JSR]
		[![npm][npm badge]][npm]
		[![GitHub Releases][GitHub Releases badge]][GitHub Releases]

		The `fedify` is a CLI toolchain for debugging ActivityPub-enabled federated
		server apps. Although it is primarily designed for developers who use [Fedify],
		it can be used with any ActivityPub-enabled server.
		The `fedify` is a CLI toolchain for Fedify and debugging ActivityPub-enabled
		federated server apps. Although it is primarily designed for developers who use
		[Fedify], it can be used with any ActivityPub-enabled server.

		[JSR]: https://jsr.io/@fedify/cli
		[JSR badge]: https://jsr.io/badges/@fedify/cli
		[npm]: https://www.npmjs.com/package/@fedify/cli
		[npm badge]: https://img.shields.io/npm/v/@fedify/cli?logo=npm
		[GitHub Releases]: https://github.com/dahlia/fedify/releases
		[GitHub Releases badge]: https://img.shields.io/github/v/release/dahlia/fedify?sort=semver&logo=github
		[Fedify]: https://fedify.dev/
		@@ -20,6 +23,26 @@ it can be used with any ActivityPub-enabled server.
		Installation
		------------

		### Using npm

		If you have npm installed, you can install `fedify` by running the following
		command:

		~~~~ sh
		npm install -g @fedify/cli
		~~~~

		### Using Bun

		If you have [Bun] installed, you can install `fedify` by running the following
		command:

		~~~~ sh [Bun]
		bun install -g @fedify/cli
		~~~~

		[Bun]: https://bun.sh/

		### Using Deno

		If you have [Deno] installed, you can install `fedify` by running the following

cli/deno.json

+4 −1

Original line number	Diff line number	Diff line
		@@ -10,11 +10,13 @@
		"exclude": [
		".vscode",
		"fedify-cli-*.tar.xz",
		"fedify-cli-*.tgz",
		"fedify-cli-*.zip"
		],
		"unstable": [
		"fs",
		"kv",
		"process",
		"temporal"
		],
		"tasks": {
		@@ -26,6 +28,7 @@
		"run": "deno task codegen && deno run --allow-all mod.ts",
		"publish": "deno task codegen && deno task generate-import-map --release && deno publish",
		"publish-dry-run": "deno task codegen && deno publish --dry-run --allow-dirty",
		"pack": "deno task codegen && deno run -A scripts/pack.ts"
		"pack": "deno task codegen && deno run -A scripts/pack.ts",
		"npm": "deno run --allow-read --allow-write --allow-run --allow-env npm/pack.ts"
		}
		}