How to share code between node.js apps?

Sharing code between Node.js applications is a common practice that helps developers reuse code, reduce redundancy, and improve application maintainability. Here are several common methods for sharing code between Node.js applications:

1. Creating Reusable Modules

The most standard and widely used method is to encapsulate shared code into modules and publish them to package managers such as npm or Yarn. This way, any project requiring these features can easily install the modules using npm install your-module-name.

Example:

Suppose you develop a custom library for string processing; you can create an npm package and use it in other projects.

javascript
// string-utils.js
module.exports.capitalize = function (str) {
    return str.charAt(0).toUpperCase() + str.slice(1);
};

// After publishing to npm, use it in other projects
const stringUtils = require('string-utils');
console.log(stringUtils.capitalize('hello'));  // Outputs 'Hello'

2. Using Git Submodules

If your code is stored in a Git repository, another method to share code is using Git submodules. Git submodules allow you to include one Git repository as a subdirectory of another Git repository. This approach is suitable for large projects or private projects that cannot be published as npm packages.

Example:

You can add a public UI component library as a submodule to multiple frontend projects.

bash
git submodule add https://github.com/yourusername/your-library.git path/to/submodule
git submodule update --init --recursive

3. Using Private Repositories or Scopes with Package Managers

For enterprise applications, you may need to share code internally without making it public. Npm and Yarn both support setting up private repositories or using scopes to manage private packages.

Example:

Set up a private scope with Npm.

bash
npm login --registry=https://your-private-registry.example.com
npm publish --access restricted

4. Using Environment Variables or Configuration Files

Although this is not a direct method for sharing code, sharing configuration information such as database settings or API keys via environment variables or external configuration files is also important.

Example:

Use the dotenv library to load environment variables and share .env files across projects.

javascript
// In your project
require('dotenv').config();

const dbConfig = {
    host: process.env.DB_HOST,
    user: process.env.DB_USER,
    password: process.env.DB_PASSWORD
};

Conclusion

The choice of method depends on specific requirements, project size, and the need for code privacy. Typically, for most open-source projects, creating npm modules is the most straightforward and standard approach. For confidential internal enterprise projects, using private npm repositories or Git submodules may be more appropriate.