https://github.com/ashblue/upm-package-populator

A node.js build script to populate a nested package in a Unity Package Manager project to a dist folder. Also cross populates root package.json to the UPM package.
https://github.com/ashblue/upm-package-populator

Last synced: 27 days ago
JSON representation

A node.js build script to populate a nested package in a Unity Package Manager project to a dist folder. Also cross populates root package.json to the UPM package.

• Host: GitHub
• URL: https://github.com/ashblue/upm-package-populator
• Owner: ashblue
• Created: 2019-06-02T05:50:21.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-04T03:50:50.000Z (over 1 year ago)
• Last Synced: 2024-10-01T16:26:16.235Z (about 1 month ago)
• Language: TypeScript
• Size: 1.29 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# UPM Package Populator

A helper library to cross populate nested Unity package details such as README.md, CHANGELOG.md, package.json, and more.

## Getting Started

```bash

npm install upm-package-populator

```

Example usage

```javascript

const { populatePackage } = require('upm-package-populator');

populatePackage(

  // The folder to copy files from

  './src',

  

  // Where to overwrite files

  './target',

);

```

## Development

### Making Commits

To make a commit you must use Commitizen. To do so use the following to trigger the commit wizard.

```

npm run commit

```

### Testing The Package Locally

In this package's root run the following to link the package locally to NPM's node module directory.

```bash

npm link

```

Navigate to the root of the project you want to test the package in. Then run this. It will build a link to the local project on your mahcine.

```bash

npm link upm-package-populator

```

It's a good idea to unlink a package when you're done. **Navigate back to this project's root folder** and run the following to unlink. This should clean out any local reference data, which prevents any conflicts with packages.

```bash

npm unlink upm-package-populator

```