Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.71 KB

README.md

File metadata and controls

62 lines (39 loc) · 2.71 KB
Raw

eos-icons-adobe-xd

An Adobe XD plugin to use all of EOS-icons from within the application

build-run License: MIT codecov

Guidelines to run the Plugin Locally

Below are the steps to get your plugin running

The plugin uses NPM in creating JavaScript applications.

First, download Node.js which comes with NPM. This will allow you to various libraries. You can find the download link here:

https://nodejs.org/en/download/

  • Clone the repo in the folder of your choice.
  • Run npm i and npm run watch.
  • Install Adobe UXP Developer Tool .
  • Open Adobe XD and open a document.
  • Open UXP Developer Tool.
  • Click Add Existing Plugin.
  • Add the manifest.json from the dist folder.
  • Click on 3 dot icon and select Load.
  • Go back to Adobe XD and try it out! :)

Keeping up with the Test Files

To make sure the test files are working correctly after the latest changes, run the following command: npm test

Check Linting Errors

Run the following command to check if there are any linting errors: npm run lint or npx eslint .

JS and CSS Quality Assurance

Before submitting a PR/MR make sure your code is compliant with our JS and CSS rules by running: npm run checkFormat and npx prettier --check .

If you encounter any deploy error in JS try fixing it by running npx prettier --write .

FAQs

  1. Some icons get distorted. Is it the plugin fault?

Ans. No, follow this and this. Workaround: Toggle Responsive Resize before resizing those icons.

If it doesn't help, then:

  • Delete it.
  • Paste again.
  • Switch off Responsive Resize.
  • Resize now.

Semantic Release

Semantic Release helps in automating the whole package release workflow. semantic-release uses the commit messages to determine the consumer impact of changes in the codebase.

To commit a release follow the link: https://github.com/EOS-uiux-Solutions/wiki/blob/main/Semantic-Releases.md