cornerstone 개발 자 가이드

설명: 초석 개발 가이드 - 의존, 창설 발표
개발 지침
초석 을 편집 하고 재건 하기 위해 서 는 Node. js 를 설치 해 야 합 니 다.니 가 노드 가 생기 면js 와 npm 패키지 관리 자 를 설 치 했 습 니 다. 프로젝트 의존 항목 을 설치 하고 유 니 버 설 개발 작업 을 실행 할 수 있 습 니 다.
일반적인 임무
설치 의존 관계

npm install

메모: 설치 / 업데이트 의존 항목 은 git 메모리 라 이브 러 리 의 매번 업데이트 후에 실행 해 야 합 니 다.이 작업 을 수행 하지 않 으 면 개발 과정 에서 문제 가 생 길 수 있 습 니 다.
구축 실행

npm start

라 이브 러 리 를 만 드 는 축소 버 전과 축소 되 지 않 은 버 전, 그리고 관련 된 원본 맵 을 실행 합 니 다.
원본 변경 후 자동 으로 구축 실행

npm run watch

문 제 를 디 버 깅 하거나 소스 코드 에 새로운 기능 을 추가 하려 면 이 명령 을 사용 할 수 있 습 니 다.
개발 서비스 파일
간단 한 HTTP 서버 를 실행 할 수 있 는 많은 방법 이 있다.너 도 'python - m simplehtpserver 8080' 을 사용 할 수 있다.

'http - server' 패키지 설치:

``` bash
npm install http-server -g
```

메모: sudo 를 사용 하여 전역 설 치 를 해 야 할 수도 있 습 니 다.

서버 실행

``` bash
http-server
```

브 라 우 저 에서 열기http://127.0.0.1:8080/example/index.html 예제 불 러 오기.

