Skip to content

enhance: デフォルトの User Agent に Summaly の README へのリンクを含めるように #69

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.

Sign up for GitHub

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

Merged
kakkokari-gtyih merged 5 commits into from
Jun 20, 2026
Merged

enhance: デフォルトの User Agent に Summaly の README へのリンクを含めるように #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51f2761
enhance: add url to readme in user agent
kakkokari-gtyih Jun 20, 2026
76ef3d3
enhance: expose version as a variable
kakkokari-gtyih Jun 20, 2026
414547c
Update Changelog
kakkokari-gtyih Jun 20, 2026
e2b72db
fix readme
kakkokari-gtyih Jun 20, 2026
ee5b819
fix readme
kakkokari-gtyih Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
5.5.0 / 2026/xx/xx
------------------

* デフォルトの User Agent に、summaly の readme へのリンクを含めるようにしました。
* 現在お使いの summaly のバージョンを export するように

5.4.0 / 2026/05/11
------------------
* テキストのデコードに `TextDecoder` を使用するように
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ summaly
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]

Get summary of web page.

Installation
----------------------------------------------------------------
```
Expand Down Expand Up @@ -49,7 +51,7 @@ npm run serve
| **followRedirects** | *boolean* | Whether follow redirects | `true` |
| **plugins** | *plugin[]* (see below) | Custom plugins | `null` |
| **agent** | *Got.Agents* | Custom HTTP agent (see below) | `null` |
| **userAgent** | *string* | User-Agent for the request | `SummalyBot/[version]` |
| **userAgent** | *string* | User-Agent for the request | `SummalyBot/[version] (+[Link to README file in GitHub])` |
| **responseTimeout** | *number* | Set timeouts for each phase, such as host name resolution and socket communication. | `20000` |
| **operationTimeout** | *number* | Set the timeout from the start to the end of the request. | `60000` |
| **contentLengthLimit** | *number* | If set to true, an error will occur if the content-length value returned from the other server is larger than this parameter (or if the received body size exceeds this parameter). | `10485760` |
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ export const summalyDefaultOptions = {
plugins: [],
} as SummalyOptions;

export const version = _VERSION_;

/**
* Summarize an web page
*/
Expand Down
2 changes: 1 addition & 1 deletion src/utils/got.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export type GotOptions = {
export const DEFAULT_RESPONSE_TIMEOUT = 20 * 1000;
export const DEFAULT_OPERATION_TIMEOUT = 60 * 1000;
export const DEFAULT_MAX_RESPONSE_SIZE = 10 * 1024 * 1024;
export const DEFAULT_BOT_UA = `SummalyBot/${_VERSION_}`;
export const DEFAULT_BOT_UA = `SummalyBot/${_VERSION_} (+https://github.com/misskey-dev/summaly/blob/master/README.md)`;

export function getGotOptions(url: string, opts?: GeneralScrapingOptions): Omit<GotOptions, 'method'> {
return {
Expand Down
Loading