ttyper icon indicating copy to clipboard operation
ttyper copied to clipboard

feat: npm install -g ttyper

Open Anush008 opened this issue 2 years ago • 3 comments

This PR intends to add npm install -g ttyper as an installation strategy for Ttyper. Since NPM is the most used package manager, this would be a valuable addition to the project.

https://www.npmjs.com/package/ttyper

Here's how this works:

When npm install is run, NPM executes the install script, i.e. install.js.

The install.js file:

  • Downloads the appropriate binary from GitHub releases and moves it to the bin directory.
  • Removes the node_modules with the tar and zip libraries, as they are not needed any further.
  • NPM symlinks the package name ttyper, to whatever is set as the bin value in the package.json.
  • We configure bin to run runner.js, which handles the running of our downloaded binary.

The added npm-release Action job:

  • Bumps the version number value in the package.json to be in parity with the release version.
  • Copies the README.md from the root dir to be displayed on the package's homepage.
  • Publishes the package to NPM.

We can commit the version bump if we need to, but that would be an extra commit.

A successful run of this workflow can be found here.

@max-niederman, I'll move the NPM package to you and you can configure the NPM_ACCESS_TOKEN secret for this repository.

Anush008 avatar Nov 05 '23 18:11 Anush008

Hey @max-niederman, could you please review when you're available? Thanks.

Anush008 avatar Jan 21 '24 10:01 Anush008

Hi @max-niederman. Welcome back. I'll take a look.

Anush008 avatar Feb 02 '24 06:02 Anush008

Hi @max-niederman. Could you try npm install -g ttyper and ttyper on your device now?

Anush008 avatar Mar 04 '24 04:03 Anush008