>  기사  >  웹 프론트엔드  >  npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?

npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?

青灯夜游
青灯夜游앞으로
2021-09-15 10:13:311955검색

node 파일을 npm 패키지에 작성하는 방법은 무엇입니까? 다음 글에서는 node 파일을 npm 패키지에 복사해서 퍼블리싱하는 방법을 소개하겠습니다.

npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?

노드 파일을 npm 패키지에 복사하고 게시하세요

npm 플러그인 게시

npm 게시는 사실 매우 간단한 일인데, 오랫동안 게시하지 않았기 때문에 잊어버렸습니다. 오랜만이고, 온라인으로 확인해야 해서 기록하려고 글을 썼습니다. [추천 학습: "nodejs tutorial"]

새 파일 디렉터리 만들기

  • 새 디렉터리를 만들고 원하는 이름을 지정하세요
  • 명령을 실행하여 package.json을 생성하세요. code><code>package.json
npm init --yes

安装依赖

如果项目中还需要其他依赖,可以向正常开发时一样通过npm install xxx

{
"name": "node-fs-copy", //发布的包名,默认是上级文件夹名。不得与现在npm中的包名重复。包名不能有大写字母/空格/下滑线!
  "version": "1.0.0",//你这个包的版本,默认是1.0.0。对于npm包的版本号有着一系列的规则,模块的版本号采用X.Y.Z的格式,具体体现为:
  1、修复bug,小改动,增加z。
  2、增加新特性,可向后兼容,增加y
  3、有很大的改动,无法向下兼容,增加x
  "description": "",
  "main": "index.js",//入口文件,默认是Index.js,可以修改成自己的文件,这个很重要,当你在实际项目使用的时候,let a = require("包名"),它就去会去找对应的文件路径哦。
  "scripts": {                  // 快捷命令,在package.json同目录下输入命令 npm run 键 就会执行 相对应的命令
    "bulid": "npx webpack --config myConfig.js"  //例如 输入 npm run bulid 就会执行npx webpack --config myConfig.js的命令 。
  },
  "keywords": [ // npm搜索的关键字
     "node",
     "fs",
     "copy"
  ],
  "publishConfig": {
    "registry": "" // 发布的npm地址
  },
  "repository": {
      "type": "git",
      "url": "git+https://github.com/xxxx" // 代码的git地址
  },
  "author": "zxw",
  "license": "ISC",//这个直接回车,开源文件协议吧,也可以是MIT,看需要吧。
  "dependencies": {             // 生产环境所依赖的包
    "jquery": "^3.4.1",
    "sea": "^1.0.2"
  },
  "devDependencies": {          // 开发环境所依赖的包
    "webpack": "^4.41.6"
  }
}
-S--save--save-dev的区别,因为通常在开发项目的时候这三个是没有什么本质区别的,但是在开发npm包的还是有区别的

  • -S--save下载的插件会被写入dependencies,并且我们在安装自定义的插件时,会一块被下载
  • --save-dev下载的插件会被写入devDendencies,这个只是在开发的时候使用,并不会随着自定义插件一块被安装

完善<span style="font-size: 16px;">package.json</span>

有几个重要的信息是一定要填写的

  • name 别人安装这个插件需要通过 npm install xxx,来安装这个xxx对应的是namevalue
  • version 插件的版本,每次重新发布都需要重新这个版本后,不然发布会失败
  • main 入口文件

其他可以看需要填写

