create-desktop-shortcuts

Easy API to create desktop shortcuts with Node

Showing:

9 Versions

1.5.0

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Bug Fixes:
  • Previously if no value was set for a comment on Windows, it would default to the output file's name (without extension). This was not needed, as it is perfectly fine for this field to be an empty string. This has been corrected. Now if you do not set a comment on Windows, there won't be one.
Enhancements:
  • You can now set your filePath to be equal to an executable name directly if it is available in the user's PATH. For example, if you set it to 'node' or 'python' or 'cmd' and the user can access those from PATH variables, it will work automatically. You no longer need to hard code the full file path, which is useful since those paths may vary depending on system.

Special thanks to @andy-chili-wang for bringing this to my attention, and @sysrage for the advice on implementation (#39).

Maintenance: Code Quality:
  • Refactored E2E tests
  • Linting and Test coverage remains at 100%
  • E2E tests all passing
Code Changes

1.4.0

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Enhancements:
  • You can now pass in arguments with your Linux shortcut, just like you can with Windows (to my knowledge this is not possible with OSX)

Special thanks to @unmellow for bringing this to my attention (#30).

Maintenance:
  • Updated dependencies
  • Updated documentation
Code Quality:
  • Linting and Test coverage remains at 100%
  • E2E tests all passing
Code Changes

1.3.0

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Enhancements:
  • Runs in Node 4.0.0+
  • Tested on Windows XP
  • Better documented Node and OS support
  • Improved linting enforcement for JSDocs
  • All methods and functions are documented now via JSDoc blocks

Special thanks to @shun634501730 for bringing this to my attention (#26).

Maintenance:
  • Updated dependencies
  • Updated documentation
Code Quality:
  • Linting and Test coverage remains at 100%
  • E2E tests all passing
Code Changes

1.2.1

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Enhancements:
  • Documented how to add a shortcut to the start menu in Windows and Linux (in README.md)

Special thanks to @fp07 for bringing this to my attention (#24).

Maintenance:
  • Updated dependencies
  • Updated documentation
  • Improved E2E testing locally
  • Added stricter linting rules for JSDocs and improved existing JSDoc blocks
Code Quality:
  • Linting and Test coverage remains at 100%
  • E2E tests all passing
Code Changes

1.2.0

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Enhancements:
  • Added a new API option for Windows called workingDirectory. It lets you set the "current working directory" for the shortcut application when launched. This feature should have been included in the library earlier but was overlooked.

Special thanks to @Tixxxon for bringing this to my attention (#21).

Maintenance:
  • Updated dependencies
  • Updated documentation
Code Quality:
  • Linting and Test coverage remains at 100%
  • E2E tests all passing
Code Changes

1.1.0

Breaking Changes:
  • NONE! Your code should work exactly the same without changing anything.
Enhancements:
  • Improve Linux "type" defaulting
    • Defaults to "Link" if filePath starts with 'https://' or 'http://'
    • Defaults to "Directory" if filePath exists and is a folder
    • Defaults to "Application" otherwise
  • Set up Jest for unit tess.
  • Achieve 100% test coverage
  • End-to-End (E2E) test coverage set up to automate testing the creation of an actual shortcut on each OS.
  • Log error if the windows.vbs file cannot be found for some reason, rather than popping up a WSCRIPT alert dialogue box
  • Added "No Ideologies" Code of Conduct
  • Resolve all open issues
  • Improve logic for validating passed in options before execution in many locations.
Maintenance:
  • 3,727 lines of code changed since last version
  • update dependencies
  • Switch from Travis-CI to GitHub Actions
  • Enforce CI passing and up-to-date branches before merging to master
    • Linting
    • Unit Tests
    • End-to-End testing
    • On Latest Windows, OSX, and Ubuntu
  • Improved the .editorconfig settings
  • Updated README.md
Code Quality:
  • Split out code into files, rather than just using one really long file
  • Improve some code documentation (more descriptive variable names, links to online docs)
  • Improve linting
Code Changes

1.0.2

  • Fixed a bug where you would get a console error if you didn't pass in a customLogger

1.0.1

  • Cleaned up the docs to be more accurate and fix some typos

1.0.0

  • Supports Windows, Linux, OSX
  • Has comprehensive validation
  • Human readable error messages
  • Synchronous only
  • Works in Node.js and NW.js
  • Fully documented