harunene / jews Goto Github PK

View Code? Open in Web Editor NEW

This project forked from disjukr/just-news

0.0 1.0 0.0 1.51 MB

just news

License: MIT License

JavaScript 100.00%

jews's Introduction

jews

뉴스 사이트 기사 페이지에 접속하면 뉴스 본문외의 정보를 전부 제거한 뒤 페이지를 재구성하는 스크립트입니다.

프로젝트를 만든 사람이 구글 크롬 브라우저를 사용하기 때문에 크롬을 최우선으로 지원합니다.

릴리즈 기준은 크롬 브라우저에서 전부 잘 동작하는가이므로 업데이트가 있을 경우 크롬 외 브라우저에서는 잘 동작하지 않을 수 있습니다.

설치하기

jews는 뉴스 기사 페이지에서 작동되는 스크립트이며, 자동으로 실행되기 위해서는 UserScript 플러그인의 도움이 필요합니다.

UserScript 플러그인 설치

필요한 UserScript 플러그인은 사용중인 브라우저마다 다르며, 각각의 플러그인은 다음의 링크로 들어가 설치하실 수 있습니다:

스크립트 설치

UserScript 플러그인이 설치됐다면 다음의 링크 중 하나를 클릭하여 스크립트 설치 다이얼로그를 띄웁니다:

안정버전 - 마지막으로 릴리즈 된 버전입니다. 이 스크립트를 설치하는 것을 권장합니다.
최신버전 - 개발 중인 버전입니다. 설치를 해도 작동하지 않을 수 있습니다.

기여하는 법

버그 제보하기

jews는 github issue tracker를 사용합니다. 이슈는 https://github.com/disjukr/jews/issues 로 제보해주시기 바랍니다.

소스코드로 기여하기

구현하고 싶은 뉴스 사이트를 정합니다.
1. 뉴스 사이트가 하단의 지원 사이트 목록에 체크되어있지 않은지 확인합니다.
2. 목록에 사이트가 없으면 추가합니다.
jews.user.js에 구현합니다.
1. 상단의 UserScript 주석에 뉴스 페이지 주소를 추가합니다.
2. where 함수에 뉴스사를 구분할 수 있는 문자열을 추가합니다.
3. jews.title, jews.subtitle, jews.content, jews.timestamp, jews.reporters를 각각 구현합니다.
지원 사이트 목록에 구현한 항목을 체크하고 Pull Request를 보냅니다.

유의사항

버그 제보 관련

특정 환경에서만 발생하는 버그는 제보시에 특정 환경(브라우저/OS 등)을 명시해주세요.
특정 뉴스사이트나 기사 페이지에서만 발생하는 버그 역시 제보시에 링크를 명시해주세요.

개발 관련

지원 사이트 목록은 알파벳, 가나다순 정렬을 유지하도록 합니다.
jews 객체 구현 시에 아래에 정의된 타입을 따르도록 합니다.
뉴스 페이지에서 해당하는 정보가 없을 경우 undefined값을 채워 넣습니다.
유사 jQuery 함수를 만들어서 사용합니다.
- 실제 jQuery와 기능이 다르게 동작할 경우 버그로 간주합니다만, 그 기능을 사용할 때만 adhoc하게 고치도록 합니다.

`jews` 타입 정의

아래 타입 정의 스키마는 makise의 문법을 따릅니다.

this is jews

jews is {
    title: string,
    subtitle: string,
    content: html_fragment,
    timestamp: {
        created: Date,
        lastModified: Date
    },
    reporters: [reporter, ...],
    cleanup: Function
}

reporter is {
    name: string,
    mail: mail_address
}

html_fragment is string
mail_address is string