const { exists, copyDir} = require(&#39;./lib/copy&#39;)

const fsCopy = (sourcePath, deptPath)=> {
  exists(sourcePath,deptPath, copyDir)
}

module.exports = {
  fsCopy
}

确定入口文件为index.js之后,并写入代码,注意引入和导出都需要通过node的方式

  • index.js
const fs = require(&#39;fs&#39;)

/**
 * 复制一个文件夹下的文件到另一个文件夹
 * @param src 源文件夹,即需要写出的文件
 * @param dst 目标文件夹,需要写入的文件
 */
const copyDir = function (src, dst) {
  // 读取目录中的所有文件/目录
  fs.readdir(src, function (err, paths) {
    if (err) {
      throw err
    }
    paths.forEach(function (path) {
      const _src = src + &#39;/&#39; + path
      const _dst = dst + &#39;/&#39; + path
      let readable;
      let writable
      fs.stat(_src, function (err, st) {
        if (err) {
          throw err
        }
        // 判断是否为文件
        if (st.isFile()) {
          // 创建读取流
          readable = fs.createReadStream(_src)
          // 创建写入流
          writable = fs.createWriteStream(_dst)
          // 通过管道来传输流
          readable.pipe(writable)
        }
        // 如果是目录则递归调用自身
        else if (st.isDirectory()) {
          exists(_src, _dst, copyDir)
        }
      })
    })
  })
}
/*
* 判断当前目标文件是否存在
* 如若不存在需要先进行创建
* */
const exists = function (src, dst, callback) {
  // 如果路径存在,则返回 true,否则返回 false。
  if (fs.existsSync(dst)) {
    callback(src, dst)
  } else {
    fs.mkdir(dst, function () {
      callback(src, dst)
    })
  }
}

module.exports = {
  exists,
  copyDir
}
  • /lib/copy.js
npm config set registry https://registry.npmjs.org/

测试

这一块我只是进行了比较简单的测试,后续我会专门补一章关于插件测试的文章

发布

  • 注册npm账号,通常npm可以通过关联gitlab直接登录
  • 确定你当前的镜像指向npm镜像而不是淘宝镜像,如果不确定可以直接执行
npm addUser
  • 运行添加用户命令,依次输入用户,密码,邮箱。
npm publish

npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?

  • 确保当前npm已经在浏览器登录情况下执行发布命令
npm install node-fs-copy

npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?

如图就是发布成功了

发布报错

如果发布遇到403报错,很有可能是你的包名即package.json里面的name字段与npm已经有的插件名重复了,需要修改一下再重新发布

修改过名字依然报错, You cannot publish over the previously published versions: xxx,说明这个版本已经在npm存在,需要修改版本号

迭代

后续内容如果有变动,每次重新发布的时候,都需要手动的更改package.json/version的版本号,然后在执行发布的命令

使用示例

安装

const { fsCopy } = require(&#39;node-fs-copy&#39;)
// 把内容从本地D盘的test/test目录,拷贝到test/test1目录
fsCopy(&#39;d:/test/test&#39;, &#39;d:/test/test1&#39;)

在node代码中,本地拷贝测试

//在服务器上运行,表示把服务器的/data/code-generator文件内的内容,拷贝到当前项目的./temporary/test内
fsCopy(&#39;/data/code-generator&#39;, &#39;./temporary/test&#39;)

服务器代码拷贝

本地是没有办法直接拷贝服务器代码的,如果需要拷贝服务器代码,需要满足一个条件

  • node服务端代码,与需要拷贝的文件在一个服务器上

比如作者的的服务器上的文件地址为/data/code-generator,node服务也部署在同一服务器的另一个目录内

npm init --yes(初始化配置)

npm i (会根据package.json里面的键dependencies,devDependencies来安装相对应的包)

npm i 包(默认安装一个最新的包,这个包在node_modules文件夹里面,并且会更新在你的package.json文件)

npm i 包@3.0.0(安装一个指定版本的包,会更新在你的package.json文件)

npm i 包 --save-dev(安装一个开发环境所需要的包,会更新在你的package.json文件)

npm uninstall 包(卸载一个包,会更新在你的package.json文件)

npm update 包(更新此包版本为最新版本,会更新在你的package.json文件)

npm run 脚本键(会根据package.json里面的"scripts"里面的脚本键自动执行相对于的值)

npm publish  (根据package.json的name发布一个包)

npm unpublish 包名 --force(卸载npm网站上自己上传的包)

完成拷贝后,可以使用打包插件把该内容压缩成zip包,输出到前端,然后删除该临时文件./temporary/test,再删除zip包

🎜Install dependency🎜🎜🎜🎜프로젝트에 다른 종속성이 필요한 경우 일반 개발과 마찬가지로 npm install xxx를 통해 설치할 수 있습니다. 그러나 여기서 주목해야 할 점은 일반적으로 프로젝트를 개발할 때 -S, --save--save-dev의 차이점입니다. npm package를 개발할 때는 이 세 가지 사이에 본질적인 차이가 없지만, npm package🎜🎜🎜-S-S를 개발할 때는 여전히 차이가 있습니다. --save code>다운로드한 플러그인은 종속성에 기록되며, 사용자 정의 플러그인을 설치하면 함께 다운로드됩니다🎜🎜 --save-dev다운로드한 플러그인은 devDendency에 기록됩니다. 이는 개발 중에만 사용되며 사용자 정의 플러그인🎜과 함께 설치되지 않습니다. 🎜🎜🎜Perfect🎜🎜package.json🎜🎜🎜🎜입력해야 하는 몇 가지 중요한 정보가 있습니다🎜🎜🎜<code>name 다른 사람들은 이 플러그인을 다음을 통해 설치해야 합니다. 이 xxx를 설치하기 위한 npm install xxx의 <code>값🎜🎜version 플러그인 버전에 해당합니다. name. 이 버전은 매번 다시 출시되어야 합니다. 그렇지 않으면 기자회견이 실패합니다🎜🎜main 참가 파일🎜🎜다른 항목도 볼 수 있으므로 작성해야 합니다. in🎜rrreee🎜항목 파일이 index.js인지 확인하고 코드를 작성한 후 도입부와 내보내기에 주의하세요. node🎜🎜🎜index.js🎜rrreee🎜🎜/를 통해 테스트해야 합니다. lib/copy.js🎜rrreee🎜🎜🎜Test🎜🎜🎜🎜이번에는 비교적 간단한 테스트만 진행했습니다. 앞으로 플러그인 테스트에 관한 특별 장을 추가하겠습니다🎜🎜🎜🎜Release🎜 🎜🎜🎜🎜npm 계정을 등록하세요. 일반적으로 npm은 gitlab을 연결하여 직접 로그인할 수 있습니다.🎜🎜현재 이미지가 Taobao 이미지 대신 npm 이미지를 가리키는지 확인하세요. 확실하지 않은 경우 🎜rrreee🎜🎜 add user 명령을 실행하고 사용자, 비밀번호, 이메일을 차례로 입력하세요. 🎜rrreee🎜npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?🎜🎜🎜브라우저로 로그인한 동안 npm이 게시 명령을 실행했는지 확인하세요🎜rrreee🎜npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?🎜🎜그림과 같이 퍼블리싱 성공🎜🎜🎜🎜퍼블리싱 오류🎜🎜🎜🎜퍼블리싱에 403이 발생하는 경우 오류가 발생하는 경우 패키지 이름의 name 필드(예: package.json)가 기존 플러그인과 동일할 가능성이 높습니다. npm의 이름을 수정하고 다시 게시해야 합니다🎜🎜이름을 수정한 후에도 이전에 게시된 버전 위에 게시할 수 없습니다: xxx라는 오류가 발생합니다. code>는 이 버전이 <code>npm에 이미 존재하며 버전 번호를 수정해야 함을 나타냅니다. 🎜🎜🎜🎜Iteration🎜🎜🎜🎜후속 콘텐츠에 변경 사항이 있는 경우 수동으로 변경해야 합니다. 다시 게시할 때마다 package.json/version의 버전 번호를 확인하고 게시된 명령을 실행하세요🎜 🎜🎜Usage example🎜🎜🎜🎜🎜Installation🎜🎜🎜rrreee🎜🎜🎜노드 코드에서, 로컬 복사 테스트🎜🎜🎜rrreee🎜🎜🎜서버 코드 복사🎜🎜🎜🎜서버 코드를 로컬에서 직접 복사할 수 있는 방법은 없습니다. 네, 서버 코드를 복사해야 한다면 조건을 만족해야 합니다🎜🎜🎜The 노드 서버 코드와 복사해야 할 파일이 동일한 서버에 있습니다🎜🎜예를 들어 작성자 서버의 파일 주소는 노드 서비스인 /data/code-generator입니다. 같은 서버의 다른 디렉터리에도 배포됩니다🎜rrreee🎜복사를 완료한 후 패키징 플러그인을 사용하여 콘텐츠를 zip 패키지로 압축하고 프런트엔드로 출력할 수 있으며, 그런 다음 임시 파일 ./temporary/test를 삭제하고 zip 패키지🎜를 삭제하세요.

附上常用命令

npm init --yes(初始化配置)

npm i (会根据package.json里面的键dependencies,devDependencies来安装相对应的包)

npm i 包(默认安装一个最新的包,这个包在node_modules文件夹里面,并且会更新在你的package.json文件)

npm i 包@3.0.0(安装一个指定版本的包,会更新在你的package.json文件)

npm i 包 --save-dev(安装一个开发环境所需要的包,会更新在你的package.json文件)

npm uninstall 包(卸载一个包,会更新在你的package.json文件)

npm update 包(更新此包版本为最新版本,会更新在你的package.json文件)

npm run 脚本键(会根据package.json里面的"scripts"里面的脚本键自动执行相对于的值)

npm publish  (根据package.json的name发布一个包)

npm unpublish 包名 --force(卸载npm网站上自己上传的包)

更多编程相关知识,请访问:编程视频!!

위 내용은 npm 패키지에 노드 파일을 작성하고 게시하는 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
이 기사는 juejin.cn에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제