kushkapadia / kushkapadia/servitect

Convert `servitect` Global Package to Local Package

Open
#33 1 comment 0 reactions 1 assignee Claimed by @kushkapadia View on GitHub
wontfix
Dominant language
JavaScript
Stars
46
Forks
4
PR merge metrics
No merged PRs in 30d

Description

**Description:**

As per recent npm guidelines, the use of global packages is being discouraged due to potential conflicts, easier management, and installation issues. Currently, the `servitect` package is being used globally, but to align with best practices and ensure better compatibility, we need to convert the `servitect` package from a global package to a local one.

**Task Breakdown:**

- **Remove Global Dependency:**
- Ensure that `servitect` is no longer installed or executed globally. This involves removing it from global installations using `npm uninstall -g servitect`.

- **Update Documentation:**
- Update the documentation to guide users on how to install and use `servitect` locally. This should include installation instructions via `npm install servitect` and how to use it with `npx` or through local scripts.

- **Modify Project Setup:**
- Make necessary changes in the code to ensure the package works as a local dependency rather than requiring global access. This includes checking any `bin` files or commands that are currently set up for global usage and updating them accordingly.

- **Ensure Backward Compatibility:**
- Ensure that the transition does not break existing setups or workflows. Users should be able to use the package seamlessly after the change, both in new and existing projects.

- **Update `package.json`:**
- Add `servitect` as a local dependency in the `package.json` file, ensuring it’s listed in `dependencies` or `devDependencies`.

**Expected Outcome:**

The `servitect` package should be fully converted to a local dependency, and all usage instructions should be updated. This will align with npm’s new guidelines and provide a more scalable, maintainable approach for developers.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.