java-package-info

tis-abe-akira's avatarfrom tis-abe-akira

Generate package-info.java files for Java packages. Use when the user requests to add package documentation files to Java packages, create package-info.java files, or document Java package structures. Automatically scans directories for Java packages and creates Javadoc package documentation files where they don't exist.

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 23, 2025⬇️1downloads
[Code Generation]

When & Why to Use This Skill

This Claude skill automates the generation of package-info.java files for Java projects, ensuring consistent Javadoc documentation across all packages. It recursively scans source directories to identify missing documentation files and creates them with proper package declarations and boilerplate Javadoc, significantly improving code quality and project maintainability.

Use Cases

  • Standardizing Documentation: Automatically generate package-info.java files across large-scale Java projects to ensure 100% Javadoc compliance.
  • Legacy Code Maintenance: Quickly add missing package-level documentation to older codebases to improve readability for new maintainers.
  • Project Scaffolding: Use during the initial setup of a Java project to establish a professional documentation structure from the first commit.
  • CI/CD Quality Gates: Integrate into development workflows to identify or fix missing package documentation before code reviews or releases.
  • Batch Processing: Efficiently document deeply nested package structures that would be tedious and error-prone to handle manually.
namejava-package-info
descriptionGenerate package-info.java files for Java packages. Use when the user requests to add package documentation files to Java packages, create package-info.java files, or document Java package structures. Automatically scans directories for Java packages and creates Javadoc package documentation files where they don't exist.

Java Package Info Generator

Generate package-info.java files for Java packages with Javadoc comments.

Quick Start

Generate package-info.java files for a Java project:

python3 scripts/generate_package_info.py <project-directory>

Usage

Basic Usage

Generate package-info.java for all Java packages:

python3 scripts/generate_package_info.py /path/to/project

Filter by Base Package

Generate only for packages under a specific base package:

python3 scripts/generate_package_info.py /path/to/project --base-package com.example.myapp

Preview Changes (Dry Run)

See what would be created without actually creating files:

python3 scripts/generate_package_info.py /path/to/project --dry-run

Overwrite Existing Files

Force overwrite existing package-info.java files:

python3 scripts/generate_package_info.py /path/to/project --force

Custom Source Root

Specify a different source root directory:

python3 scripts/generate_package_info.py /path/to/project --src-root src/java

Generated Content

Each package-info.java file contains:

  • Package declaration: Proper package statement
  • Javadoc comment: Automatically generated description based on package name
  • UTF-8 encoding: Standard Java file encoding

Example generated file for package com.example.myapp.service:

/**
 * Serviceパッケージ
 *
 * <p>このパッケージはServiceに関連する機能を提供します。</p>
 */
package com.example.myapp.service;

Behavior

  • Scans recursively: Finds all directories containing .java files
  • Skips existing files: By default, does not overwrite existing package-info.java
  • Ignores build directories: Automatically skips target/, build/, out/
  • Handles nested packages: Creates files for all package levels

Common Use Cases

  1. New project setup: Add package documentation to a new Java project
  2. Javadoc compliance: Ensure all packages have documentation
  3. Code quality: Improve project documentation coverage
  4. Batch processing: Document multiple packages at once