草庐IT

javascript - 如何在 NPM 上创建和发布 Vuejs 组件

coder 2024-07-21 原文

我开始与 vue 一起工作了很多并开始在我工作的公司的所有项目中使用它。有了这个,我最终创建了一些 components , 一般 autocomplete ,我知道有很多,我已经使用了一些,但没有一个能满足我的所有需求。但是,每当我开始处理一个新项目并使用相同的组件时,我要么重新创建它,要么复制并粘贴它。

所以我开始怀疑如何创建我的组件,每当我使用它时上传到 npmjs,只需给一个 npm install -save ... ,并且也能够为社区做出一些贡献。

最佳答案

更新

随着 vue-loader 15.x 的发布,这个答案将不再有效。请改用这个 https://medium.freecodecamp.org/how-to-create-a-vue-js-app-using-single-file-components-without-the-cli-7e73e5b8244f

这是您可以从头开始创建/发布 Vuejs 库/组件的一种方法。

由于我将写下每个步骤和命令,请确保遵循整个指南,您将能够在 NPM 上创建和发布您自己的 Vuejs 组件。

发布后,像大多数库一样,您可以使用 ex 安装它:

npm install --save your-component 

然后使用
import something from 'your-component'

要开始创建我们的第一个组件,首先创建一个名为 vuejs-hello-app 的文件夹。 (或任何其他名称)并在其中运行:
npm init

只需按 Enter 直到交互式问题结束,然后 npm 将生成一个名为 package.json 的文件。在包含以下代码的文件夹中。

(Note: I changed the description and version from 1.0.0 to 0.1.0 here is the result.)


{
  "name": "vuejs-hello-app",
  "version": "0.1.0",
  "description": "vuejs library demo",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

在此之后,我们需要为我们的库安装依赖项。

这些依赖分为两种类型:dependencydevDependencydependency :
是我们自己的组件运行的外部库。当有人安装您的组件时,npm 将确保此依赖项存在或首先安装。由于我们正在为 vue 创建一个组件,因此我们需要确保需要 vue。因此,使用以下命令安装它:
npm install --save vue
devDependency :
是一堆我们只需要用于开发目的的库。这些库将帮助我们构建和/或转译。

我们通过添加后缀 -dev 使用上述方法安装开发依赖项至 --save
现在,让我们安装组件所需的最小开发依赖项:
npm install --save-dev babel-core
npm install --save-dev babel-loader
npm install --save-dev babel-preset-env
npm install --save-dev cross-env
npm install --save-dev css-loader
npm install --save-dev file-loader
npm install --save-dev node-sass
npm install --save-dev sass-loader
npm install --save-dev vue-loader
npm install --save-dev vue-template-compiler
npm install --save-dev webpack
npm install --save-dev webpack-dev-server

此时将安装库和 package.json将更新为如下所示。
{
  "name": "vuejs-hello-app",
  "version": "0.1.0",
  "description": "vuejs library demo",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "webpack -p"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-preset-env": "^1.6.1",
    "cross-env": "^5.1.1",
    "css-loader": "^0.28.7",
    "file-loader": "^1.1.5",
    "node-sass": "^4.7.2",
    "sass-loader": "^6.0.6",
    "vue-loader": "^13.5.0",
    "vue-template-compiler": "^2.5.9",
    "webpack": "^3.10.0",
    "webpack-dev-server": "^2.9.7"
  },
  "dependencies": {
    "vue": "^2.5.9"
  }
}

(note: I have added "build": "webpack -p" to build our lib with webpack)



现在,由于我们的代码需要构建和转译,我们需要一个文件夹来存储构建版本。继续在我们的根文件夹中创建一个文件夹并将其命名为:dist并在同一个地方放置 webpack 的配置文件并将其命名为 webpack.config.js
到目前为止,我们创建的所有文件都是用于配置和内容的。对于人们将要使用的实际应用程序,我们需要在 src/ 中创建至少两个文件。目录。

一个 main.jsVuejsHelloApp.vue把它们当作:./src/main.js./src/components/VuejsHelloApp.vue
我的结构如下:
dist
node_modules
src
  main.js
  components
    VuejsHelloApp.vue
.babelrc
.eslintignore
.gitignore
.npmignore
.travis.yml
CONTRIBUTING
LICENSE
package.json
README.md
webpack.config.js

