next-go-modules

Features

Installation

# npm
npm install next-go-modules
# yarn
yarn add next-go-modules
# pnpm
pnpm add next-go-modules

Quick Start

Option 1: Using CLI Tool (Recommended)

# Auto-generate all necessary files
npx next-go-modules init
# Or if installed globally
next-go-modules init

Note

If your project already has a middleware.ts file, the CLI tool will provide integration guidance instead of overwriting the existing file.

Option 2: Manual Setup

1. Create your modules configuration

// config/go-modules.ts
import { GoModulesConfig } from 'next-go-modules'
export const goModulesConfig: GoModulesConfig = {
 modules: {
 'my-go-tool': {
 name: 'my-go-tool',
 fullName: 'yourdomain.com/my-go-tool',
 repo: 'https://github.com/yourusername/my-go-tool',
 description: 'Your Go tool description',
 install: 'go get -u yourdomain.com/my-go-tool',
 version: 'v1.0.0',
 aliases: ['tool'], // Optional aliases
 },
 // Add more modules here...
 },
}

2. Create your middleware

// src/middleware.ts (if using src directory) or middleware.ts (project root)
import { createGoModulesMiddleware } from 'next-go-modules'
import { goModulesConfig } from './config/go-modules'
const goModulesMiddleware = createGoModulesMiddleware({
 config: goModulesConfig,
 debug: process.env.NODE_ENV === 'development',
})
export default function middleware(request: any) {
 return goModulesMiddleware(request)
}
export const config = {
 matcher: [
 '/((?!api|_next/static|_next/image|favicon.ico|manifest.webmanifest|sitemap.xml).*)',
 ],
}

3. Create your API route

// app/api/go-modules/[...module]/route.ts (App Router)
import { createGoModulesApiRoute, createGoModulesHeadRoute } from 'next-go-modules'
import { goModulesConfig } from '../../../../config/go-modules'
export const GET = createGoModulesApiRoute(goModulesConfig)
export const HEAD = createGoModulesHeadRoute(goModulesConfig)

// pages/api/go-modules/[...module].ts (Pages Router)
import { createGoModulesApiRoute } from 'next-go-modules'
import { goModulesConfig } from '../../../config/go-modules'
export default createGoModulesApiRoute(goModulesConfig)

Usage

go get -u yourdomain.com/my-go-tool

Configuration Options

GoModule

interface GoModule {
 name: string // Module name
 fullName: string // Full module path (e.g., 'example.com/module')
 repo: string // Repository URL
 description: string // Module description
 install: string // Installation command
 tags?: string[] // Optional tags
 version?: string // Optional version
 aliases?: string[] // Optional aliases
}

GoModulesConfig

interface GoModulesConfig {
 modules: Record<string, GoModule>
 apiRoute?: string // Default: '/api/go-modules'
 matcher?: string[] // Default: excludes static files
 cacheControl?: string // Default: 'public, max-age=3600'
}

MiddlewareOptions

interface MiddlewareOptions {
 config: GoModulesConfig
 debug?: boolean // Enable debug logging
}

Advanced Usage

Custom API Route

const config: GoModulesConfig = {
 modules: { /* your modules */ },
 apiRoute: '/api/custom-go-modules',
}

Custom Cache Control

const config: GoModulesConfig = {
 modules: { /* your modules */ },
 cacheControl: 'public, max-age=7200', // 2 hours
}

Custom Matcher

const config: GoModulesConfig = {
 modules: { /* your modules */ },
 matcher: [
 '/((?!api|_next|favicon.ico).*)',
 ],
}

Debug Mode

const middleware = createGoModulesMiddleware({
 config: goModulesConfig,
 debug: true, // Enable console logging
})

Integration with Existing Middleware

// middleware.ts
import { composeMiddleware, createGoModulesMiddleware } from 'next-go-modules'
import { goModulesConfig } from './config/go-modules'
// Your existing middleware
function yourExistingMiddleware(request) {
 // Your logic
}
// Go modules middleware
const goModulesMiddleware = createGoModulesMiddleware({
 config: goModulesConfig,
 debug: process.env.NODE_ENV === 'development',
})
// Compose middlewares
export default composeMiddleware(
 goModulesMiddleware,
 yourExistingMiddleware
)

API Reference

Core Functions

Middleware Functions

API Route Functions

Examples

Multiple Modules with Aliases

const config: GoModulesConfig = {
 modules: {
 'go-masker': {
 name: 'go-masker',
 fullName: 'normalcoder.com/go-masker',
 repo: 'https://github.com/normal-coder/go-masker',
 description: 'Data masking tool',
 install: 'go get -u normalcoder.com/go-masker',
 aliases: ['masker', 'data-masker'],
 },
 'go-validator': {
 name: 'go-validator',
 fullName: 'normalcoder.com/go-validator',
 repo: 'https://github.com/normal-coder/go-validator',
 description: 'Data validation tool',
 install: 'go get -u normalcoder.com/go-validator',
 aliases: ['validator', 'validate'],
 },
 },
}

Deployment

Vercel

Other Platforms

Development

Development Setup

# Clone repository
git clone https://github.com/normal-coder/next-go-modules.git
cd next-go-modules
# Install dependencies
pnpm install
# Development mode
pnpm dev
# Lint code
pnpm lint
# Build
pnpm build

Commit Convention

# Use commitizen for interactive commits
pnpm commit
# Or manually follow the format
git commit -m "feat: add new feature"
git commit -m "fix: resolve issue"
git commit -m "docs: update readme"

Version Management

# Add changeset
pnpm changeset
# Version packages
pnpm version
# Release to npm
pnpm release

Contributing

Acknowledgments

License