메모: 모 바 일 장치 에서 사용 하려 면 HTTP 서버 를 시작 하고 컴퓨터 의 IP (예:http://192.168.1.11:8080/example/index.html)
실행 및 디 버 깅 테스트

npm test

테스트 를 실행 할 때 '덮어 쓰기' 디 렉 터 리 를 만 듭 니 다.이 디 렉 터 리 는 단지 구축 부품 이기 때문에 메 인 저장 소 에 존재 하지 않 습 니 다.'덮어 쓰기 / HTML / 색인' 에서 HTML 파일 을 열 면.웹 브 라 우 저 (HTTP 서버 필요 없 음) 를 사용 하면 테스트 덮어 쓰기 보고 서 를 보고 검사 할 수 있 습 니 다.
[사진 업로드 실패... (image - fd2c72 - 15337799488283)] 테스트 를 시작 하면 웹 브 라 우 저 에서 탐색 할 수 있 습 니 다.http://0.0.0.0:9876/debug, Karma 테스트 실행 기 디 버 깅 테스트 를 통 해.이 URL 은 바로 작 동 하지 않 습 니 다. npm test 의 첫 번 째 단 계 는 재 구축 입 니 다.
실행 코드 linting 실행 코드 검사

npm run eslint

#         :
npm run eslint-fix

#      “  ”  :
npm run eslint-fix-test

위의 명령 을 실행 하면 linting 문제 의 소스 코드 를 검사 합 니 다.
Pull request 를 통 해 변경 사항 제출
원본 코드 가 변경 되 었 고 이 변경 사항 이 메 인 저장 소 에 포함 되 어야 한다 고 생각 되면 [Pull Request] 를 만들어 서 지역 사회 에 되 돌려 줄 수 있 습 니 다 (https://github.com/cornerstonejs/cornerstone/pulls). 해결 하고 있 는 문제 / 추가 하고 있 는 기능 을 설명 하기 위해 Issue 를 만 드 십시오.라 이브 러 리 관리자 가 이 변경 사항 이 저장 소 에 적합 한 지 에 대해 피드백 을 할 수 있 도록 합 니 다.bug 복구 / 새로운 기능 이 다른 라 이브 러 리 에서 더 잘 실 현 될 수 있 습 니 다 (예 를 들 어 Cornerstone Tools).pull request 를 제출 하기 전에 모든 테스트 가 통과 되 었 는 지 확인 하 십시오. 또한 ESLint 를 실행 하고 모든 문 제 를 복 구 했 습 니 다.
개발 도구 체인 과 규범
Cornerstone 은 많은 오픈 소스 도구, 구성 요소 와 무료 서비스 에 의존 하여 품질 을 확보 합 니 다.
상규

바벨 은 차세 대 자 바스 크 립 트 에서 이전의 자 바스 크 립 트 흑백 바둑 의 전환 을 더욱 광범 위 하 게 지원 하 는 데 사용 된다

WebPack 패키지 프로젝트

ESLint 는 코드 스타일 을 실행 하고 품질 을 유지 하 는 데 사 용 됩 니 다

NPM 은 위탁 관리 로 패 키 지 를 설치 할 수 있다.Cornerstone Core on NPM 참조

Semantic Versioning 은 라 이브 러 리 의 버 전 관리 에 사 용 됩 니 다.

keep a changelog 는 로그 의 형식 을 바 꾸 는 데 사 용 됩 니 다.

테스트

Karma 를 테스트 자로

Mocha 는 테스트 프레임 워 크 로 사용

Chai 는 단언 테스트 에 사용

이스탄불 은 코드 보급률

을 보고 하 는 데 사용 된다.

Travis CI 는 자동 실행 테스트 에 사 용 됩 니 다. Cornerstone Core on Travis CI

참조

Coveralls 는 자동 테스트 후의 코드 보급률 을 표시 하 는 데 사용 된다.Cornerstone Core Coveralls Test Coverage

참조

Headless Chrome 은 헤드 없 는 테스트 를 실행 하 는 데 사용 된다.

문서.

JSdoc 포맷 은 원본 코드 를 기록 하 는 데 사 용 됩 니 다.

documentation. js 는 Markdown 으로 JSdoc 주석 에서 API 문 서 를 생 성 합 니 다

GitBook 은 태그 문 서 를 HTML

로 변환 합 니 다.

Github Pages 호스트 의 문서

Cloudflare 는 HTTPS 를 통 해 문 서 를 제공 하기 위해 Github 페이지 앞 에 놓 여 있 습 니 다.

Rawgit 는 저장 소 서비스 인 Live Examples 에 사 용 됩 니 다.Github 페이지 위탁 관리 로 전환 할 계획 입 니 다.

쓰기 테스트
다음은 글 쓰기 테스트 에 관 한 일반적인 힌트 입 니 다. 유용 할 수 있 습 니 다.

테스트 는 "test" 디 렉 터 리 에 있어 야 합 니 다."src" 디 렉 터 리 레이아웃 을 따 르 도록 하 십시오

테스트 파일 이름 은 " test. js" 로 끝나 야 합 니 다

'coverage test. js' 파일 은 모든 파일 이 이스탄불 규칙 을 따 르 도록 확보 하여 코드 덮어 쓰기 보고 서 를 통 해 전체 저장 소 를 탐색 할 수 있 습 니 다.

Do not convert 'function ()' to arrow functions (i.e. '=> {}') within the 'it', 'should', or 'describe' blocks or Mocha will fail to run the tests properly.

* 'it', 'hould', 'describe' 의 블록 이나 Mocha 의 'function ()' 을 가리 키 는 functions (i. e '= > {}') 의 함수 로 변환 하지 마 십시오. 그렇지 않 으 면 테스트 를 정상적으로 실행 할 수 없습니다.
새 버 전 발표

master 에서 최신 제출 이 있 는 지 확인 하 십시오

지난번 발표 이후 의 변경 범위 에 따라 필요 한 버 전 변경 을 확정 합 니 다.

changelog 업데이트

코드 공헌 자 에 게 감사 해 야 합 니 다!

"package. json" 의 가방 과 의존 버 전 업데이트

구축 버 전 업데이트:

npm run version

운영 구축:

npm run build

변경 사항 제출

git commit -am "Bump version "

버 전 번호 와 제목 표시 로 제출

git tag -a "" -m "Version "

버 전 번호 로 master 에 제출 하기

git push origin master --tags

NPM 에 발표:

npm publish

gitbook 문서 업데이트
하면, 만약, 만약...

전 세계 적 으로 gitbook - cli 를 설 치 했 는 지 확인 합 니 다. 없 으 면 실행:

npm install -g gitbook-cli

들 어가 기 / docs 폴 더:

gitbook install

파일 및 배포 업데이트

루트 폴 더 에서 실행:

npm run docs
#    livereload     http://localhost:4000/

필요 한 문 서 를 변경 하여 모든 것 이 정확 하도록 확보 합 니 다

배 치 를 위해 운행:

npm run docs:deploy