DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

BENSIMON RaphaΓ«l
BENSIMON RaphaΓ«l

Posted on

How create and use github package with VueJS

1. Setup package.json

Add the name of your organization or your github account to your package name

"name": "@myUsername/myPackage"
Enter fullscreen mode Exit fullscreen mode

Define where you're file will be build

"files": [
    "dist/*"
],
Enter fullscreen mode Exit fullscreen mode

Define the repository of your package

"repository": {
    "url": "https://github.com/myUsername/myPackage"
},
Enter fullscreen mode Exit fullscreen mode

Define publishConfig

"publishConfig": {
  "registry":"https://npm.pkg.github.com/@myUsername"
},
Enter fullscreen mode Exit fullscreen mode

Update your version in package.json

"version": "1.4.5" to "version": "1.4.6"
Enter fullscreen mode Exit fullscreen mode

If you want to create a VueJS package, it's recommend to follow this step to build your package :

Add this command in scripts (in package.json) to build your package.

"build-library": "vue-cli-service build --target lib --name @myUsername/mycomponent ./install.js",
Enter fullscreen mode Exit fullscreen mode

Create install.js file into root folder

import myComponent from 'src/components/myComponent.vue
export default {
    install(Vue) {
        Vue.component('MyComponent', myComponent)
    }
}
Enter fullscreen mode Exit fullscreen mode

Then build with this command :

npm run build-library
Enter fullscreen mode Exit fullscreen mode

2. Github action

Push your code to your repo and then go yo your github repository > Action > set up a workflow yourself

App Screenshot

Then paste this code in editor field

name: myPackage

on:
  push:
    branches:
      - main

jobs:
  publish-gpr:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 12
          registry-url: https://npm.pkg.github.com/
          scope: '@myUsername'
      - run: npm install
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
Enter fullscreen mode Exit fullscreen mode

You need to replace scope value with your organization or profile name

This script will will automate the creation/update of your package in github when a commit is pushed on the main branch

Once done, click Start commit, then Commit new file

App Screenshot

3. Generate token access

Click on your github profile and go to settings

App Screenshot

Then scroll to Developer settings and click on it

App Screenshot

Go to Token (classic)

App Screenshot

Click on Generate new token (classic)

App Screenshot

  1. Fill Note
  2. Set No expiration
  3. Allow read:packages

App Screenshot

Click on Generate token (at bottom)

App Screenshot

Copy your token now because you won't be able to see it again !

4. Install your package

Now go to your project and create .npmrc file in root folder, then paste this and replace with your username and your token

@YOUR_USERNAME:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_TOKEN
Enter fullscreen mode Exit fullscreen mode

Now you can install the package just like you would any other NPM package.

npm install @myUsername/myPackage
Enter fullscreen mode Exit fullscreen mode

If you want to install a VueJS package into a VueJS project follow this step :

Import your component into your Vue project
main.js (Vue 3)

import { createApp } from 'vue'
import App from './App.vue'
import myComponent from '@myUsername/myComponent/'

const app = createApp(App)
app.use(myComponent)

app.mount('#app')
Enter fullscreen mode Exit fullscreen mode

main.js (Vue 2)

import Vue from 'vue'
import App from './App.vue'
import myComponent from '@myUsername/myComponent/'

Vue.use(components)

new Vue({
    render : function (h) {
        return h(App)
    }
}).$mount('#app')
Enter fullscreen mode Exit fullscreen mode

Top comments (0)

πŸ‘‹ Hey, my name is Noah and I’m the one who set up this ad. My job is to get you to join DEV, so if you fancy doing me a favor, I’d love for you to create an account.

If you found DEV from searching around, here are a couple of our most popular articles on DEV: