@julian-querido/version-info

What's New in 1.1.2

• 🟢 Full Vite Compatibility: No more missing ./utils or webpack errors in Vite projects. The package now works seamlessly in Vite-based React projects.
• 🧩 Build-System Agnostic: Webpack and Vite are now truly optional peer dependencies. The package auto-detects your build system and only loads what's needed.
• 🛠️ No More Hard Requires: All internal utilities are bundled correctly. No more require errors in ESM environments.
• 📝 Improved Documentation: See below for updated usage and troubleshooting tips.

---

A lightweight, performant version information utility for React/Vite applications. Automatically handles version display across different environments (production, staging, development) with smart version incrementing and configurable formatting.

Features

• 🚀 Lightweight: Zero dependencies, tree-shakeable
• ⚡ Performant: Minimal runtime overhead
• 🔧 Flexible: Works with any build system (Vite, Webpack, etc.)
• 🎯 Smart: Automatically determines version based on environment
• 🎨 Customizable: Configurable display options
• 📱 React Ready: Includes React hooks and components
• 🔒 Type Safe: Full TypeScript support
• 🎉 Zero Config: Works out of the box with automatic detection

Installation

npm install @julian-querido/version-info

Note: This package has no required dependencies. React, Vite, and Webpack are all optional peer dependencies. You only need to install the ones you use in your project.

Quick Start

Zero-Config Usage (Recommended)

The package now works out of the box with automatic detection of package.json and Git information!

import { getVersionInfo, formatVersion } from '@julian-querido/version-info';

// Works immediately - no setup required!
const versionInfo = getVersionInfo();
console.log(versionInfo);
// { version: 'v1.0.1', environment: 'development', commitHash: 'abc123d', ... }

const formattedVersion = formatVersion(versionInfo);
console.log(formattedVersion);
// 'v1.0.1 (development) #abc123d'

Core-Only Usage (No React)

If you don't need React components, use the core-only export:

import { getVersionInfo, formatVersion } from '@julian-querido/version-info/core';

// Same functionality, no React dependency
const versionInfo = getVersionInfo();
console.log(formatVersion(versionInfo));

React Zero-Config Usage

import { useVersionDisplay, VersionDisplay } from '@julian-querido/version-info';

function App() {
  const version = useVersionDisplay(); // Works out of the box!
  
  return (
    <div>
      <p>Version: {version}</p>
      <VersionDisplay className="text-sm text-gray-500" />
    </div>
  );
}

Basic Usage (Legacy)

import { getVersionInfo, formatVersion } from '@julian-querido/version-info';

// Get version information
const versionInfo = getVersionInfo();
console.log(versionInfo);
// { version: 'v1.0.0', environment: 'production', ... }

// Format for display
const display = formatVersion(versionInfo);
console.log(display);
// 'v1.0.0' (production)
// 'v1.0.1 (staging) #abc123d' (staging)

React Usage

import { useVersionDisplay, VersionDisplay } from '@julian-querido/version-info';

function App() {
  const version = useVersionDisplay();
  
  return (
    <div>
      <p>Version: {version}</p>
      <VersionDisplay className="text-sm text-gray-500" />
    </div>
  );
}

Auto-Detection Features

The package now automatically detects:

• Package.json Version: Reads package.json and uses its version as default
• Git Information: Automatically detects commit hash, branch, and tags
• Build System: Detects Vite, Webpack, Rollup, or Parcel configurations
• Environment: Uses NODE_ENV or auto-detects from build context

Auto-Detection Utilities

import { getGitInfo, getPackageInfo, detectBuildSystem } from '@julian-querido/version-info';

// Get Git information
const gitInfo = getGitInfo();
console.log(gitInfo);
// { commitHash: 'abc123def456', shortHash: 'abc123d', branch: 'main', tag: 'v1.0.0' }

// Get package information
const packageInfo = getPackageInfo();
console.log(packageInfo);
// { version: '1.0.0', name: 'my-app' }

// Detect build system
const buildSystem = detectBuildSystem();
console.log(buildSystem); // 'vite', 'webpack', 'rollup', 'parcel', or 'unknown'

Environment Variables

The package automatically reads these environment variables:

Variable	Description	Example
VITE_VERSION	Production version (git tag)	v1.0.0
VITE_PACKAGE_VERSION	Package.json version	1.0.0
VITE_APP_ENV	Environment name	production, staging, development
VITE_COMMIT_HASH	Git commit hash	abc123def456
VITE_BUILD_TIME	Build timestamp	1640995200

Version Logic

Production Environment

• Source: Git tag version (e.g., v1.0.0)
• Display: Clean version only (e.g., v1.0.0)

Non-Production Environments

• Logic:
  • If package.json version differs from production → Show next version
  • If package.json version matches production → Mirror production
• Display: Version + environment + commit hash (e.g., v1.0.1 (staging) #abc123d)

API Reference

Core Functions

getVersionInfo(config?)

Get version information from environment variables and configuration.

import { getVersionInfo } from '@julian-querido/version-info';

const versionInfo = getVersionInfo({
  productionVersion: 'v1.0.0',
  environment: 'staging',
  showEnvironment: true,
});

formatVersion(info, config?)

Format version information for display.

import { formatVersion } from '@julian-querido/version-info';

const display = formatVersion(versionInfo, {
  showEnvironment: true,
  showCommitHash: true,
  showBuildTime: false,
});

incrementVersion(version, type?)

Increment version number by patch, minor, or major.

import { incrementVersion } from '@julian-querido/version-info';

incrementVersion('v1.0.0'); // 'v1.0.1'
incrementVersion('v1.0.0', 'minor'); // 'v1.1.0'
incrementVersion('v1.0.0', 'major'); // 'v2.0.0'

React Hooks

useVersionInfo(config?)

React hook to get version information.

import { useVersionInfo } from '@julian-querido/version-info';

function MyComponent() {
  const versionInfo = useVersionInfo();
  
  return <div>Version: {versionInfo.version}</div>;
}

useVersionDisplay(config?)

React hook to get formatted version string.

import { useVersionDisplay } from '@julian-querido/version-info';

function MyComponent() {
  const version = useVersionDisplay();
  
  return <div>Version: {version}</div>;
}

React Components

VersionDisplay

React component to display version information.

import { VersionDisplay } from '@julian-querido/version-info';

function MyComponent() {
  return (
    <VersionDisplay 
      className="text-sm text-gray-500"
      showEnvironment={true}
      showCommitHash={true}
    />
  );
}

Configuration Options

VersionConfig

interface VersionConfig {
  productionVersion?: string;    // Override production version
  packageVersion?: string;       // Override package version
  environment?: string;          // Override environment
  commitHash?: string;           // Override commit hash
  buildTime?: string;            // Override build time
  showEnvironment?: boolean;     // Show environment in display
  showCommitHash?: boolean;      // Show commit hash in display
  showBuildTime?: boolean;       // Show build time in display
  showBranch?: boolean;          // Show branch in display
  showTag?: boolean;             // Show tag in display
}

Build System Integration

Zero-Config Plugins (Recommended)

Vite Plugin

// vite.config.ts
import { defineConfig } from 'vite';
import { versionInfoPlugin } from '@julian-querido/version-info/vite';

export default defineConfig({
  plugins: [
    // Zero-config plugin - automatically sets up all environment variables
    versionInfoPlugin(),
    // Or with custom options
    // versionInfoPlugin({
    //   environment: 'staging',
    //   includeGitInfo: true,
    //   includeBuildTime: true,
    // }),
  ],
  // No manual environment variable setup needed!
});

Note: The Vite plugin works out of the box. You do NOT need webpack or any webpack dependencies in a Vite project.

Webpack Plugin (Optional)

// webpack.config.js
const { VersionInfoWebpackPlugin } = require('@julian-querido/version-info/webpack');

module.exports = {
  plugins: [
    // Zero-config plugin - automatically sets up all environment variables
    new VersionInfoWebpackPlugin(),
    // Or with custom options
    // new VersionInfoWebpackPlugin({
    //   environment: 'staging',
    //   includeGitInfo: true,
    //   includeBuildTime: true,
    // }),
  ],
  // No manual environment variable setup needed!
};

Note: The Webpack plugin requires webpack to be installed as a dependency in your project. If webpack is not available, the plugin will throw a helpful error message. You do NOT need webpack for Vite or other build systems.

Manual Configuration (Legacy)

Vite

// vite.config.ts
export default defineConfig({
  define: {
    'import.meta.env.VITE_VERSION': JSON.stringify(process.env.npm_package_version),
    'import.meta.env.VITE_APP_ENV': JSON.stringify(process.env.NODE_ENV),
    'import.meta.env.VITE_COMMIT_HASH': JSON.stringify(process.env.GITHUB_SHA),
    'import.meta.env.VITE_BUILD_TIME': JSON.stringify(Date.now()),
  },
});

Webpack

// webpack.config.js
const webpack = require('webpack');

module.exports = {
  plugins: [
    new webpack.DefinePlugin({
      'process.env.VITE_VERSION': JSON.stringify(process.env.npm_package_version),
      'process.env.VITE_APP_ENV': JSON.stringify(process.env.NODE_ENV),
      'process.env.VITE_COMMIT_HASH': JSON.stringify(process.env.GITHUB_SHA),
      'process.env.VITE_BUILD_TIME': JSON.stringify(Date.now()),
    }),
  ],
};

Examples

Basic Footer Component

import { VersionDisplay } from '@julian-querido/version-info';

function Footer() {
  return (
    <footer>
      <p>&copy; 2024 My App</p>
      <VersionDisplay className="text-xs text-gray-400" />
    </footer>
  );
}

Custom Version Display

import { useVersionInfo, formatVersion } from '@julian-querido/version-info';

function CustomVersion() {
  const versionInfo = useVersionInfo();
  
  const customDisplay = formatVersion(versionInfo, {
    showEnvironment: false,
    showCommitHash: true,
    showBuildTime: true,
  });
  
  return <span className="version">{customDisplay}</span>;
}

Environment-Specific Styling

import { useVersionInfo } from '@julian-querido/version-info';

function EnvironmentBadge() {
  const { environment, version } = useVersionInfo();
  
  const getBadgeColor = () => {
    switch (environment) {
      case 'production': return 'bg-green-100 text-green-800';
      case 'staging': return 'bg-yellow-100 text-yellow-800';
      case 'development': return 'bg-blue-100 text-blue-800';
      default: return 'bg-gray-100 text-gray-800';
    }
  };
  
  return (
    <span className={`px-2 py-1 rounded text-xs ${getBadgeColor()}`}>
      {environment} - {version}
    </span>
  );
}

Troubleshooting

Common Issues

Git Information Not Available

If Git information is not being detected:

• Ensure you're in a Git repository
• Check that Git is installed and accessible
• The package will gracefully fall back to empty values

Package.json Not Found

If package.json is not being read:

• Ensure you're running from the project root directory
• Check that package.json exists and is valid JSON
• The package will fall back to version '0.0.0'

Build System Not Detected

If your build system is not detected:

• Check that your config file exists (vite.config.js, webpack.config.js, etc.)
• The package will work with manual configuration as fallback

Environment Variables Not Set

If environment variables are not being set by plugins:

• Ensure the plugin is properly imported and added to your config
• Check that the plugin is listed before other plugins that might override values
• Verify your build system is supported (Vite, Webpack, Rollup, Parcel)

Webpack Plugin Errors in Vite Projects

• The webpack plugin is optional and only needed for webpack projects.
• Vite users: Use the Vite plugin: import { versionInfoPlugin } from '@julian-querido/version-info/vite'.
• Or use the core functionality without plugins: import { getVersionInfo } from '@julian-querido/version-info/core'.
• You do not need webpack or any webpack dependencies in a Vite project.

React Dependencies in Non-React Projects

If you get React-related errors in a non-React project:

• Use the core-only export: import { getVersionInfo } from '@julian-querido/version-info/core'
• This provides all functionality without React dependencies

Manual Override Options

If auto-detection doesn't work for your use case, you can always override values:

const versionInfo = getVersionInfo({
  productionVersion: 'v2.0.0',
  environment: 'staging',
  commitHash: 'custom-hash',
  showEnvironment: true,
  showCommitHash: true,
});

Migration from Existing Version System

If you're migrating from your existing version system:

1. Install the package:

   npm install @julian-querido/version-info

2. Replace imports:

   // Old
   import { getVersionInfo, formatVersion } from '../utils/version';
   
   // New
   import { getVersionInfo, formatVersion } from '@julian-querido/version-info';

3. Update React components:

   // Old
   const versionInfo = getVersionInfo();
   const versionDisplay = formatVersion(versionInfo);
   
   // New
   const version = useVersionDisplay();
   // or
   <VersionDisplay />

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

License

MIT License - see LICENSE file for details.