crxtool-maven-plugin

Chrome extension tools

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

com.github.mike10004
ArtifactId

ArtifactId

crxtool-maven-plugin
Last Version

Last Version

0.16
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

crxtool-maven-plugin
Chrome extension tools
Project URL

Project URL

http://maven.apache.org

Download crxtool-maven-plugin

How to add to project

<plugin>
    <groupId>com.github.mike10004</groupId>
    <artifactId>crxtool-maven-plugin</artifactId>
    <version>0.16</version>
</plugin>

Dependencies

compile (2)

Group / Artifact Type Version
org.apache.maven : maven-plugin-api jar 3.5.2
com.github.mike10004 : crxtool-core jar 0.16

provided (1)

Group / Artifact Type Version
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.5

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
com.github.mike10004 : crxtool-testing jar 0.16

Project Modules

There are no modules declared in this project.

Travis build status AppVeyor build status Maven Central

crxtool

Library for packing and unpacking Chrome extension .crx files.

Core Library

Maven Coordinates

<dependency>
    <groupId>com.github.mike10004</groupId>
    <artifactId>crxtool-core</artifactId>
    <version>0.15</version>
</dependency>

Usage

Unpacking

try (InputStream in = new FileInputStream("my_extension.crx") {
    CrxMetadata metadata = CrxParser.getDefault().parseMetadata(in);
    System.out.println("id = " + metadata.getId());
    // handle remainder of stream as a zip archive
    try (ZipInputStream zin = new ZipInputStream(in)) {
        // ...
    }
}

Packing

Path extensionDir = new File("manifest-parent-dir").toPath();
java.security.KeyPairGenerator keyGen = java.security.KeyPairGenerator.getInstance("RSA");
java.security.SecureRandom random = new java.security.SecureRandom();
keyGen.initialize(1024, random);
java.security.KeyPair keyPair = keyGen.generateKeyPair();
try (OutputStream out = new FileOutputStream("new_extension.crx")) {
    CrxPacker.getDefault().packExtension(extensionDir, keyPair, out);
}

Maven Plugin

Maven Coordinates

<plugin>
    <groupId>com.github.mike10004</groupId>
    <artifactId>crxtool-maven-plugin</artifactId>
    <version>0.15</version>
</plugin>

Usage

Place extension source files in src/main/extension.

<build>
    <plugins>
        <plugin>
            <groupId>com.github.mike10004</groupId>
            <artifactId>crxtool-maven-plugin</artifactId>
            <version>0.15</version>
            <executions>
                <execution>
                    <id>pack</id>
                    <goals>
                        <goal>pack-extension</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.0.0</version>
            <executions>
                <execution>
                    <id>attach-artifact</id>
                    <goals>
                        <goal>attach-artifact</goal>
                    </goals>
                    <configuration>
                        <artifacts>
                            <artifact>
                                <file>${project.build.directory}/${project.artifactId}-${project.version}.crx</file>
                                <type>crx</type>
                            </artifact>
                        </artifacts>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Credits

The extension ID construction is probably from this Stack Overflow answer. The make-page-red example extension file in the test resources is from developer.chrome.com.

Versions

Version
0.16
0.15
0.14
0.12
0.11
0.10
0.9
0.8
0.7
0.6
0.5