javascript 라이브러리 게시 및 유지 관리에 대한 포괄적인 가이드 1부

개발자로서 우리는 항상 우리가 프로젝트에서 프로젝트로 가지고 다니는 가장 좋아하는 유틸리티를 가지고 있습니다. 일반적으로 StackOverflow에서 만들었거나 부끄럽게도 훔친 스니펫과 스크립트가 포함된 폴더utils입니다.

우리는 친구 Youcef와 함께 이러한 유틸리티가 포함된 npm 패키지를 만들기로 결정했고 그가 그렇게 하는 것을 지켜본 후 일련의 기사에서 프로세스를 공유하고 문서화하고 싶었습니다.

정의부터 시작하겠습니다

패키지가 무엇인가요?:

A package is a file or directory that is described by a package.json file. A package must contain a package.json file in order to be published to the npm registry
-- source npm.com

npm이 무엇인가요?

npm은 노드 패키지 관리자를 나타냅니다. 그것은 :

주로 오픈 소스이고 공개적으로 사용할 수 있지만 개인 패키지를 만들 수도 있는 javascript 패키지의 저장소

프로젝트 종속성을 관리하는 명령줄 도구(패키지 설치, 해당 버전 업데이트 또는 제거)

시작하기 전에:

Node와 npm이 설치되어 있는지 확인하십시오.

터미널에서 명령npm --version을 실행합니다. 버전이 없으면 설치해야 합니다Node..

package.json 파일 생성

이제 우리는 어휘를 알고 필요한 도구를 가지고 있으므로 이름이 yanis-array-utils 이고 어레이 유틸리티 라이브러리인 첫 번째 패키지를 만들어 보겠습니다.

폴더를 생성하고 콘솔에서 npm init를 실행합니다.
명령이 묻는 모든 질문에 답하십시오(나중에 yanis-array-utils로 게시할 수 있도록 패키지에 다른 이름을 지정하십시오).

그러면 다음을 포함하는 package.json라는 파일이 생성됩니다.

{
  "name": "the-name-of-your-package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \\"Error: no test specified\\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

코드 작성:

첫 번째 유틸리티는 배열의 마지막 요소를 반환하고 index.js라는 파일을 생성하는 함수입니다.

function last(array) {
  return array[array.length - 1];
}
// last(["first","last"]) will return "last"
module.exports = last

이제 npm 패키지가 생겼습니다.

패키지 게시:

이제 패키지의 코드가 있으므로 세상과 공유합시다.

npmjs.com/로 이동하여 회원가입을 합니다.

명령줄에서 npm login를 실행한 다음 npm publish를 실행합니다.

패키지 사용

다른 프로젝트를 만들고 패키지를 종속성으로 설치할 수 있습니다.
npm install yanis-array-utils로 아래와 같이 사용

var last = require("yanis-array-utils");

console.log(last([1, 2, 5]));

곧 있을 다음 기사에서는 다른 모듈 형식으로 내보내기를 지원하는 도구에 대해 논의하고 이 시리즈의 세 번째 부분에서는 CI/CD에 대해 논의할 것입니다.