Add support for global installation #74
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
moodmosaic
reviewed
Dec 20, 2024
There was a problem hiding this comment.
Just a small nit in #74 (comment) 🙌
Have you tried on Linux and Windows or just macOS? (We will have to setup some CI checks soon.)
The current approach was tested on The last remaining item in this PR is to update the README before merging. |
|
/cc @friedger |
Closed
moodmosaic
reviewed
Dec 23, 2024
There was a problem hiding this comment.
Merge after CI setup in #75 or another round of manual checks.
This commit updates `tsconfig.json`` to ensure build files are emitted into the `dist` folder. This change supports the npm publishing process by placing the compiled files in a location suitable for distribution. Additionally, it helps with global installations by mapping the bin to the `./dist/app.js` path. To resolve the correct version from `package.json`, the `resolveJsonModule` option has been added to the `tsconfig.json`. Additionally, the `dist` folder has been added to the `.gitignore`.
This commit introduces a Node.js shebang (#!/usr/bin/env node) to ensure the app.ts script is executable as a CLI tool. Additionally, the package.json is updated to declare dist/app.js as the entry point for the rv CLI tool, providing support for custom installation and global execution.
BowTiedRadone
force-pushed
the
fix/global-installation
branch
from
3758c94 to
2d164fb
Compare
BowTiedRadone
force-pushed
the
fix/global-installation
branch
from
b61a743 to
677d20a
Compare
BowTiedRadone
force-pushed
the
fix/global-installation
branch
from
7a3ecf2 to
97971ee
Compare
BowTiedRadone
force-pushed
the
fix/global-installation
branch
from
6a1caba to
1a94bfe
Compare
The tests should not be included in the build, as takes care of them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR supports global installation using
npm--globalflag. Thervexecutable is now accessible globally, allowing users to run it from anywhere on their system.Key updates:
package.jsonso that thervcommand points to the builtapp.jsin thedistdirectory.rvscript since theapp.jscan now be run directly globally.