@rowanmanning/feed-parser

RSS와 Atom 피드를 위한, 잘 테스트되고 탄력적인 Node.js 파서입니다.

목차

• 요구사항
• 소개
• 사용법
  • 파싱된 피드
    • Feed
    • FeedAuthor
    • FeedCategory
    • FeedGenerator
    • FeedImage
    • FeedItem
    • FeedItemMedia
    • FeedMeta
• 지원하는 피드 형식
  • 표준
  • 관용성
• 기여
• 라이선스
• 크레딧

소개

이것은 RSS 및 Atom 피드를 위한 Node.js 기반의 피드 파서입니다. 이 프로젝트는 다음과 같은 목표를 가지고 있습니다:

• 실제 세계의 피드를 대상으로 자동화 테스트 실행. 현재 Sample Feeds을 통해 약 40개의 피드를 대상으로 테스트됩니다. 이는 단순히 사양(specification)뿐만 아니라 실제 피드도 지원함을 보장합니다.

• 위의 점과 관련하여, 피드 파싱 시 가능한 한 관용적(lenient)으로 작동하는 것입니다.

• 사용 중단 예정인 버전의 지원을 중단하는 것을 포함하여 최신 Node.js 버전을 유지합니다.

• node-feedparser (https://github.com/danmactough/node-feedparser)의 훌륭한 부분들, 예를 들어 상대 URL 해결 기능과의 호환성을 유지합니다.

요구사항

이 라이브러리를 실행하려면 다음이 필요합니다:

• Node.js 20 이상

사용법

npm을 통해 설치하세요:

코드에 라이브러리를 로드합니다:

parseFeed 함수를 사용하여 RSS 또는 Atom 피드를 문자열로 파싱할 수 있습니다. 반환 값은 피드의 객체 표현입니다:

유효성 허용 (leniency)을 시도하지만, 데이터를 추출할 수 없는 경우 code 속성이 INVALID_FEED로 설정된 오류가 발생합니다.

이 라이브러리는 URL을 통해 피드를 파싱하지 않습니다. fetch를 사용하면 상대적으로 쉽게 처리할 수 있습니다:

파싱된 피드 (Parsed feed)

parseFeed가 반환하는 feed 객체는 다음 속성들을 가집니다.

Feed

RSS 또는 Atom 피드를 나타냅니다.

<table> <tr> <th>속성 (Property)</th> <th>타입 (Type)</th> <th>설명 (Notes)</th> </tr> <tr> <td><code>authors</code></td> <td><code><a href="#feedauthor">FeedAuthor</a>[]</code></td> <td>피드 작성자들. 항상 배열이지만, 작성자를 찾지 못한 경우 비어 있을 수 있습니다.</td> </tr> <tr> <td><code>categories</code></td> <td><code><a href="#feedcategory">FeedCategory</a>[]</code></td> <td>피드 카테고리들.</div>

항상 배열이지만 카테고리가 발견되지 않으면 비어 있을 수 있다.</td>
</tr>
<tr>
<td><code class="row-header">copyright</code></td>
<td><code class="row-type">string | null</code></td>
<td>피드의 저작권 고지.</td>
</tr>
<tr>
<td><code class="row-header">description</code></td>
<td><code class="row-type">string | null</code></td>
<td>피드에 대한 간략한 설명.</td>
</tr>
<tr>
<td><code class="row-header">generator</code></td>
<td><code class="row-type"><a href="#feedgenerator">FeedGenerator</a> | null</code></td>
<td>피드를 생성한 소프트웨어.</td>
</tr>
<tr>
<td><code class="row-header">image</code></td>
<td><code class="row-type"><a href="#feedimage">FeedImage</a> | null</code></td>
<td>피드를 나타내는 이미지.</td>
</tr>
<tr>
<td><code class="row-header">items</code></td>
<td><code class="row-type"><a href="#feeditem">FeedItem</a>[]</code></td>
<td>피드의 콘텐츠 항목들. 항상 배열이지만 항목이 발견되지 않으면 비어 있을 수 있다.</td>
</tr>
<tr>
<td><code class="row-header">language</code></td>
<td><code class="row-type">string | null</code></td>
<td>피드가 작성된 언어.</td>
</tr>
<tr>
<td><code class="row-header">meta</code></td>
<td><code class="row-type"><a href="#feedmeta">FeedMeta</a></code></td>
<td>피드 형식에 대한 메타 정보.</td>
</tr>
<tr>
<td><code class="row-header">published</code></td>
<td><code class="row-type">Date | null</code></td>
<td>피드가 마지막으로 게시된 날짜.</td>
</tr>
<tr>
<td><code class="row-header">self</code></td>
<td><code class="row-type">string | null</code></td>
<td>피드 자체를 가리키는 URL.</td>
</tr>
<tr>
<td><code class="row-header">title</code></td>
<td><code class="row-type">string | null</code></td>
<td>피드의 이름.</td>
</tr>
<tr>
<td><code class="row-header">updated</code></td>
<td><code class="row-type">Date | null</code></td>
<td>피드가 마지막으로 업데이트된 날짜.</td>
</tr>
<tr>
<td><code class="row-header">url</code></td>
<td class="row-type">string | null</td>
<td></td>
</tr>

</td> <td>이 피드가 기반으로 하는 HTML 웹 페이지의 URL입니다.</td> </tr> </table>

FeedAuthor

Feed 또는 FeedItem의 작성자를 나타냅니다.

<table> <tr> <th>속성(Property)</th> <th>유형(Type)</th> <th>설명(Notes)</th> </tr> <tr> <td><code>email</code></td> <td><code>string | null</code></td> <td>작성자의 이메일 주소입니다.</td> </tr> <tr> <td><code>name</code></td> <td><code>string | null</code></td> <td>작성자의 이름입니다.</td> </tr> <tr> <td><code>url</code></td> <td><code>string | null</code></td> <td>인터넷상에서 작성자를 나타내는 URL입니다.</td> </tr> </table>

FeedCategory

Feed 또는 FeedItem의 콘텐츠 카테고리를 나타냅니다.

<table> <tr> <th>속성(Property)</th> <th>유형(Type)</th> <th>설명(Notes)</th> </tr> <tr> <td><code>label</code></td> <td><code>string | null</code></td> <td>카테고리 표시 레이블입니다.</td> </tr> <tr> <td><code>term</code></td> <td><code>string</code></td> <td>카테고리 식별자입니다. 종종 <code>label</code>과 동일합니다.</td> </tr> <tr> <td><code>url</code></td> <td><code>string | null</code></td> <td>인터넷상에서 카테고리를 나타내는 URL입니다.</td> </tr> </table>

FeedGenerator

Feed를 생성한 소프트웨어를 나타냅니다.

<table> <tr> <th>속성 (Property)</th> <th>유형 (Type)</th> <th>설명 (Notes)</th> </tr> <tr> <td><code>label</code></td> <td><code>string | null</code></td> <td>피드를 생성한 소프트웨어의 이름입니다.</td> </tr> <tr> <td><code>url</code></td> <td><code>string | null</code></td> <td>생성자에 대한 추가 정보가 담긴 URL입니다.</td> </tr> <tr> <td><code>version</code></td> <td><code>string | null</code></td> <td>피드를 생성하는 데 사용된 소프트웨어의 버전입니다.</td> </tr> </table>

FeedImage

Feed에 포함되는 이미지를 나타냅니다.

<table> <tr> <th>속성 (Property)</th> <th>유형 (Type)</th> <th>설명 (Notes)</th> </tr> <tr> <td><code>title</code></td> <td><code>string | null</code></td> <td>이미지의 대체 텍스트입니다.</td> </tr> <tr> <td><code>url</code></td> <td><code>string</code></td> <td>이미지 URL입니다.</td> </tr> </table>

FeedItem

Feed 내의 RSS 항목 또는 Atom 엔트리를 나타냅니다.

<table> <tr> <th>속성 (Property)</th> <th>유형 (Type)</th> <th>설명 (Notes)</th> </tr> <tr> <td><code>authors</code></td> <td><code>FeedAuthor[]</code></td> <td>피드 항목의 작성자들. 항상 배열이지만, 작성자가 발견되지 않으면 비어 있을 수 있습니다.</td> </tr> <tr> <td><code>categories</code></td> <td><code>FeedCategory[]</code></td> <td>피드 항목의 카테고리들. 항상 배열이지만, 카테고리가 발견되지 않으면 비어 있을 수 있습니다.</td> </tr> <tr> <td><code>content</code></td> <td><code>string | null</code></td> <td>피드 항목의 내용입니다.</td> </tr> <tr> <td><code>description</code></td> <td><code>string | null</code></td> <td>피드 항목에 대한 간략한 설명입니다.</td> </tr> <tr> <td><code>id</code></td> <td><code>string | null</code></td> <td>피드 항목의 고유 식별자입니다.</td> </tr> <tr> <td><code>image</code></td> <td><code>FeedImage | null</code></td> <td>피드 항목을 나타내는 이미지입니다.</td> </tr> <tr> <td><code>media</code></td> <td><code>FeedItemMedia[]</code></td> <td>피드 항목과 관련된 미디어들입니다.</td> </table>

항상 배열 형태이지만, 항목이 발견되지 않으면 비어 있을 수 있습니다.</td>
</tr>
<tr>
<td><code>published</code></td>
<td><code>Date | null</code></td>
<td>피드 항목이 마지막으로 게시된 날짜입니다.</td>
</tr>
<tr>
<td><code>title</code></td>
<td><code>string | null</code></td>
<td>피드 항목의 제목입니다.</td>
</tr>
<tr>
<td><code>updated</code></td>
<td><code>Date | null</code></td>
<td>피드 항목이 마지막으로 업데이트된 날짜입니다.</td>
</tr>
<tr>
<td><code>url</code></td>
<td><code>string | null</code></td>
<td>이 피드 항목을 나타내는 HTML 웹 페이지로 연결되는 URL입니다.</td>
</tr>

</table>

FeedItemMedia

FeedItem에 첨부된 미디어 조각을 나타냅니다.

<table> <tr> <th>속성 (Property)</th> <th>유형 (Type)</th> <th>설명 (Notes)</th> </tr> <tr> <td><code>image</code></td> <td><code>string | null</code></td> <td>미디어의 이미지 표현으로 연결되는 URL입니다. 예: 비디오 커버 이미지.</td> </tr> <tr> <td><code>length</code></td> <td><code>number | null</code></td> <td>바이트 단위의 미디어 길이입니다.</td> </tr> <tr> <td><code>mimetype</code></td> <td><code>string | null</code></td> <td>미디어의 전체 MIME 타입입니다 (예: <code>image/jpeg</code>).</td> </tr> <tr> <td><code>title</code></td> <td><code>string | null</code></td> <td>미디어의 제목입니다.</td> </tr> <tr> <td><code>type</code></td> <td><code>string | null</code></td> <td>미디어의 유형 (MIME 타입의 첫 부분, 예: <code>audio</code> 또는 <code>image</code>).</td> </tr> <tr> <td><code>url</code></td> <td><code>string</code></td> <td>미디어로 연결되는 URL입니다.</td> </tr> </table>

FeedMeta

Feed에 대한 메타 정보를 나타냅니다.

<table <tr> <th>속성(Property)</th> <th>유형(Type)</th> <th>설명(Notes)</th> </tr> <tr> <td><code>type</code></td> <td><code>"atom" | "rss"</code></td> <td>피드의 유형 이름입니다.</td> </tr> <tr> <td><code>version</code></td> <td><code>"0.3" | "0.9" | "1.0" | "2.0"</code></td> <td>피드의 유형 버전을 나타냅니다.</td> </tr> </table>

지원되는 피드 형식

표준(Standards)

다음 표준을 준수하는 피드는 지원되며, 대부분의 속성이 파싱됩니다:

• Atom 1.0
• Atom 0.3 (규격은 없으나 예시는 여기에 있습니다)
• RSS 2.0
• RSS 0.9
• RDF Site Summary 1.0

다음 XML 네임스페이스도 파싱되며, 이를 구현하는 RSS 피드의 경우 더 많은 데이터가 파싱됩니다:

• DublinCore (예: dc:creator)
• iTunes Podcast RSS feed (예: itunes:author)

관용성(Leniency)