我将浏览列出的文件并描述每个文件的作用,以防万一有人好奇:
/dist是存储构建(转译)、缩小的、非 ES6 版本的代码的地方
node_modules我想我们已经知道了,让我们忽略它
src/这是您图书馆的根目录。
.babelrc是保留 babel 选项的地方,因此添加它以禁用模块上的预设
{
  "presets": [
    [
      "env",
      {
        "modules": false
      }
    ]
  ]
}
.eslintignore这是你告诉 ESLINT 忽略掉毛的地方,所以把它放在里面:
build/*.js 
.gitignore 添加要忽略的文件(来自 git)
.npmignore与 NPM 的 .gitignore 相同
.travis.yml如果您需要 CI 检查 examples来自 travis 并配置它
CONTRIBUTING不需要
LICENSE不需要
package.json暂时忽略
README.md不需要
webpack.config.js这是让您创建代码的构建版本、浏览器兼容版本的重要文件。

因此,根据我们的应用程序,以下是它应该是什么样子的最小示例:
var path = require('path')
var webpack = require('webpack')

module.exports = {
  entry: './src/main.js',

  module: {
    rules: [
      // use babel-loader for js files
      { test: /\.js$/, use: 'babel-loader' },
      // use vue-loader for .vue files
      { test: /\.vue$/, use: 'vue-loader' }
    ]
  },
  // default for pretty much every project
  context: __dirname,
  // specify your entry/main file
  output: {
    // specify your output directory...
    path: path.resolve(__dirname, './dist'),
    // and filename
    filename: 'vuejs-hello-app.js'
  }
}

if (process.env.NODE_ENV === 'production') {
  module.exports.devtool = '#source-map'
  module.exports.plugins = (module.exports.plugins || []).concat([
    new webpack.DefinePlugin({
      'process.env': {
        NODE_ENV: '"production"'
      }
    }),
    new webpack.optimize.UglifyJsPlugin({
      sourceMap: true,
      compress: {
        warnings: false
      }
    }),
    new webpack.LoaderOptionsPlugin({
      minimize: true
    })
  ])
}

注意这里的重要指令是 entryoutput .如果您想完全自定义您的应用程序,您可以查看 webpack 文档以了解更多信息。

但基本上,我们告诉 webpack 获取 ./src/main.js (我们的应用程序)并将其输出为 ./dist/vuejs-hello-app.js
现在,我们几乎完成了除了实际应用程序之外的所有设置。

转至 /src/components/VuejsHelloApp.vue并转储这个简单的应用程序,当您将鼠标悬停在其上时,它将向右或向左移动按钮
<template>
  <div>
    <button @mouseover='move($event)'> I'm alive </button>
  </div>
</template>

<script>
export default {
  data () {
   return {}
  },

  methods: {
    move (event) {
        let pos = event.target.style.float; 
      if(pos === 'left'){
        event.target.style.float = 'right'
      }else{
        event.target.style.float = 'left'
      }
    }
  }
}

</script>

<style scoped>

</style>

并且并非最不重要的是,到达 ./src/main.js并导出您的应用程序,例如:
import VuejsHelloApp from './components/VuejsHelloApp.vue'
export default VuejsHelloApp

现在转到您的 package.json文件替换 "main: "index.js","main": "src/main.js",
在此之后,只需运行这些命令来构建和发布您的应用程序:
npm run build
git add .
git commit -m "initial commit"
git push -u origin master
npm login 
npm publish

导入和使用库。

如果一切顺利,那么只需像这样安装您的应用程序:
npm install --save vuejs-hello-app

并在 vue 中像这样使用它:
<template>
  <div>
    <VuejsHelloApp> </VuejsHelloApp>
  </div>
</template>

<script>
import VuejsHelloApp from 'vuejs-hello-app'
export default {
  name: 'HelloWorld',
  components: { VuejsHelloApp }
}
</script>

我制作了这个应用程序 https://github.com/samayo/vuejs-hello-app在写答案时,它可能有助于更好地理解代码

关于javascript - 如何在 NPM 上创建和发布 Vuejs 组件,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/47754244/

有关javascript - 如何在 NPM 上创建和发布 Vuejs 组件的更多相关文章

  1. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  2. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  3. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  4. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe? - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗?我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe,无需等待进程完成是否有任何ruby​​gems会支持我的问题? 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  5. ruby - 如何在续集中重新加载表模式? - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  6. ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式? - 2

    我正在为一个项目制作一个简单的shell,我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止,我一直在使用CSV::parse_line,将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"

  7. ruby - 如何在 Lion 上安装 Xcode 4.6,需要用 RVM 升级 ruby - 2

    我实际上是在尝试使用RVM在我的OSX10.7.5上更新ruby,并在输入以下命令后:rvminstallruby我得到了以下回复:Searchingforbinaryrubies,thismighttakesometime.Checkingrequirementsforosx.Installingrequirementsforosx.Updatingsystem.......Errorrunning'requirements_osx_brew_update_systemruby-2.0.0-p247',pleaseread/Users/username/.rvm/log/138121

  8. ruby-on-rails - 如何在 ruby​​ 交互式 shell 中有多行? - 2

    这可能是个愚蠢的问题。但是,我是一个新手......你怎么能在交互式ruby​​shell中有多行代码?好像你只能有一条长线。按回车键运行代码。无论如何我可以在不运行代码的情况下跳到下一行吗?再次抱歉,如果这是一个愚蠢的问题。谢谢。 最佳答案 这是一个例子:2.1.2:053>a=1=>12.1.2:054>b=2=>22.1.2:055>a+b=>32.1.2:056>ifa>b#Thecode‘if..."startsthedefinitionoftheconditionalstatement.2.1.2:057?>puts"f

  9. ruby-on-rails - 如何在我的 Rails 应用程序 View 中打印 ruby​​ 变量的内容? - 2

    我是一个Rails初学者,但我想从我的RailsView(html.haml文件)中查看Ruby变量的内容。我试图在ruby​​中打印出变量(认为它会在终端中出现),但没有得到任何结果。有什么建议吗?我知道Rails调试器,但更喜欢使用inspect来打印我的变量。 最佳答案 您可以在View中使用puts方法将信息输出到服务器控制台。您应该能够在View中的任何位置使用Haml执行以下操作:-puts@my_variable.inspect 关于ruby-on-rails-如何在我的R

  10. ruby - 如何在 Rails 4 中使用表单对象之前的验证回调? - 2

    我有一个服务模型/表及其注册表。在表单中,我几乎拥有服务的所有字段,但我想在验证服务对象之前自动设置其中一些值。示例:--服务Controller#创建Action:defcreate@service=Service.new@service_form=ServiceFormObject.new(@service)@service_form.validate(params[:service_form_object])and@service_form.saverespond_with(@service_form,location:admin_services_path)end在验证@ser

随机推荐