node.js - 한글 - 내 검사를 무시해야합니까?




nodejs 한글 (2)

누군가가 npm install your-library.npmignore 포함 된 파일을 제외하고 repo가 ​​포함하는 모든 소스 파일을 npm 이 다운로드합니다.

라이브러리를 설치하는 사람들은 라이브러리가 실행 중이어야하며 다른 것은 필요하지 않습니다.

예를 들어, 누군가가 라이브러리를 설치하면 아마도 .travis.yml 또는 .jshintrc 파일이나 이미지, 그란트 파일, 문서 등을 신경 쓰지 않을 것입니다.

.npmignore 하면 npm 패키지의 파일 크기가 줄어들고 다운로드 속도가 빨라집니다.

.npmignore 정확히 무엇을 .npmignore 합니까?

테스트? .travis.yml , .jshintrc 와 같은 .travis.yml ? 모듈을 실행할 때 필요없는 것은 무엇이든 (readme 제외)?

이것에 대한 어떤 지침도 찾을 수 없습니다.


당신이 아마 알았 듯이, NPM은 무엇이 그곳에 가야하는지 구체적으로 진술하지 않고, 묵살 된 파일목록을 가지고 있습니다 . .npmignore 가 없으면 기본적으로 .gitignore 모든 내용이 npm 에서 무시되므로 많은 사람들이 그것을 사용하지 않습니다. 또한 설정에 관계없이 기본적으로 많은 파일이 이미 무시되고 위 링크에서 설명한대로 일부 파일은 항상 무시되지 않습니다.

기본적으로 .gitignore 의 하위 집합이기 때문에 항상 거기에 있어야하는 것에 대한 많은 공식은 없습니다. 그러나 5 년 동안 노드를 사용하여 수집 한 것에서부터 여기에 대해 생각해보십시오.

참고 : 제작 이란 모듈이 누군가에 의해 사용되고 모듈 자체에서 개발되지 않을 때를 의미합니다.

크로스 컴파일 소스 사전 출시

장점 : JavaScript로 크로스 컴파일하는 언어를 사용하는 경우 릴리스 전에 사전 컴파일 할 수 있으며 패키지에 .coffee 파일을 포함하지 않고 git 저장소에서 계속 추적 할 수 있습니다.

파일 남은 부분 만들기

장점 : node-gyp 같은 것을 사용하는 사람들은 결코 패키지에 들어갈 수없는 빌드 중에 생성되는 객체 파일을 가질 수 있습니다. 단점 : 항상 .gitignore 들어가야합니다. npm의 관점에서 .gitignore 를 무시할 때 이미 .npmignore 파일을 사용하고 .npmignore 파일을 여기에 배치해야합니다.

테스트

장점 : 생산 코드에서 수하물이 적습니다. 단점 : 테스트를 실패하게하는 노드 실행의 구 버전과 같이 시스템 특정 오류가 발생할 가능성이 희박한 실제 환경에서 테스트를 실행할 수 없습니다.

지속적인 통합 설정 / 메타 파일

장점 : 다시 말하지만 수하물이 적습니다. .travis.yml 과 같은 .travis.yml 코드를 사용, 테스트 또는보기 위해 필요하지 않습니다.

비 readme 문서 및 코드 예제

장점 : 수하물이 적습니다. 어떤 사람들은 학교에서 최소한의 실행 가능 기능을 Readme에서 표현할 수 없으면 모듈이 너무 크다는 생각에 존재합니다. 단점 : 사람들은 자신의 파일 시스템에서 완전한 문서 및 코드 예제를 볼 수 없습니다. 그들은 저장소 (인터넷 연결이 필요함)를 방문해야합니다.

기생 페이지 개체

장점 : 모듈을 gh-pages 저장소로 이중 사용하는 경우 CNAME 파일이나 자리 표시 자 index.html 릴리즈를 CNAME 하지 않아도됩니다.

bower.json 및 친구들

장점 : 릴리스하기 전에 종속성을 구축하기로 결정한 경우 최종 사용자가 bower를 설치하지 않고 더 많은 것을 설치해야합니다. 나는 개인적으로 그 물건을 꾸러미에 넣을 것이다. npm install 때, npm과 다른 외부 소스에만 의존해야합니다.

기본적으로 npm 패키지에서 제외하고 싶지만 npm 저장소에서 빠져 나오지 않으려는 것이 있으면 사용해야합니다. 긴 항목 목록은 아니지만 npm은 사람들이 패키지에 포함되지 않은 객체를 사용하는 것보다 기능을 구축하는 편이 낫습니다.





npmignore